1*4882a593Smuzhiyun.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later 2*4882a593Smuzhiyun.. c:namespace:: V4L 3*4882a593Smuzhiyun 4*4882a593Smuzhiyun.. _VIDIOC_ENUMAUDIO: 5*4882a593Smuzhiyun 6*4882a593Smuzhiyun********************** 7*4882a593Smuzhiyunioctl VIDIOC_ENUMAUDIO 8*4882a593Smuzhiyun********************** 9*4882a593Smuzhiyun 10*4882a593SmuzhiyunName 11*4882a593Smuzhiyun==== 12*4882a593Smuzhiyun 13*4882a593SmuzhiyunVIDIOC_ENUMAUDIO - Enumerate audio inputs 14*4882a593Smuzhiyun 15*4882a593SmuzhiyunSynopsis 16*4882a593Smuzhiyun======== 17*4882a593Smuzhiyun 18*4882a593Smuzhiyun.. c:macro:: VIDIOC_ENUMAUDIO 19*4882a593Smuzhiyun 20*4882a593Smuzhiyun``int ioctl(int fd, VIDIOC_ENUMAUDIO, struct v4l2_audio *argp)`` 21*4882a593Smuzhiyun 22*4882a593SmuzhiyunArguments 23*4882a593Smuzhiyun========= 24*4882a593Smuzhiyun 25*4882a593Smuzhiyun``fd`` 26*4882a593Smuzhiyun File descriptor returned by :c:func:`open()`. 27*4882a593Smuzhiyun 28*4882a593Smuzhiyun``argp`` 29*4882a593Smuzhiyun Pointer to struct :c:type:`v4l2_audio`. 30*4882a593Smuzhiyun 31*4882a593SmuzhiyunDescription 32*4882a593Smuzhiyun=========== 33*4882a593Smuzhiyun 34*4882a593SmuzhiyunTo query the attributes of an audio input applications initialize the 35*4882a593Smuzhiyun``index`` field and zero out the ``reserved`` array of a struct 36*4882a593Smuzhiyun:c:type:`v4l2_audio` and call the :ref:`VIDIOC_ENUMAUDIO` 37*4882a593Smuzhiyunioctl with a pointer to this structure. Drivers fill the rest of the 38*4882a593Smuzhiyunstructure or return an ``EINVAL`` error code when the index is out of 39*4882a593Smuzhiyunbounds. To enumerate all audio inputs applications shall begin at index 40*4882a593Smuzhiyunzero, incrementing by one until the driver returns ``EINVAL``. 41*4882a593Smuzhiyun 42*4882a593SmuzhiyunSee :ref:`VIDIOC_G_AUDIO <VIDIOC_G_AUDIO>` for a description of struct 43*4882a593Smuzhiyun:c:type:`v4l2_audio`. 44*4882a593Smuzhiyun 45*4882a593SmuzhiyunReturn Value 46*4882a593Smuzhiyun============ 47*4882a593Smuzhiyun 48*4882a593SmuzhiyunOn success 0 is returned, on error -1 and the ``errno`` variable is set 49*4882a593Smuzhiyunappropriately. The generic error codes are described at the 50*4882a593Smuzhiyun:ref:`Generic Error Codes <gen-errors>` chapter. 51*4882a593Smuzhiyun 52*4882a593SmuzhiyunEINVAL 53*4882a593Smuzhiyun The number of the audio input is out of bounds. 54