Revert "[media] docs-rst: escape [] characters"
[deliverable/linux.git] / Documentation / media / uapi / dvb / audio-set-bypass-mode.rst
CommitLineData
47d23e36
MCC
1.. -*- coding: utf-8; mode: rst -*-
2
3.. _AUDIO_SET_BYPASS_MODE:
4
586027ce 5=====================
47d23e36
MCC
6AUDIO_SET_BYPASS_MODE
7=====================
8
15e7d615 9Name
586027ce 10----
47d23e36 11
586027ce 12AUDIO_SET_BYPASS_MODE
47d23e36 13
15e7d615
MCC
14
15Synopsis
47d23e36
MCC
16--------
17
5929cb17 18.. cpp:function:: int ioctl(int fd, int request = AUDIO_SET_BYPASS_MODE, boolean mode)
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 AUDIO_SET_BYPASS_MODE for this command.
40
41 - .. row 3
42
43 - boolean mode
44
45 - Enables or disables the decoding of the current Audio stream in
46 the DVB subsystem.
47
48 - .. row 4
49
50 -
51 - TRUE Bypass is disabled
52
53 - .. row 5
54
55 -
56 - FALSE Bypass is enabled
57
58
15e7d615 59Description
586027ce
MCC
60-----------
61
62This ioctl call asks the Audio Device to bypass the Audio decoder and
63forward the stream without decoding. This mode shall be used if streams
64that can’t be handled by the DVB system shall be decoded. Dolby
65DigitalTM streams are automatically forwarded by the DVB subsystem if
66the hardware can handle it.
67
68
15e7d615 69Return Value
47d23e36
MCC
70------------
71
72On success 0 is returned, on error -1 and the ``errno`` variable is set
73appropriately. The generic error codes are described at the
74:ref:`Generic Error Codes <gen-errors>` chapter.
This page took 0.031884 seconds and 5 git commands to generate.