Merge branch 'for-linus' of git://git.kernel.org/pub/scm/linux/kernel/git/jikos/hid
[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 .. attention:: This ioctl is deprecated
15
16 Synopsis
17 --------
18
19 .. c:function:: int ioctl(int fd, AUDIO_BILINGUAL_CHANNEL_SELECT, struct *audio_channel_select)
20     :name: AUDIO_BILINGUAL_CHANNEL_SELECT
21
22
23 Arguments
24 ---------
25
26 .. flat-table::
27     :header-rows:  0
28     :stub-columns: 0
29
30     -
31
32        -  int fd
33
34        -  File descriptor returned by a previous call to open().
35
36     -
37
38        -  audio_channel_select_t ch
39
40        -  Select the output format of the audio (mono left/right, stereo).
41
42
43 Description
44 -----------
45
46 This ioctl is obsolete. Do not use in new drivers. It has been replaced
47 by the V4L2 ``V4L2_CID_MPEG_AUDIO_DEC_MULTILINGUAL_PLAYBACK`` control
48 for MPEG decoders controlled through V4L2.
49
50 This ioctl call asks the Audio Device to select the requested channel
51 for bilingual streams if possible.
52
53
54 Return Value
55 ------------
56
57 On success 0 is returned, on error -1 and the ``errno`` variable is set
58 appropriately. The generic error codes are described at the
59 :ref:`Generic Error Codes <gen-errors>` chapter.