WIP FPC-III support
[linux/fpc-iii.git] / Documentation / userspace-api / media / dvb / audio-get-capabilities.rst
blob6d9eb71dad171a34ef69569186fed2ce3778060b
1 .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
2 .. c:namespace:: DTV.audio
4 .. _AUDIO_GET_CAPABILITIES:
6 ======================
7 AUDIO_GET_CAPABILITIES
8 ======================
10 Name
11 ----
13 AUDIO_GET_CAPABILITIES
15 .. attention:: This ioctl is deprecated
17 Synopsis
18 --------
20 .. c:macro:: AUDIO_GET_CAPABILITIES
22 ``int ioctl(int fd, AUDIO_GET_CAPABILITIES, unsigned int *cap)``
24 Arguments
25 ---------
27 .. flat-table::
28     :header-rows:  0
29     :stub-columns: 0
31     -
33        -  int fd
35        -  File descriptor returned by a previous call to open().
37     -
39        -  unsigned int \*cap
41        -  Returns a bit array of supported sound formats.
43 Description
44 -----------
46 This ioctl call asks the Audio Device to tell us about the decoding
47 capabilities of the audio hardware.
49 Return Value
50 ------------
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.