Documentation/media/uapi/dvb/dmx-get-pes-pids.rst

   1 .. _DMX_GET_PES_PIDS:
   2
   3 ================
   4 DMX_GET_PES_PIDS
   5 ================
   6
   7 Name
   8 ----
   9
  10 DMX_GET_PES_PIDS
  11
  12
  13 Synopsis
  14 --------
  15
  16 .. c:function:: int ioctl(fd, DMX_GET_PES_PIDS, __u16 pids[5])
  17     :name: DMX_GET_PES_PIDS
  18
  19 Arguments
  20 ---------
  21
  22 ``fd``
  23     File descriptor returned by :c:func:`open() <dvb-dmx-open>`.
  24
  25 ``pids``
  26     Array used to store 5 Program IDs.
  27
  28
  29 Description
  30 -----------
  31
  32 This ioctl allows to query a DVB device to return the first PID used
  33 by audio, video, textext, subtitle and PCR programs on a given service.
  34 They're stored as:
  35
  36 ======================= ========        =======================================
  37 PID  element            position        content
  38 ======================= ========        =======================================
  39 pids[DMX_PES_AUDIO]     0               first audio PID
  40 pids[DMX_PES_VIDEO]     1               first video PID
  41 pids[DMX_PES_TELETEXT]  2               first teletext PID
  42 pids[DMX_PES_SUBTITLE]  3               first subtitle PID
  43 pids[DMX_PES_PCR]       4               first Program Clock Reference PID
  44 ======================= ========        =======================================
  45
  46
  47 .. note::
  48
  49         A value equal to 0xffff means that the PID was not filled by the
  50         Kernel.
  51
  52
  53 Return Value
  54 ------------
  55
  56 On success 0 is returned.
  57
  58 On error -1 is returned, and the ``errno`` variable is set
  59 appropriately.
  60
  61 The generic error codes are described at the
  62 :ref:`Generic Error Codes <gen-errors>` chapter.