Documentation/userspace-api/media/dvb/video-get-pts.rst

   1 .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
   2 .. c:namespace:: DTV.video
   3
   4 .. _VIDEO_GET_PTS:
   5
   6 =============
   7 VIDEO_GET_PTS
   8 =============
   9
  10 Name
  11 ----
  12
  13 VIDEO_GET_PTS
  14
  15 .. attention:: This ioctl is deprecated.
  16
  17 Synopsis
  18 --------
  19
  20 .. c:macro:: VIDEO_GET_PTS
  21
  22 ``int ioctl(int fd, VIDEO_GET_PTS, __u64 *pts)``
  23
  24 Arguments
  25 ---------
  26
  27 .. flat-table::
  28     :header-rows:  0
  29     :stub-columns: 0
  30
  31     -  .. row 1
  32
  33        -  int fd
  34
  35        -  File descriptor returned by a previous call to open().
  36
  37     -  .. row 2
  38
  39        -  int request
  40
  41        -  Equals VIDEO_GET_PTS for this command.
  42
  43     -  .. row 3
  44
  45        -  __u64 \*pts
  46
  47        -  Returns the 33-bit timestamp as defined in ITU T-REC-H.222.0 /
  48           ISO/IEC 13818-1.
  49
  50           The PTS should belong to the currently played frame if possible,
  51           but may also be a value close to it like the PTS of the last
  52           decoded frame or the last PTS extracted by the PES parser.
  53
  54 Description
  55 -----------
  56
  57 This ioctl is obsolete. Do not use in new drivers. For V4L2 decoders
  58 this ioctl has been replaced by the ``V4L2_CID_MPEG_VIDEO_DEC_PTS``
  59 control.
  60
  61 This ioctl call asks the Video Device to return the current PTS
  62 timestamp.
  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.