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

   1 .. -*- coding: utf-8; mode: rst -*-
   2
   3 .. _DMX_REMOVE_PID:
   4
   5 ==============
   6 DMX_REMOVE_PID
   7 ==============
   8
   9 Name
  10 ----
  11
  12 DMX_REMOVE_PID
  13
  14
  15 Synopsis
  16 --------
  17
  18 .. c:function:: int ioctl(fd, DMX_REMOVE_PID, __u16 *pid)
  19     :name: DMX_REMOVE_PID
  20
  21
  22 Arguments
  23 ---------
  24
  25 ``fd``
  26     File descriptor returned by :c:func:`open() <dvb-dmx-open>`.
  27
  28 ``pid``
  29     PID of the PES filter to be removed.
  30
  31
  32 Description
  33 -----------
  34
  35 This ioctl call allows to remove a PID when multiple PIDs are set on a
  36 transport stream filter, e. g. a filter previously set up with output
  37 equal to :c:type:`DMX_OUT_TSDEMUX_TAP <dmx_output>`, created via either
  38 :ref:`DMX_SET_PES_FILTER` or :ref:`DMX_ADD_PID`.
  39
  40
  41 Return Value
  42 ------------
  43
  44 On success 0 is returned.
  45
  46 On error -1 is returned, and the ``errno`` variable is set
  47 appropriately.
  48
  49 The generic error codes are described at the
  50 :ref:`Generic Error Codes <gen-errors>` chapter.