Merge tag 'gvt-next-2020-11-23' of https://github.com/intel/gvt-linux into drm-intel...
[linux-2.6-microblaze.git] / Documentation / userspace-api / media / dvb / dmx-remove-pid.rst
1 .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
2 .. c:namespace:: DTV.dmx
3
4 .. _DMX_REMOVE_PID:
5
6 ==============
7 DMX_REMOVE_PID
8 ==============
9
10 Name
11 ----
12
13 DMX_REMOVE_PID
14
15 Synopsis
16 --------
17
18 .. c:macro:: DMX_REMOVE_PID
19
20 ``int ioctl(fd, DMX_REMOVE_PID, __u16 *pid)``
21
22 Arguments
23 ---------
24
25 ``fd``
26     File descriptor returned by :c:func:`open()`.
27
28 ``pid``
29     PID of the PES filter to be removed.
30
31 Description
32 -----------
33
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`.
38
39 Return Value
40 ------------
41
42 On success 0 is returned.
43
44 On error -1 is returned, and the ``errno`` variable is set
45 appropriately.
46
47 The generic error codes are described at the
48 :ref:`Generic Error Codes <gen-errors>` chapter.