doc-rst: customize RTD theme, captions & inline literal
[deliverable/linux.git] / Documentation / linux_tv / media / 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
586027ce
MCC
9NAME
10----
47d23e36 11
586027ce 12AUDIO_SET_BYPASS_MODE
47d23e36 13
586027ce 14SYNOPSIS
47d23e36
MCC
15--------
16
17.. c:function:: int ioctl(int fd, int request = AUDIO_SET_BYPASS_MODE, boolean mode)
18
47d23e36 19
586027ce
MCC
20ARGUMENTS
21---------
47d23e36
MCC
22
23.. flat-table::
24 :header-rows: 0
25 :stub-columns: 0
26
27
28 - .. row 1
29
30 - int fd
31
32 - File descriptor returned by a previous call to open().
33
34 - .. row 2
35
36 - int request
37
38 - Equals AUDIO_SET_BYPASS_MODE for this command.
39
40 - .. row 3
41
42 - boolean mode
43
44 - Enables or disables the decoding of the current Audio stream in
45 the DVB subsystem.
46
47 - .. row 4
48
49 -
50 - TRUE Bypass is disabled
51
52 - .. row 5
53
54 -
55 - FALSE Bypass is enabled
56
57
586027ce
MCC
58DESCRIPTION
59-----------
60
61This ioctl call asks the Audio Device to bypass the Audio decoder and
62forward the stream without decoding. This mode shall be used if streams
63that can’t be handled by the DVB system shall be decoded. Dolby
64DigitalTM streams are automatically forwarded by the DVB subsystem if
65the hardware can handle it.
66
67
68RETURN VALUE
47d23e36
MCC
69------------
70
71On success 0 is returned, on error -1 and the ``errno`` variable is set
72appropriately. The generic error codes are described at the
73:ref:`Generic Error Codes <gen-errors>` chapter.
This page took 0.030162 seconds and 5 git commands to generate.