Documentation/media/uapi/dvb/dmx-get-stc.rst

   1 .. -*- coding: utf-8; mode: rst -*-
   2
   3 .. _DMX_GET_STC:
   4
   5 ===========
   6 DMX_GET_STC
   7 ===========
   8
   9 Name
  10 ----
  11
  12 DMX_GET_STC
  13
  14
  15 Synopsis
  16 --------
  17
  18 .. cpp:function:: int ioctl( int fd, int request = DMX_GET_STC, struct dmx_stc *stc)
  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 DMX_GET_STC for this command.
  40
  41     -  .. row 3
  42
  43        -  struct dmx_stc \*stc
  44
  45        -  Pointer to the location where the stc is to be stored.
  46
  47
  48 Description
  49 -----------
  50
  51 This ioctl call returns the current value of the system time counter
  52 (which is driven by a PES filter of type DMX_PES_PCR). Some hardware
  53 supports more than one STC, so you must specify which one by setting the
  54 num field of stc before the ioctl (range 0...n). The result is returned
  55 in form of a ratio with a 64 bit numerator and a 32 bit denominator, so
  56 the real 90kHz STC value is stc->stc / stc->base .
  57
  58
  59 Return Value
  60 ------------
  61
  62 On success 0 is returned, on error -1 and the ``errno`` variable is set
  63 appropriately. The generic error codes are described at the
  64 :ref:`Generic Error Codes <gen-errors>` chapter.
  65
  66
  67
  68 .. flat-table::
  69     :header-rows:  0
  70     :stub-columns: 0
  71
  72
  73     -  .. row 1
  74
  75        -  ``EINVAL``
  76
  77        -  Invalid stc number.