Documentation/userspace-api/media/dvb/dmx-set-pes-filter.rst

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