Merge branch 'for-linus' of git://git.kernel.org/pub/scm/linux/kernel/git/jikos/hid
[cascardo/linux.git] / Documentation / media / uapi / dvb / audio-set-attributes.rst
1 .. -*- coding: utf-8; mode: rst -*-
2
3 .. _AUDIO_SET_ATTRIBUTES:
4
5 ====================
6 AUDIO_SET_ATTRIBUTES
7 ====================
8
9 Name
10 ----
11
12 AUDIO_SET_ATTRIBUTES
13
14 .. attention:: This ioctl is deprecated
15
16
17 Synopsis
18 --------
19
20 .. c:function:: int ioctl(fd, AUDIO_SET_ATTRIBUTES, struct audio_attributes *attr )
21     :name: AUDIO_SET_ATTRIBUTES
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_attributes_t attr
40
41        -  audio attributes according to section ??
42
43
44 Description
45 -----------
46
47 This ioctl is intended for DVD playback and allows you to set certain
48 information about the audio stream.
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 .. flat-table::
59     :header-rows:  0
60     :stub-columns: 0
61
62
63     -  .. row 1
64
65        -  ``EINVAL``
66
67        -  attr is not a valid or supported attribute setting.