Documentation/userspace-api/media/dvb/dmx-start.rst

   1 .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
   2 .. c:namespace:: DTV.dmx
   3
   4 .. _DMX_START:
   5
   6 =========
   7 DMX_START
   8 =========
   9
  10 Name
  11 ----
  12
  13 DMX_START
  14
  15 Synopsis
  16 --------
  17
  18 .. c:macro:: DMX_START
  19
  20 ``int ioctl(int fd, DMX_START)``
  21
  22 Arguments
  23 ---------
  24
  25 ``fd``
  26     File descriptor returned by :c:func:`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 Return Value
  35 ------------
  36
  37 On success 0 is returned.
  38
  39 On error -1 is returned, and the ``errno`` variable is set
  40 appropriately.
  41
  42 .. tabularcolumns:: |p{2.5cm}|p{15.0cm}|
  43
  44 .. flat-table::
  45     :header-rows:  0
  46     :stub-columns: 0
  47
  48     -  .. row 1
  49
  50        -  ``EINVAL``
  51
  52        -  Invalid argument, i.e. no filtering parameters provided via the
  53           :ref:`DMX_SET_FILTER` or :ref:`DMX_SET_PES_FILTER` ioctls.
  54
  55     -  .. row 2
  56
  57        -  ``EBUSY``
  58
  59        -  This error code indicates that there are conflicting requests.
  60           There are active filters filtering data from another input source.
  61           Make sure that these filters are stopped before starting this
  62           filter.
  63
  64 The generic error codes are described at the
  65 :ref:`Generic Error Codes <gen-errors>` chapter.