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

   1 .. -*- coding: utf-8; mode: rst -*-
   2
   3 .. _DMX_SET_FILTER:
   4
   5 ==============
   6 DMX_SET_FILTER
   7 ==============
   8
   9 Name
  10 ----
  11
  12 DMX_SET_FILTER
  13
  14
  15 Synopsis
  16 --------
  17
  18 .. cpp:function:: int ioctl( int fd, int request = DMX_SET_FILTER, struct dmx_sct_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_FILTER for this command.
  40
  41     -  .. row 3
  42
  43        -  struct dmx_sct_filter_params \*params
  44
  45        -  Pointer to structure containing filter parameters.
  46
  47
  48 Description
  49 -----------
  50
  51 This ioctl call sets up a filter according to the filter and mask
  52 parameters provided. A timeout may be defined stating number of seconds
  53 to wait for a section to be loaded. A value of 0 means that no timeout
  54 should be applied. Finally there is a flag field where it is possible to
  55 state whether a section should be CRC-checked, whether the filter should
  56 be a ”one-shot” filter, i.e. if the filtering operation should be
  57 stopped after the first section is received, and whether the filtering
  58 operation should be started immediately (without waiting for a
  59 DMX_START ioctl call). If a filter was previously set-up, this filter
  60 will be canceled, and the receive buffer will be flushed.
  61
  62
  63 Return Value
  64 ------------
  65
  66 On success 0 is returned, on error -1 and the ``errno`` variable is set
  67 appropriately. The generic error codes are described at the
  68 :ref:`Generic Error Codes <gen-errors>` chapter.