Documentation/media/uapi/dvb/audio-bilingual-channel-select.rst

   1 .. Permission is granted to copy, distribute and/or modify this
   2 .. document under the terms of the GNU Free Documentation License,
   3 .. Version 1.1 or any later version published by the Free Software
   4 .. Foundation, with no Invariant Sections, no Front-Cover Texts
   5 .. and no Back-Cover Texts. A copy of the license is included at
   6 .. Documentation/media/uapi/fdl-appendix.rst.
   7 ..
   8 .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections
   9
  10 .. _AUDIO_BILINGUAL_CHANNEL_SELECT:
  11
  12 ==============================
  13 AUDIO_BILINGUAL_CHANNEL_SELECT
  14 ==============================
  15
  16 Name
  17 ----
  18
  19 AUDIO_BILINGUAL_CHANNEL_SELECT
  20
  21 .. attention:: This ioctl is deprecated
  22
  23 Synopsis
  24 --------
  25
  26 .. c:function:: int ioctl(int fd, AUDIO_BILINGUAL_CHANNEL_SELECT, struct *audio_channel_select)
  27     :name: AUDIO_BILINGUAL_CHANNEL_SELECT
  28
  29
  30 Arguments
  31 ---------
  32
  33 .. flat-table::
  34     :header-rows:  0
  35     :stub-columns: 0
  36
  37     -
  38
  39        -  int fd
  40
  41        -  File descriptor returned by a previous call to open().
  42
  43     -
  44
  45        -  audio_channel_select_t ch
  46
  47        -  Select the output format of the audio (mono left/right, stereo).
  48
  49
  50 Description
  51 -----------
  52
  53 This ioctl is obsolete. Do not use in new drivers. It has been replaced
  54 by the V4L2 ``V4L2_CID_MPEG_AUDIO_DEC_MULTILINGUAL_PLAYBACK`` control
  55 for MPEG decoders controlled through V4L2.
  56
  57 This ioctl call asks the Audio Device to select the requested channel
  58 for bilingual streams if possible.
  59
  60
  61 Return Value
  62 ------------
  63
  64 On success 0 is returned, on error -1 and the ``errno`` variable is set
  65 appropriately. The generic error codes are described at the
  66 :ref:`Generic Error Codes <gen-errors>` chapter.