Documentation/media/uapi/v4l/vidioc-g-audio.rst

   1 .. -*- coding: utf-8; mode: rst -*-
   2
   3 .. _VIDIOC_G_AUDIO:
   4
   5 ************************************
   6 ioctl VIDIOC_G_AUDIO, VIDIOC_S_AUDIO
   7 ************************************
   8
   9 Name
  10 ====
  11
  12 VIDIOC_G_AUDIO - VIDIOC_S_AUDIO - Query or select the current audio input and its attributes
  13
  14
  15 Synopsis
  16 ========
  17
  18 .. cpp:function:: int ioctl( int fd, int request, struct v4l2_audio *argp )
  19
  20 .. cpp:function:: int ioctl( int fd, int request, const struct v4l2_audio *argp )
  21
  22
  23 Arguments
  24 =========
  25
  26 ``fd``
  27     File descriptor returned by :ref:`open() <func-open>`.
  28
  29 ``request``
  30     VIDIOC_G_AUDIO, VIDIOC_S_AUDIO
  31
  32 ``argp``
  33
  34
  35 Description
  36 ===========
  37
  38 To query the current audio input applications zero out the ``reserved``
  39 array of a struct :ref:`v4l2_audio <v4l2-audio>` and call the
  40 :ref:`VIDIOC_G_AUDIO <VIDIOC_G_AUDIO>` ioctl with a pointer to this structure. Drivers fill
  41 the rest of the structure or return an ``EINVAL`` error code when the device
  42 has no audio inputs, or none which combine with the current video input.
  43
  44 Audio inputs have one writable property, the audio mode. To select the
  45 current audio input *and* change the audio mode, applications initialize
  46 the ``index`` and ``mode`` fields, and the ``reserved`` array of a
  47 :ref:`struct v4l2_audio <v4l2-audio>` structure and call the :ref:`VIDIOC_S_AUDIO <VIDIOC_G_AUDIO>`
  48 ioctl. Drivers may switch to a different audio mode if the request
  49 cannot be satisfied. However, this is a write-only ioctl, it does not
  50 return the actual new audio mode.
  51
  52
  53 .. tabularcolumns:: |p{4.4cm}|p{4.4cm}|p{8.7cm}|
  54
  55 .. _v4l2-audio:
  56
  57 .. flat-table:: struct v4l2_audio
  58     :header-rows:  0
  59     :stub-columns: 0
  60     :widths:       1 1 2
  61
  62
  63     -  .. row 1
  64
  65        -  __u32
  66
  67        -  ``index``
  68
  69        -  Identifies the audio input, set by the driver or application.
  70
  71     -  .. row 2
  72
  73        -  __u8
  74
  75        -  ``name``\ [32]
  76
  77        -  Name of the audio input, a NUL-terminated ASCII string, for
  78           example: "Line In". This information is intended for the user,
  79           preferably the connector label on the device itself.
  80
  81     -  .. row 3
  82
  83        -  __u32
  84
  85        -  ``capability``
  86
  87        -  Audio capability flags, see :ref:`audio-capability`.
  88
  89     -  .. row 4
  90
  91        -  __u32
  92
  93        -  ``mode``
  94
  95        -  Audio mode flags set by drivers and applications (on
  96           :ref:`VIDIOC_S_AUDIO <VIDIOC_G_AUDIO>` ioctl), see :ref:`audio-mode`.
  97
  98     -  .. row 5
  99
 100        -  __u32
 101
 102        -  ``reserved``\ [2]
 103
 104        -  Reserved for future extensions. Drivers and applications must set
 105           the array to zero.
 106
 107
 108
 109 .. tabularcolumns:: |p{6.6cm}|p{2.2cm}|p{8.7cm}|
 110
 111 .. _audio-capability:
 112
 113 .. flat-table:: Audio Capability Flags
 114     :header-rows:  0
 115     :stub-columns: 0
 116     :widths:       3 1 4
 117
 118
 119     -  .. row 1
 120
 121        -  ``V4L2_AUDCAP_STEREO``
 122
 123        -  0x00001
 124
 125        -  This is a stereo input. The flag is intended to automatically
 126           disable stereo recording etc. when the signal is always monaural.
 127           The API provides no means to detect if stereo is *received*,
 128           unless the audio input belongs to a tuner.
 129
 130     -  .. row 2
 131
 132        -  ``V4L2_AUDCAP_AVL``
 133
 134        -  0x00002
 135
 136        -  Automatic Volume Level mode is supported.
 137
 138
 139
 140 .. tabularcolumns:: |p{6.6cm}|p{2.2cm}|p{8.7cm}|
 141
 142 .. _audio-mode:
 143
 144 .. flat-table:: Audio Mode Flags
 145     :header-rows:  0
 146     :stub-columns: 0
 147     :widths:       3 1 4
 148
 149
 150     -  .. row 1
 151
 152        -  ``V4L2_AUDMODE_AVL``
 153
 154        -  0x00001
 155
 156        -  AVL mode is on.
 157
 158
 159 Return Value
 160 ============
 161
 162 On success 0 is returned, on error -1 and the ``errno`` variable is set
 163 appropriately. The generic error codes are described at the
 164 :ref:`Generic Error Codes <gen-errors>` chapter.
 165
 166 EINVAL
 167     No audio inputs combine with the current video input, or the number
 168     of the selected audio input is out of bounds or it does not combine.