Documentation/userspace-api/media/dvb/dmx-get-pes-pids.rst

   1 .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
   2 .. c:namespace:: DTV.dmx
   3
   4 .. _DMX_GET_PES_PIDS:
   5
   6 ================
   7 DMX_GET_PES_PIDS
   8 ================
   9
  10 Name
  11 ----
  12
  13 DMX_GET_PES_PIDS
  14
  15 Synopsis
  16 --------
  17
  18 .. c:macro:: DMX_GET_PES_PIDS
  19
  20 ``int ioctl(fd, DMX_GET_PES_PIDS, __u16 pids[5])``
  21
  22 Arguments
  23 ---------
  24
  25 ``fd``
  26     File descriptor returned by :c:func:`open()`.
  27
  28 ``pids``
  29     Array used to store 5 Program IDs.
  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 .. note::
  49
  50         A value equal to 0xffff means that the PID was not filled by the
  51         Kernel.
  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.