Merge remote-tracking branch 'regmap/fix/rbtree' into regmap-linus
[cascardo/linux.git] / Documentation / media / uapi / dvb / audio-bilingual-channel-select.rst
1 .. -*- coding: utf-8; mode: rst -*-
2
3 .. _AUDIO_BILINGUAL_CHANNEL_SELECT:
4
5 ==============================
6 AUDIO_BILINGUAL_CHANNEL_SELECT
7 ==============================
8
9 Name
10 ----
11
12 AUDIO_BILINGUAL_CHANNEL_SELECT
13
14
15 Synopsis
16 --------
17
18 .. cpp:function:: int ioctl(int fd, int request = AUDIO_BILINGUAL_CHANNEL_SELECT, audio_channel_select_t)
19
20
21 Arguments
22 ---------
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_BILINGUAL_CHANNEL_SELECT for this command.
40
41     -  .. row 3
42
43        -  audio_channel_select_t ch
44
45        -  Select the output format of the audio (mono left/right, stereo).
46
47
48 Description
49 -----------
50
51 This ioctl is obsolete. Do not use in new drivers. It has been replaced
52 by the V4L2 ``V4L2_CID_MPEG_AUDIO_DEC_MULTILINGUAL_PLAYBACK`` control
53 for MPEG decoders controlled through V4L2.
54
55 This ioctl call asks the Audio Device to select the requested channel
56 for bilingual streams if possible.
57
58
59 Return Value
60 ------------
61
62 On success 0 is returned, on error -1 and the ``errno`` variable is set
63 appropriately. The generic error codes are described at the
64 :ref:`Generic Error Codes <gen-errors>` chapter.