Revert "[media] docs-rst: escape [] characters"
[deliverable/linux.git] / Documentation / media / uapi / dvb / dmx-start.rst
CommitLineData
47d23e36
MCC
1.. -*- coding: utf-8; mode: rst -*-
2
3.. _DMX_START:
4
586027ce 5=========
47d23e36
MCC
6DMX_START
7=========
8
15e7d615 9Name
586027ce 10----
47d23e36 11
586027ce 12DMX_START
47d23e36 13
15e7d615
MCC
14
15Synopsis
47d23e36
MCC
16--------
17
5929cb17 18.. cpp:function:: int ioctl( int fd, int request = DMX_START)
47d23e36 19
47d23e36 20
15e7d615 21Arguments
586027ce 22---------
47d23e36
MCC
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
15e7d615 42Description
586027ce
MCC
43-----------
44
45This ioctl call is used to start the actual filtering operation defined
46via the ioctl calls DMX_SET_FILTER or DMX_SET_PES_FILTER.
47
48
15e7d615 49Return Value
47d23e36
MCC
50------------
51
52On success 0 is returned, on error -1 and the ``errno`` variable is set
53appropriately. 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.
This page took 0.032396 seconds and 5 git commands to generate.