0001 .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
0002 .. c:namespace:: DTV.dmx
0003
0004 .. _DMX_SET_PES_FILTER:
0005
0006 ==================
0007 DMX_SET_PES_FILTER
0008 ==================
0009
0010 Name
0011 ----
0012
0013 DMX_SET_PES_FILTER
0014
0015 Synopsis
0016 --------
0017
0018 .. c:macro:: DMX_SET_PES_FILTER
0019
0020 ``int ioctl(int fd, DMX_SET_PES_FILTER, struct dmx_pes_filter_params *params)``
0021
0022 Arguments
0023 ---------
0024
0025 ``fd``
0026 File descriptor returned by :c:func:`open()`.
0027
0028 ``params``
0029 Pointer to structure containing filter parameters.
0030
0031 Description
0032 -----------
0033
0034 This ioctl call sets up a PES filter according to the parameters
0035 provided. By a PES filter is meant a filter that is based just on the
0036 packet identifier (PID), i.e. no PES header or payload filtering
0037 capability is supported.
0038
0039 Return Value
0040 ------------
0041
0042 On success 0 is returned.
0043
0044 On error -1 is returned, and the ``errno`` variable is set
0045 appropriately.
0046
0047 .. tabularcolumns:: |p{2.5cm}|p{15.0cm}|
0048
0049 .. flat-table::
0050 :header-rows: 0
0051 :stub-columns: 0
0052 :widths: 1 16
0053
0054 - .. row 1
0055
0056 - ``EBUSY``
0057
0058 - This error code indicates that there are conflicting requests.
0059 There are active filters filtering data from another input source.
0060 Make sure that these filters are stopped before starting this
0061 filter.
0062
0063 The generic error codes are described at the
0064 :ref:`Generic Error Codes <gen-errors>` chapter.
