doc-rst: linux_tv: split DVB function call documentation
[cascardo/linux.git] / Documentation / linux_tv / media / dvb / audio-set-bypass-mode.rst
1 .. -*- coding: utf-8; mode: rst -*-
2
3 .. _AUDIO_SET_BYPASS_MODE:
4
5 AUDIO_SET_BYPASS_MODE
6 =====================
7
8 Description
9 -----------
10
11 This ioctl call asks the Audio Device to bypass the Audio decoder and
12 forward the stream without decoding. This mode shall be used if streams
13 that can’t be handled by the DVB system shall be decoded. Dolby
14 DigitalTM streams are automatically forwarded by the DVB subsystem if
15 the hardware can handle it.
16
17 Synopsis
18 --------
19
20 .. c:function:: int ioctl(int fd, int request = AUDIO_SET_BYPASS_MODE, boolean mode)
21
22 Arguments
23 ----------
24
25
26
27 .. flat-table::
28     :header-rows:  0
29     :stub-columns: 0
30
31
32     -  .. row 1
33
34        -  int fd
35
36        -  File descriptor returned by a previous call to open().
37
38     -  .. row 2
39
40        -  int request
41
42        -  Equals AUDIO_SET_BYPASS_MODE for this command.
43
44     -  .. row 3
45
46        -  boolean mode
47
48        -  Enables or disables the decoding of the current Audio stream in
49           the DVB subsystem.
50
51     -  .. row 4
52
53        -
54        -  TRUE Bypass is disabled
55
56     -  .. row 5
57
58        -
59        -  FALSE Bypass is enabled
60
61
62 Return Value
63 ------------
64
65 On success 0 is returned, on error -1 and the ``errno`` variable is set
66 appropriately. The generic error codes are described at the
67 :ref:`Generic Error Codes <gen-errors>` chapter.
68
69