Revert "[media] docs-rst: escape [] characters"
[deliverable/linux.git] / Documentation / media / uapi / dvb / dmx-set-pes-filter.rst
CommitLineData
47d23e36
MCC
1.. -*- coding: utf-8; mode: rst -*-
2
3.. _DMX_SET_PES_FILTER:
4
586027ce 5==================
47d23e36
MCC
6DMX_SET_PES_FILTER
7==================
8
15e7d615 9Name
586027ce 10----
47d23e36 11
586027ce 12DMX_SET_PES_FILTER
47d23e36 13
15e7d615
MCC
14
15Synopsis
47d23e36
MCC
16--------
17
5929cb17 18.. cpp:function:: int ioctl( int fd, int request = DMX_SET_PES_FILTER, struct dmx_pes_filter_params *params)
47d23e36 19
47d23e36 20
15e7d615 21Arguments
586027ce 22---------
47d23e36
MCC
23
24.. flat-table::
25 :header-rows: 0
26 :stub-columns: 0
27
28
29 - .. row 1
30
31 - int fd
32
33 - File descriptor returned by a previous call to open().
34
35 - .. row 2
36
37 - int request
38
39 - Equals DMX_SET_PES_FILTER for this command.
40
41 - .. row 3
42
43 - struct dmx_pes_filter_params \*params
44
45 - Pointer to structure containing filter parameters.
46
47
15e7d615 48Description
586027ce
MCC
49-----------
50
51This ioctl call sets up a PES filter according to the parameters
52provided. By a PES filter is meant a filter that is based just on the
53packet identifier (PID), i.e. no PES header or payload filtering
54capability is supported.
55
56
15e7d615 57Return Value
47d23e36
MCC
58------------
59
60On success 0 is returned, on error -1 and the ``errno`` variable is set
61appropriately. The generic error codes are described at the
62:ref:`Generic Error Codes <gen-errors>` chapter.
63
64
65
66.. flat-table::
67 :header-rows: 0
68 :stub-columns: 0
69
70
71 - .. row 1
72
73 - ``EBUSY``
74
75 - This error code indicates that there are conflicting requests.
76 There are active filters filtering data from another input source.
77 Make sure that these filters are stopped before starting this
78 filter.
This page took 0.031205 seconds and 5 git commands to generate.