Merge tag 'drivers-5.10-2020-10-12' of git://git.kernel.dk/linux-block
[linux-2.6-block.git] / Documentation / userspace-api / media / dvb / dmx-remove-pid.rst
CommitLineData
059b1c5b 1.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
82559ac0 2
47d23e36
MCC
3.. _DMX_REMOVE_PID:
4
586027ce 5==============
47d23e36
MCC
6DMX_REMOVE_PID
7==============
8
15e7d615 9Name
586027ce 10----
47d23e36 11
586027ce 12DMX_REMOVE_PID
47d23e36 13
15e7d615
MCC
14
15Synopsis
47d23e36
MCC
16--------
17
cf8076c3
MCC
18.. c:function:: int ioctl(fd, DMX_REMOVE_PID, __u16 *pid)
19 :name: DMX_REMOVE_PID
47d23e36 20
47d23e36 21
15e7d615 22Arguments
586027ce 23---------
47d23e36 24
cf8076c3
MCC
25``fd``
26 File descriptor returned by :c:func:`open() <dvb-dmx-open>`.
47d23e36 27
cf8076c3
MCC
28``pid``
29 PID of the PES filter to be removed.
47d23e36
MCC
30
31
15e7d615 32Description
586027ce
MCC
33-----------
34
35This ioctl call allows to remove a PID when multiple PIDs are set on a
36transport stream filter, e. g. a filter previously set up with output
883dfe8a
MCC
37equal to :c:type:`DMX_OUT_TSDEMUX_TAP <dmx_output>`, created via either
38:ref:`DMX_SET_PES_FILTER` or :ref:`DMX_ADD_PID`.
586027ce
MCC
39
40
15e7d615 41Return Value
47d23e36
MCC
42------------
43
9a721b9b
MCC
44On success 0 is returned.
45
46On error -1 is returned, and the ``errno`` variable is set
47appropriately.
48
49The generic error codes are described at the
47d23e36 50:ref:`Generic Error Codes <gen-errors>` chapter.