Commit | Line | Data |
---|---|---|
5377d91f MH |
1 | .. -*- coding: utf-8; mode: rst -*- |
2 | ||
af4a4d0d | 3 | .. _VIDIOC_ENUMAUDIO: |
5377d91f MH |
4 | |
5 | ********************** | |
6 | ioctl VIDIOC_ENUMAUDIO | |
7 | ********************** | |
8 | ||
15e7d615 | 9 | Name |
586027ce | 10 | ==== |
5377d91f | 11 | |
586027ce | 12 | VIDIOC_ENUMAUDIO - Enumerate audio inputs |
5377d91f | 13 | |
15e7d615 MCC |
14 | |
15 | Synopsis | |
5377d91f MH |
16 | ======== |
17 | ||
41d80465 MCC |
18 | .. c:function:: int ioctl( int fd, VIDIOC_ENUMAUDIO, struct v4l2_audio *argp ) |
19 | :name: VIDIOC_ENUMAUDIO | |
5377d91f | 20 | |
586027ce | 21 | |
15e7d615 | 22 | Arguments |
5377d91f MH |
23 | ========= |
24 | ||
25 | ``fd`` | |
26 | File descriptor returned by :ref:`open() <func-open>`. | |
27 | ||
5377d91f MH |
28 | ``argp`` |
29 | ||
30 | ||
15e7d615 | 31 | Description |
5377d91f MH |
32 | =========== |
33 | ||
34 | To query the attributes of an audio input applications initialize the | |
35 | ``index`` field and zero out the ``reserved`` array of a struct | |
e8be7e97 | 36 | :c:type:`v4l2_audio` and call the :ref:`VIDIOC_ENUMAUDIO` |
5377d91f | 37 | ioctl with a pointer to this structure. Drivers fill the rest of the |
cdb4af0f | 38 | structure or return an ``EINVAL`` error code when the index is out of |
5377d91f | 39 | bounds. To enumerate all audio inputs applications shall begin at index |
cdb4af0f | 40 | zero, incrementing by one until the driver returns ``EINVAL``. |
5377d91f | 41 | |
4e03cb76 | 42 | See :ref:`VIDIOC_G_AUDIO <VIDIOC_G_AUDIO>` for a description of struct |
e8be7e97 | 43 | :c:type:`v4l2_audio`. |
5377d91f MH |
44 | |
45 | ||
15e7d615 | 46 | Return Value |
5377d91f MH |
47 | ============ |
48 | ||
49 | On success 0 is returned, on error -1 and the ``errno`` variable is set | |
50 | appropriately. The generic error codes are described at the | |
51 | :ref:`Generic Error Codes <gen-errors>` chapter. | |
52 | ||
53 | EINVAL | |
54 | The number of the audio input is out of bounds. |