Documentation/media/uapi/dvb/audio-get-pts.rst

   1 .. -*- coding: utf-8; mode: rst -*-
   2
   3 .. _AUDIO_GET_PTS:
   4
   5 =============
   6 AUDIO_GET_PTS
   7 =============
   8
   9 Name
  10 ----
  11
  12 AUDIO_GET_PTS
  13
  14
  15 Synopsis
  16 --------
  17
  18 .. cpp:function:: int ioctl(int fd, int request = AUDIO_GET_PTS, __u64 *pts)
  19
  20
  21 Arguments
  22 ---------
  23
  24 .. flat-table::
  25     :header-rows:  0
  26     :stub-columns: 0
  27
  28
  29     -  .. row 1
  30
  31        -  int fd
  32
  33        -  File descriptor returned by a previous call to open().
  34
  35     -  .. row 2
  36
  37        -  int request
  38
  39        -  Equals AUDIO_GET_PTS for this command.
  40
  41     -  .. row 3
  42
  43        -  __u64 \*pts
  44
  45        -  Returns the 33-bit timestamp as defined in ITU T-REC-H.222.0 /
  46           ISO/IEC 13818-1.
  47
  48           The PTS should belong to the currently played frame if possible,
  49           but may also be a value close to it like the PTS of the last
  50           decoded frame or the last PTS extracted by the PES parser.
  51
  52
  53 Description
  54 -----------
  55
  56 This ioctl is obsolete. Do not use in new drivers. If you need this
  57 functionality, then please contact the linux-media mailing list
  58 (`https://linuxtv.org/lists.php <https://linuxtv.org/lists.php>`__).
  59
  60 This ioctl call asks the Audio Device to return the current PTS
  61 timestamp.
  62
  63
  64 Return Value
  65 ------------
  66
  67 On success 0 is returned, on error -1 and the ``errno`` variable is set
  68 appropriately. The generic error codes are described at the
  69 :ref:`Generic Error Codes <gen-errors>` chapter.