Documentation/media/uapi/dvb/audio-set-bypass-mode.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_SET_BYPASS_MODE:
  11
  12 =====================
  13 AUDIO_SET_BYPASS_MODE
  14 =====================
  15
  16 Name
  17 ----
  18
  19 AUDIO_SET_BYPASS_MODE
  20
  21 .. attention:: This ioctl is deprecated
  22
  23 Synopsis
  24 --------
  25
  26 .. c:function:: int ioctl(int fd, AUDIO_SET_BYPASS_MODE, boolean mode)
  27     :name: AUDIO_SET_BYPASS_MODE
  28
  29 Arguments
  30 ---------
  31
  32 .. flat-table::
  33     :header-rows:  0
  34     :stub-columns: 0
  35
  36
  37     -
  38
  39        -  int fd
  40
  41        -  File descriptor returned by a previous call to open().
  42
  43     -
  44
  45        -  boolean mode
  46
  47        -  Enables or disables the decoding of the current Audio stream in
  48           the Digital TV subsystem.
  49
  50           TRUE: Bypass is disabled
  51
  52           FALSE: Bypass is enabled
  53
  54
  55 Description
  56 -----------
  57
  58 This ioctl call asks the Audio Device to bypass the Audio decoder and
  59 forward the stream without decoding. This mode shall be used if streams
  60 that can’t be handled by the Digital TV system shall be decoded. Dolby
  61 DigitalTM streams are automatically forwarded by the Digital TV subsystem if
  62 the hardware can handle it.
  63
  64
  65 Return Value
  66 ------------
  67
  68 On success 0 is returned, on error -1 and the ``errno`` variable is set
  69 appropriately. The generic error codes are described at the
  70 :ref:`Generic Error Codes <gen-errors>` chapter.