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

   1 .. Permission is granted to copy, distribute and/or modify this
   2 .. document under the terms of the GNU Free Documentation License,
   3 .. Version 1.1 or any later version published by the Free Software
   4 .. Foundation, with no Invariant Sections, no Front-Cover Texts
   5 .. and no Back-Cover Texts. A copy of the license is included at
   6 .. Documentation/media/uapi/fdl-appendix.rst.
   7 ..
   8 .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections
   9
  10 .. _DMX_START:
  11
  12 =========
  13 DMX_START
  14 =========
  15
  16 Name
  17 ----
  18
  19 DMX_START
  20
  21
  22 Synopsis
  23 --------
  24
  25 .. c:function:: int ioctl( int fd, DMX_START)
  26     :name: DMX_START
  27
  28
  29 Arguments
  30 ---------
  31
  32 ``fd``
  33     File descriptor returned by :c:func:`open() <dvb-dmx-open>`.
  34
  35 Description
  36 -----------
  37
  38 This ioctl call is used to start the actual filtering operation defined
  39 via the ioctl calls :ref:`DMX_SET_FILTER` or :ref:`DMX_SET_PES_FILTER`.
  40
  41
  42 Return Value
  43 ------------
  44
  45 On success 0 is returned.
  46
  47 On error -1 is returned, and the ``errno`` variable is set
  48 appropriately.
  49
  50 .. tabularcolumns:: |p{2.5cm}|p{15.0cm}|
  51
  52 .. flat-table::
  53     :header-rows:  0
  54     :stub-columns: 0
  55
  56
  57     -  .. row 1
  58
  59        -  ``EINVAL``
  60
  61        -  Invalid argument, i.e. no filtering parameters provided via the
  62           :ref:`DMX_SET_FILTER` or :ref:`DMX_SET_PES_FILTER` ioctls.
  63
  64     -  .. row 2
  65
  66        -  ``EBUSY``
  67
  68        -  This error code indicates that there are conflicting requests.
  69           There are active filters filtering data from another input source.
  70           Make sure that these filters are stopped before starting this
  71           filter.
  72
  73
  74 The generic error codes are described at the
  75 :ref:`Generic Error Codes <gen-errors>` chapter.