Documentation/media/uapi/dvb/audio-set-bypass-mode.rst

   1 .. -*- coding: utf-8; mode: rst -*-
   2
   3 .. _AUDIO_SET_BYPASS_MODE:
   4
   5 =====================
   6 AUDIO_SET_BYPASS_MODE
   7 =====================
   8
   9 Name
  10 ----
  11
  12 AUDIO_SET_BYPASS_MODE
  13
  14 .. attention:: This ioctl is deprecated
  15
  16 Synopsis
  17 --------
  18
  19 .. c:function:: int ioctl(int fd, AUDIO_SET_BYPASS_MODE, boolean mode)
  20     :name: AUDIO_SET_BYPASS_MODE
  21
  22 Arguments
  23 ---------
  24
  25 .. flat-table::
  26     :header-rows:  0
  27     :stub-columns: 0
  28
  29
  30     -
  31
  32        -  int fd
  33
  34        -  File descriptor returned by a previous call to open().
  35
  36     -
  37
  38        -  boolean mode
  39
  40        -  Enables or disables the decoding of the current Audio stream in
  41           the DVB subsystem.
  42
  43           TRUE: Bypass is disabled
  44
  45           FALSE: Bypass is enabled
  46
  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 DVB system shall be decoded. Dolby
  54 DigitalTM streams are automatically forwarded by the DVB subsystem if
  55 the hardware can handle it.
  56
  57
  58 Return Value
  59 ------------
  60
  61 On success 0 is returned, on error -1 and the ``errno`` variable is set
  62 appropriately. The generic error codes are described at the
  63 :ref:`Generic Error Codes <gen-errors>` chapter.