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

   1 .. -*- coding: utf-8; mode: rst -*-
   2
   3 .. _VIDIOC_G_AUDOUT:
   4
   5 **************************************
   6 ioctl VIDIOC_G_AUDOUT, VIDIOC_S_AUDOUT
   7 **************************************
   8
   9 Name
  10 ====
  11
  12 VIDIOC_G_AUDOUT - VIDIOC_S_AUDOUT - Query or select the current audio output
  13
  14
  15 Synopsis
  16 ========
  17
  18 .. cpp:function:: int ioctl( int fd, int request, struct v4l2_audioout *argp )
  19
  20 .. cpp:function:: int ioctl( int fd, int request, const struct v4l2_audioout *argp )
  21
  22
  23 Arguments
  24 =========
  25
  26 ``fd``
  27     File descriptor returned by :ref:`open() <func-open>`.
  28
  29 ``request``
  30     VIDIOC_G_AUDOUT, VIDIOC_S_AUDOUT
  31
  32 ``argp``
  33
  34
  35 Description
  36 ===========
  37
  38 To query the current audio output applications zero out the ``reserved``
  39 array of a struct :ref:`v4l2_audioout <v4l2-audioout>` and call the
  40 ``VIDIOC_G_AUDOUT`` 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
  43 output.
  44
  45 Audio outputs have no writable properties. Nevertheless, to select the
  46 current audio output applications can initialize the ``index`` field and
  47 ``reserved`` array (which in the future may contain writable properties)
  48 of a :ref:`struct v4l2_audioout <v4l2-audioout>` structure and call the
  49 ``VIDIOC_S_AUDOUT`` ioctl. Drivers switch to the requested output or
  50 return the ``EINVAL`` error code when the index is out of bounds. This is a
  51 write-only ioctl, it does not return the current audio output attributes
  52 as ``VIDIOC_G_AUDOUT`` does.
  53
  54 .. note:: Connectors on a TV card to loop back the received audio signal
  55    to a sound card are not audio outputs in this sense.
  56
  57
  58 .. _v4l2-audioout:
  59
  60 .. flat-table:: struct v4l2_audioout
  61     :header-rows:  0
  62     :stub-columns: 0
  63     :widths:       1 1 2
  64
  65
  66     -  .. row 1
  67
  68        -  __u32
  69
  70        -  ``index``
  71
  72        -  Identifies the audio output, set by the driver or application.
  73
  74     -  .. row 2
  75
  76        -  __u8
  77
  78        -  ``name``\ [32]
  79
  80        -  Name of the audio output, a NUL-terminated ASCII string, for
  81           example: "Line Out". This information is intended for the user,
  82           preferably the connector label on the device itself.
  83
  84     -  .. row 3
  85
  86        -  __u32
  87
  88        -  ``capability``
  89
  90        -  Audio capability flags, none defined yet. Drivers must set this
  91           field to zero.
  92
  93     -  .. row 4
  94
  95        -  __u32
  96
  97        -  ``mode``
  98
  99        -  Audio mode, none defined yet. Drivers and applications (on
 100           ``VIDIOC_S_AUDOUT``) must set this field to zero.
 101
 102     -  .. row 5
 103
 104        -  __u32
 105
 106        -  ``reserved``\ [2]
 107
 108        -  Reserved for future extensions. Drivers and applications must set
 109           the array to zero.
 110
 111
 112 Return Value
 113 ============
 114
 115 On success 0 is returned, on error -1 and the ``errno`` variable is set
 116 appropriately. The generic error codes are described at the
 117 :ref:`Generic Error Codes <gen-errors>` chapter.
 118
 119 EINVAL
 120     No audio outputs combine with the current video output, or the
 121     number of the selected audio output is out of bounds or it does not
 122     combine.