doc-rst: linux_tv: split DVB function call documentation
[cascardo/linux.git] / Documentation / linux_tv / media / dvb / audio-get-status.rst
1 .. -*- coding: utf-8; mode: rst -*-
2
3 .. _AUDIO_GET_STATUS:
4
5 AUDIO_GET_STATUS
6 ================
7
8 Description
9 -----------
10
11 This ioctl call asks the Audio Device to return the current state of the
12 Audio Device.
13
14 Synopsis
15 --------
16
17 .. c:function:: int ioctl(int fd, int request = AUDIO_GET_STATUS, struct audio_status *status)
18
19 Arguments
20 ----------
21
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_GET_STATUS for this command.
40
41     -  .. row 3
42
43        -  struct audio_status \*status
44
45        -  Returns the current state of Audio Device.
46
47
48 Return Value
49 ------------
50
51 On success 0 is returned, on error -1 and the ``errno`` variable is set
52 appropriately. The generic error codes are described at the
53 :ref:`Generic Error Codes <gen-errors>` chapter.
54
55