audio-set-bypass-mode.rst 1.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263
  1. .. -*- coding: utf-8; mode: rst -*-
  2. .. _AUDIO_SET_BYPASS_MODE:
  3. =====================
  4. AUDIO_SET_BYPASS_MODE
  5. =====================
  6. Name
  7. ----
  8. AUDIO_SET_BYPASS_MODE
  9. .. attention:: This ioctl is deprecated
  10. Synopsis
  11. --------
  12. .. c:function:: int ioctl(int fd, AUDIO_SET_BYPASS_MODE, boolean mode)
  13. :name: AUDIO_SET_BYPASS_MODE
  14. Arguments
  15. ---------
  16. .. flat-table::
  17. :header-rows: 0
  18. :stub-columns: 0
  19. -
  20. - int fd
  21. - File descriptor returned by a previous call to open().
  22. -
  23. - boolean mode
  24. - Enables or disables the decoding of the current Audio stream in
  25. the Digital TV subsystem.
  26. TRUE: Bypass is disabled
  27. FALSE: Bypass is enabled
  28. Description
  29. -----------
  30. This ioctl call asks the Audio Device to bypass the Audio decoder and
  31. forward the stream without decoding. This mode shall be used if streams
  32. that can’t be handled by the Digial TV system shall be decoded. Dolby
  33. DigitalTM streams are automatically forwarded by the Digital TV subsystem if
  34. the hardware can handle it.
  35. Return Value
  36. ------------
  37. On success 0 is returned, on error -1 and the ``errno`` variable is set
  38. appropriately. The generic error codes are described at the
  39. :ref:`Generic Error Codes <gen-errors>` chapter.