Merge tag 'for-5.0-rc2-tag' of git://git.kernel.org/pub/scm/linux/kernel/git/kdave...
[sfrench/cifs-2.6.git] / Documentation / media / uapi / dvb / audio-set-mixer.rst
1 .. Permission is granted to copy, distribute and/or modify this
2 .. document under the terms of the GNU Free Documentation License,
3 .. Version 1.1 or any later version published by the Free Software
4 .. Foundation, with no Invariant Sections, no Front-Cover Texts
5 .. and no Back-Cover Texts. A copy of the license is included at
6 .. Documentation/media/uapi/fdl-appendix.rst.
7 ..
8 .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections
9
10 .. _AUDIO_SET_MIXER:
11
12 ===============
13 AUDIO_SET_MIXER
14 ===============
15
16 Name
17 ----
18
19 AUDIO_SET_MIXER
20
21 .. attention:: This ioctl is deprecated
22
23 Synopsis
24 --------
25
26 .. c:function:: int ioctl(int fd, AUDIO_SET_MIXER, struct audio_mixer *mix)
27     :name: AUDIO_SET_MIXER
28
29 Arguments
30 ---------
31
32 .. flat-table::
33     :header-rows:  0
34     :stub-columns: 0
35
36
37     -
38
39        -  int fd
40
41        -  File descriptor returned by a previous call to open().
42
43     -
44
45        -  audio_mixer_t \*mix
46
47        -  mixer settings.
48
49
50 Description
51 -----------
52
53 This ioctl lets you adjust the mixer settings of the audio decoder.
54
55
56 Return Value
57 ------------
58
59 On success 0 is returned, on error -1 and the ``errno`` variable is set
60 appropriately. The generic error codes are described at the
61 :ref:`Generic Error Codes <gen-errors>` chapter.