Merge branch 'pm-cpufreq'
[cascardo/linux.git] / Documentation / media / uapi / dvb / audio-channel-select.rst
1 .. -*- coding: utf-8; mode: rst -*-
2
3 .. _AUDIO_CHANNEL_SELECT:
4
5 ====================
6 AUDIO_CHANNEL_SELECT
7 ====================
8
9 Name
10 ----
11
12 AUDIO_CHANNEL_SELECT
13
14 .. attention:: This ioctl is deprecated
15
16 Synopsis
17 --------
18
19 .. c:function:: int ioctl(int fd, AUDIO_CHANNEL_SELECT, struct *audio_channel_select)
20     :name: AUDIO_CHANNEL_SELECT
21
22
23 Arguments
24 ---------
25
26 .. flat-table::
27     :header-rows:  0
28     :stub-columns: 0
29
30
31     -
32
33        -  int fd
34
35        -  File descriptor returned by a previous call to open().
36
37     -
38
39        -  audio_channel_select_t ch
40
41        -  Select the output format of the audio (mono left/right, stereo).
42
43
44 Description
45 -----------
46
47 This ioctl is for DVB devices only. To control a V4L2 decoder use the
48 V4L2 ``V4L2_CID_MPEG_AUDIO_DEC_PLAYBACK`` control instead.
49
50 This ioctl call asks the Audio Device to select the requested channel if
51 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.