Documentation/media/uapi/dvb/dmx-start.rst

   1 .. -*- coding: utf-8; mode: rst -*-
   2
   3 .. _DMX_START:
   4
   5 =========
   6 DMX_START
   7 =========
   8
   9 Name
  10 ----
  11
  12 DMX_START
  13
  14
  15 Synopsis
  16 --------
  17
  18 .. cpp:function:: int ioctl( int fd, int request = DMX_START)
  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_START for this command.
  40
  41
  42 Description
  43 -----------
  44
  45 This ioctl call is used to start the actual filtering operation defined
  46 via the ioctl calls DMX_SET_FILTER or DMX_SET_PES_FILTER.
  47
  48
  49 Return Value
  50 ------------
  51
  52 On success 0 is returned, on error -1 and the ``errno`` variable is set
  53 appropriately. The generic error codes are described at the
  54 :ref:`Generic Error Codes <gen-errors>` chapter.
  55
  56
  57
  58 .. flat-table::
  59     :header-rows:  0
  60     :stub-columns: 0
  61
  62
  63     -  .. row 1
  64
  65        -  ``EINVAL``
  66
  67        -  Invalid argument, i.e. no filtering parameters provided via the
  68           DMX_SET_FILTER or DMX_SET_PES_FILTER functions.
  69
  70     -  .. row 2
  71
  72        -  ``EBUSY``
  73
  74        -  This error code indicates that there are conflicting requests.
  75           There are active filters filtering data from another input source.
  76           Make sure that these filters are stopped before starting this
  77           filter.