WIP FPC-III support
[linux/fpc-iii.git] / Documentation / userspace-api / media / dvb / dmx-remove-pid.rst
blobf75b33e5e49a191476f5d8b8caffae38a8f8ab27
1 .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
2 .. c:namespace:: DTV.dmx
4 .. _DMX_REMOVE_PID:
6 ==============
7 DMX_REMOVE_PID
8 ==============
10 Name
11 ----
13 DMX_REMOVE_PID
15 Synopsis
16 --------
18 .. c:macro:: DMX_REMOVE_PID
20 ``int ioctl(fd, DMX_REMOVE_PID, __u16 *pid)``
22 Arguments
23 ---------
25 ``fd``
26     File descriptor returned by :c:func:`open()`.
28 ``pid``
29     PID of the PES filter to be removed.
31 Description
32 -----------
34 This ioctl call allows to remove a PID when multiple PIDs are set on a
35 transport stream filter, e. g. a filter previously set up with output
36 equal to :c:type:`DMX_OUT_TSDEMUX_TAP <dmx_output>`, created via either
37 :ref:`DMX_SET_PES_FILTER` or :ref:`DMX_ADD_PID`.
39 Return Value
40 ------------
42 On success 0 is returned.
44 On error -1 is returned, and the ``errno`` variable is set
45 appropriately.
47 The generic error codes are described at the
48 :ref:`Generic Error Codes <gen-errors>` chapter.