Documentation/userspace-api/media/dvb/audio-set-bypass-mode.rst

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