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 .. cpp:function:: int ioctl( int fd, int request = DMX_SET_PES_FILTER, struct dmx_pes_filter_params *params)
  19
  20
  21 Arguments
  22 ---------
  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
  48 Description
  49 -----------
  50
  51 This ioctl call sets up a PES filter according to the parameters
  52 provided. By a PES filter is meant a filter that is based just on the
  53 packet identifier (PID), i.e. no PES header or payload filtering
  54 capability is supported.
  55
  56
  57 Return Value
  58 ------------
  59
  60 On success 0 is returned, on error -1 and the ``errno`` variable is set
  61 appropriately. 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.