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 .. c:function:: int ioctl( int fd, DMX_START)
  19     :name: DMX_START
  20
  21
  22 Arguments
  23 ---------
  24
  25 ``fd``
  26     File descriptor returned by :c:func:`open() <dvb-dmx-open>`.
  27
  28 Description
  29 -----------
  30
  31 This ioctl call is used to start the actual filtering operation defined
  32 via the ioctl calls :ref:`DMX_SET_FILTER` or :ref:`DMX_SET_PES_FILTER`.
  33
  34
  35 Return Value
  36 ------------
  37
  38 On success 0 is returned.
  39
  40 On error -1 is returned, and the ``errno`` variable is set
  41 appropriately.
  42
  43 .. tabularcolumns:: |p{2.5cm}|p{15.0cm}|
  44
  45 .. flat-table::
  46     :header-rows:  0
  47     :stub-columns: 0
  48
  49
  50     -  .. row 1
  51
  52        -  ``EINVAL``
  53
  54        -  Invalid argument, i.e. no filtering parameters provided via the
  55           :ref:`DMX_SET_FILTER` or :ref:`DMX_SET_PES_FILTER` ioctls.
  56
  57     -  .. row 2
  58
  59        -  ``EBUSY``
  60
  61        -  This error code indicates that there are conflicting requests.
  62           There are active filters filtering data from another input source.
  63           Make sure that these filters are stopped before starting this
  64           filter.
  65
  66
  67 The generic error codes are described at the
  68 :ref:`Generic Error Codes <gen-errors>` chapter.