GNU Linux-libre 5.19-rc6-gnu
[releases.git] / drivers / staging / media / av7110 / audio-get-status.rst
1 .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
2 .. c:namespace:: DTV.audio
3
4 .. _AUDIO_GET_STATUS:
5
6 ================
7 AUDIO_GET_STATUS
8 ================
9
10 Name
11 ----
12
13 AUDIO_GET_STATUS
14
15 .. attention:: This ioctl is deprecated
16
17 Synopsis
18 --------
19
20 .. c:macro:: AUDIO_GET_STATUS
21
22 ``int ioctl(int fd, AUDIO_GET_STATUS, struct audio_status *status)``
23
24 Arguments
25 ---------
26
27 .. flat-table::
28     :header-rows:  0
29     :stub-columns: 0
30
31     -
32
33        -  int fd
34
35        -  File descriptor returned by a previous call to open().
36
37     -
38
39        -  struct audio_status \*status
40
41        -  Returns the current state of Audio Device.
42
43 Description
44 -----------
45
46 This ioctl call asks the Audio Device to return the current state of the
47 Audio Device.
48
49 Return Value
50 ------------
51
52 On success 0 is returned, on error -1 and the ``errno`` variable is set
53 appropriately. The generic error codes are described at the
54 :ref:`Generic Error Codes <gen-errors>` chapter.