Documentation/media/uapi/dvb/dmx-set-pes-filter.rst

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