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_SET_PES_FILTER:
11
12==================
13DMX_SET_PES_FILTER
14==================
15
16Name
17----
18
19DMX_SET_PES_FILTER
20
21
22Synopsis
23--------
24
25.. c:function:: int ioctl( int fd, DMX_SET_PES_FILTER, struct dmx_pes_filter_params *params)
26    :name: DMX_SET_PES_FILTER
27
28
29Arguments
30---------
31
32
33``fd``
34    File descriptor returned by :c:func:`open() <dvb-dmx-open>`.
35
36``params``
37    Pointer to structure containing filter parameters.
38
39
40Description
41-----------
42
43This ioctl call sets up a PES filter according to the parameters
44provided. By a PES filter is meant a filter that is based just on the
45packet identifier (PID), i.e. no PES header or payload filtering
46capability is supported.
47
48
49Return Value
50------------
51
52On success 0 is returned.
53
54On error -1 is returned, and the ``errno`` variable is set
55appropriately.
56
57.. tabularcolumns:: |p{2.5cm}|p{15.0cm}|
58
59.. flat-table::
60    :header-rows:  0
61    :stub-columns: 0
62    :widths: 1 16
63
64
65    -  .. row 1
66
67       -  ``EBUSY``
68
69       -  This error code indicates that there are conflicting requests.
70	  There are active filters filtering data from another input source.
71	  Make sure that these filters are stopped before starting this
72	  filter.
73
74
75The generic error codes are described at the
76:ref:`Generic Error Codes <gen-errors>` chapter.
77