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

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