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 .. c:function:: int ioctl( int fd, DMX_GET_STC, struct dmx_stc *stc)
  19     :name: DMX_GET_STC
  20
  21 Arguments
  22 ---------
  23
  24 ``fd``
  25     File descriptor returned by :c:func:`open() <dvb-dmx-open>`.
  26
  27 ``stc``
  28     Pointer to the location where the stc is to be stored.
  29
  30
  31 Description
  32 -----------
  33
  34 This ioctl call returns the current value of the system time counter
  35 (which is driven by a PES filter of type DMX_PES_PCR). Some hardware
  36 supports more than one STC, so you must specify which one by setting the
  37 num field of stc before the ioctl (range 0...n). The result is returned
  38 in form of a ratio with a 64 bit numerator and a 32 bit denominator, so
  39 the real 90kHz STC value is stc->stc / stc->base .
  40
  41
  42 Return Value
  43 ------------
  44
  45 On success 0 is returned, on error -1 and the ``errno`` variable is set
  46 appropriately. The generic error codes are described at the
  47 :ref:`Generic Error Codes <gen-errors>` chapter.
  48
  49 .. flat-table::
  50     :header-rows:  0
  51     :stub-columns: 0
  52
  53
  54     -  .. row 1
  55
  56        -  ``EINVAL``
  57
  58        -  Invalid stc number.