Back to home page

OSCL-LXR

 
 

    


0001 .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
0002 .. c:namespace:: DTV.audio
0003 
0004 .. _AUDIO_SET_BYPASS_MODE:
0005 
0006 =====================
0007 AUDIO_SET_BYPASS_MODE
0008 =====================
0009 
0010 Name
0011 ----
0012 
0013 AUDIO_SET_BYPASS_MODE
0014 
0015 .. attention:: This ioctl is deprecated
0016 
0017 Synopsis
0018 --------
0019 
0020 .. c:macro:: AUDIO_SET_BYPASS_MODE
0021 
0022 ``int ioctl(int fd, AUDIO_SET_BYPASS_MODE, boolean mode)``
0023 
0024 Arguments
0025 ---------
0026 
0027 .. flat-table::
0028     :header-rows:  0
0029     :stub-columns: 0
0030 
0031     -
0032 
0033        -  int fd
0034 
0035        -  File descriptor returned by a previous call to open().
0036 
0037     -
0038 
0039        -  boolean mode
0040 
0041        -  Enables or disables the decoding of the current Audio stream in
0042           the Digital TV subsystem.
0043 
0044           TRUE: Bypass is disabled
0045 
0046           FALSE: Bypass is enabled
0047 
0048 Description
0049 -----------
0050 
0051 This ioctl call asks the Audio Device to bypass the Audio decoder and
0052 forward the stream without decoding. This mode shall be used if streams
0053 that can't be handled by the Digital TV system shall be decoded. Dolby
0054 DigitalTM streams are automatically forwarded by the Digital TV subsystem if
0055 the hardware can handle it.
0056 
0057 Return Value
0058 ------------
0059 
0060 On success 0 is returned, on error -1 and the ``errno`` variable is set
0061 appropriately. The generic error codes are described at the
0062 :ref:`Generic Error Codes <gen-errors>` chapter.