xref: /linux/Documentation/userspace-api/media/dvb/dmx-add-pid.rst (revision 95298d63c67673c654c08952672d016212b26054)
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/userspace-api/media/fdl-appendix.rst.
7..
8.. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections
9
10.. _DMX_ADD_PID:
11
12===========
13DMX_ADD_PID
14===========
15
16Name
17----
18
19DMX_ADD_PID
20
21
22Synopsis
23--------
24
25.. c:function:: int ioctl(fd, DMX_ADD_PID, __u16 *pid)
26    :name: DMX_ADD_PID
27
28
29Arguments
30---------
31
32``fd``
33    File descriptor returned by :c:func:`open() <dvb-dmx-open>`.
34
35``pid``
36   PID number to be filtered.
37
38
39Description
40-----------
41
42This ioctl call allows to add multiple PIDs to a transport stream filter
43previously set up with :ref:`DMX_SET_PES_FILTER` and output equal to
44:c:type:`DMX_OUT_TSDEMUX_TAP <dmx_output>`.
45
46
47Return Value
48------------
49
50On success 0 is returned.
51
52On error -1 is returned, and the ``errno`` variable is set
53appropriately.
54
55Generic error codes are described at the
56:ref:`Generic Error Codes <gen-errors>` chapter.
57