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

   1 .. -*- coding: utf-8; mode: rst -*-
   2
   3 .. _VIDEO_GET_PTS:
   4
   5 =============
   6 VIDEO_GET_PTS
   7 =============
   8
   9 Name
  10 ----
  11
  12 VIDEO_GET_PTS
  13
  14 .. attention:: This ioctl is deprecated.
  15
  16 Synopsis
  17 --------
  18
  19 .. c:function:: int ioctl(int fd, VIDEO_GET_PTS, __u64 *pts)
  20     :name: VIDEO_GET_PTS
  21
  22
  23 Arguments
  24 ---------
  25
  26 .. flat-table::
  27     :header-rows:  0
  28     :stub-columns: 0
  29
  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
  55 Description
  56 -----------
  57
  58 This ioctl is obsolete. Do not use in new drivers. For V4L2 decoders
  59 this ioctl has been replaced by the ``V4L2_CID_MPEG_VIDEO_DEC_PTS``
  60 control.
  61
  62 This ioctl call asks the Video Device to return the current PTS
  63 timestamp.
  64
  65
  66 Return Value
  67 ------------
  68
  69 On success 0 is returned, on error -1 and the ``errno`` variable is set
  70 appropriately. The generic error codes are described at the
  71 :ref:`Generic Error Codes <gen-errors>` chapter.