Documentation/media/uapi/v4l/vidioc-enumaudio.rst

   1 .. -*- coding: utf-8; mode: rst -*-
   2
   3 .. _VIDIOC_ENUMAUDIO:
   4
   5 **********************
   6 ioctl VIDIOC_ENUMAUDIO
   7 **********************
   8
   9 Name
  10 ====
  11
  12 VIDIOC_ENUMAUDIO - Enumerate audio inputs
  13
  14
  15 Synopsis
  16 ========
  17
  18 .. cpp:function:: int ioctl( int fd, int request, struct v4l2_audio *argp )
  19
  20
  21 Arguments
  22 =========
  23
  24 ``fd``
  25     File descriptor returned by :ref:`open() <func-open>`.
  26
  27 ``request``
  28     VIDIOC_ENUMAUDIO
  29
  30 ``argp``
  31
  32
  33 Description
  34 ===========
  35
  36 To query the attributes of an audio input applications initialize the
  37 ``index`` field and zero out the ``reserved`` array of a struct
  38 :ref:`v4l2_audio <v4l2-audio>` and call the :ref:`VIDIOC_ENUMAUDIO`
  39 ioctl with a pointer to this structure. Drivers fill the rest of the
  40 structure or return an ``EINVAL`` error code when the index is out of
  41 bounds. To enumerate all audio inputs applications shall begin at index
  42 zero, incrementing by one until the driver returns ``EINVAL``.
  43
  44 See :ref:`VIDIOC_G_AUDIO <VIDIOC_G_AUDIO>` for a description of struct
  45 :ref:`v4l2_audio <v4l2-audio>`.
  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 EINVAL
  56     The number of the audio input is out of bounds.