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