[media] docs-rst: Convert DVB uAPI to use C function references
[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
cf8076c3 14.. attention:: This ioctl is deprecated
15e7d615
MCC
15
16Synopsis
47d23e36
MCC
17--------
18
cf8076c3
MCC
19.. c:function:: int ioctl(int fd, AUDIO_SET_BYPASS_MODE, boolean mode)
20 :name: AUDIO_SET_BYPASS_MODE
47d23e36 21
15e7d615 22Arguments
586027ce 23---------
47d23e36
MCC
24
25.. flat-table::
26 :header-rows: 0
27 :stub-columns: 0
28
29
cf8076c3 30 -
47d23e36
MCC
31
32 - int fd
33
34 - File descriptor returned by a previous call to open().
35
cf8076c3 36 -
47d23e36
MCC
37
38 - boolean mode
39
40 - Enables or disables the decoding of the current Audio stream in
41 the DVB subsystem.
42
cf8076c3 43 TRUE: Bypass is disabled
47d23e36 44
cf8076c3 45 FALSE: Bypass is enabled
47d23e36
MCC
46
47
15e7d615 48Description
586027ce
MCC
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 DVB system shall be decoded. Dolby
54DigitalTM streams are automatically forwarded by the DVB subsystem if
55the hardware can handle it.
56
57
15e7d615 58Return Value
47d23e36
MCC
59------------
60
61On success 0 is returned, on error -1 and the ``errno`` variable is set
62appropriately. The generic error codes are described at the
63:ref:`Generic Error Codes <gen-errors>` chapter.
This page took 0.050484 seconds and 5 git commands to generate.