Merge tag 'nfs-for-4.8-2' of git://git.linux-nfs.org/projects/trondmy/linux-nfs
[cascardo/linux.git] / Documentation / media / uapi / dvb / audio-set-id.rst
1 .. -*- coding: utf-8; mode: rst -*-
2
3 .. _AUDIO_SET_ID:
4
5 ============
6 AUDIO_SET_ID
7 ============
8
9 Name
10 ----
11
12 AUDIO_SET_ID
13
14
15 Synopsis
16 --------
17
18 .. cpp:function:: int  ioctl(int fd, int request = AUDIO_SET_ID, int id)
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_SET_ID for this command.
40
41     -  .. row 3
42
43        -  int id
44
45        -  audio sub-stream id
46
47
48 Description
49 -----------
50
51 This ioctl selects which sub-stream is to be decoded if a program or
52 system stream is sent to the video device. If no audio stream type is
53 set the id has to be in [0xC0,0xDF] for MPEG sound, in [0x80,0x87] for
54 AC3 and in [0xA0,0xA7] for LPCM. More specifications may follow for
55 other stream types. If the stream type is set the id just specifies the
56 substream id of the audio stream and only the first 5 bits are
57 recognized.
58
59
60 Return Value
61 ------------
62
63 On success 0 is returned, on error -1 and the ``errno`` variable is set
64 appropriately. The generic error codes are described at the
65 :ref:`Generic Error Codes <gen-errors>` chapter.