1.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
2.. c:namespace:: DTV.audio
3
4.. _AUDIO_SET_BYPASS_MODE:
5
6=====================
7AUDIO_SET_BYPASS_MODE
8=====================
9
10Name
11----
12
13AUDIO_SET_BYPASS_MODE
14
15.. attention:: This ioctl is deprecated
16
17Synopsis
18--------
19
20.. c:macro:: AUDIO_SET_BYPASS_MODE
21
22``int ioctl(int fd, AUDIO_SET_BYPASS_MODE, boolean mode)``
23
24Arguments
25---------
26
27.. flat-table::
28    :header-rows:  0
29    :stub-columns: 0
30
31    -
32
33       -  int fd
34
35       -  File descriptor returned by a previous call to open().
36
37    -
38
39       -  boolean mode
40
41       -  Enables or disables the decoding of the current Audio stream in
42	  the Digital TV subsystem.
43
44          TRUE: Bypass is disabled
45
46          FALSE: Bypass is enabled
47
48Description
49-----------
50
51This ioctl call asks the Audio Device to bypass the Audio decoder and
52forward the stream without decoding. This mode shall be used if streams
53that can't be handled by the Digital TV system shall be decoded. Dolby
54DigitalTM streams are automatically forwarded by the Digital TV subsystem if
55the hardware can handle it.
56
57Return Value
58------------
59
60On success 0 is returned, on error -1 and the ``errno`` variable is set
61appropriately. The generic error codes are described at the
62:ref:`Generic Error Codes <gen-errors>` chapter.
63