doc-rst: linux_tv: split DVB function call documentation
[deliverable/linux.git] / Documentation / linux_tv / media / dvb / audio-channel-select.rst
1 .. -*- coding: utf-8; mode: rst -*-
2
3 .. _AUDIO_CHANNEL_SELECT:
4
5 AUDIO_CHANNEL_SELECT
6 ====================
7
8 Description
9 -----------
10
11 This ioctl is for DVB devices only. To control a V4L2 decoder use the
12 V4L2 ``V4L2_CID_MPEG_AUDIO_DEC_PLAYBACK`` control instead.
13
14 This ioctl call asks the Audio Device to select the requested channel if
15 possible.
16
17 Synopsis
18 --------
19
20 .. c:function:: int ioctl(int fd, int request = AUDIO_CHANNEL_SELECT, audio_channel_select_t)
21
22 Arguments
23 ----------
24
25
26
27 .. flat-table::
28 :header-rows: 0
29 :stub-columns: 0
30
31
32 - .. row 1
33
34 - int fd
35
36 - File descriptor returned by a previous call to open().
37
38 - .. row 2
39
40 - int request
41
42 - Equals AUDIO_CHANNEL_SELECT for this command.
43
44 - .. row 3
45
46 - audio_channel_select_t ch
47
48 - Select the output format of the audio (mono left/right, stereo).
49
50
51 Return Value
52 ------------
53
54 On success 0 is returned, on error -1 and the ``errno`` variable is set
55 appropriately. The generic error codes are described at the
56 :ref:`Generic Error Codes <gen-errors>` chapter.
57
58
This page took 0.036223 seconds and 5 git commands to generate.