Documentation/media/uapi/dvb/dmx-remove-pid.rst

   1 .. Permission is granted to copy, distribute and/or modify this
   2 .. document under the terms of the GNU Free Documentation License,
   3 .. Version 1.1 or any later version published by the Free Software
   4 .. Foundation, with no Invariant Sections, no Front-Cover Texts
   5 .. and no Back-Cover Texts. A copy of the license is included at
   6 .. Documentation/media/uapi/fdl-appendix.rst.
   7 ..
   8 .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections
   9
  10 .. _DMX_REMOVE_PID:
  11
  12 ==============
  13 DMX_REMOVE_PID
  14 ==============
  15
  16 Name
  17 ----
  18
  19 DMX_REMOVE_PID
  20
  21
  22 Synopsis
  23 --------
  24
  25 .. c:function:: int ioctl(fd, DMX_REMOVE_PID, __u16 *pid)
  26     :name: DMX_REMOVE_PID
  27
  28
  29 Arguments
  30 ---------
  31
  32 ``fd``
  33     File descriptor returned by :c:func:`open() <dvb-dmx-open>`.
  34
  35 ``pid``
  36     PID of the PES filter to be removed.
  37
  38
  39 Description
  40 -----------
  41
  42 This ioctl call allows to remove a PID when multiple PIDs are set on a
  43 transport stream filter, e. g. a filter previously set up with output
  44 equal to :c:type:`DMX_OUT_TSDEMUX_TAP <dmx_output>`, created via either
  45 :ref:`DMX_SET_PES_FILTER` or :ref:`DMX_ADD_PID`.
  46
  47
  48 Return Value
  49 ------------
  50
  51 On success 0 is returned.
  52
  53 On error -1 is returned, and the ``errno`` variable is set
  54 appropriately.
  55
  56 The generic error codes are described at the
  57 :ref:`Generic Error Codes <gen-errors>` chapter.