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