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

   1 .. Permission is granted to copy, distribute and/or modify this
   2 .. document under the terms of the GNU Free Documentation License,
   3 .. Version 1.1 or any later version published by the Free Software
   4 .. Foundation, with no Invariant Sections, no Front-Cover Texts
   5 .. and no Back-Cover Texts. A copy of the license is included at
   6 .. Documentation/media/uapi/fdl-appendix.rst.
   7 ..
   8 .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections
   9
  10 .. _VIDEO_GET_PTS:
  11
  12 =============
  13 VIDEO_GET_PTS
  14 =============
  15
  16 Name
  17 ----
  18
  19 VIDEO_GET_PTS
  20
  21 .. attention:: This ioctl is deprecated.
  22
  23 Synopsis
  24 --------
  25
  26 .. c:function:: int ioctl(int fd, VIDEO_GET_PTS, __u64 *pts)
  27     :name: VIDEO_GET_PTS
  28
  29
  30 Arguments
  31 ---------
  32
  33 .. flat-table::
  34     :header-rows:  0
  35     :stub-columns: 0
  36
  37
  38     -  .. row 1
  39
  40        -  int fd
  41
  42        -  File descriptor returned by a previous call to open().
  43
  44     -  .. row 2
  45
  46        -  int request
  47
  48        -  Equals VIDEO_GET_PTS for this command.
  49
  50     -  .. row 3
  51
  52        -  __u64 \*pts
  53
  54        -  Returns the 33-bit timestamp as defined in ITU T-REC-H.222.0 /
  55           ISO/IEC 13818-1.
  56
  57           The PTS should belong to the currently played frame if possible,
  58           but may also be a value close to it like the PTS of the last
  59           decoded frame or the last PTS extracted by the PES parser.
  60
  61
  62 Description
  63 -----------
  64
  65 This ioctl is obsolete. Do not use in new drivers. For V4L2 decoders
  66 this ioctl has been replaced by the ``V4L2_CID_MPEG_VIDEO_DEC_PTS``
  67 control.
  68
  69 This ioctl call asks the Video Device to return the current PTS
  70 timestamp.
  71
  72
  73 Return Value
  74 ------------
  75
  76 On success 0 is returned, on error -1 and the ``errno`` variable is set
  77 appropriately. The generic error codes are described at the
  78 :ref:`Generic Error Codes <gen-errors>` chapter.