audio-clear-buffer.rst 824 B

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748
  1. .. -*- coding: utf-8; mode: rst -*-
  2. .. _AUDIO_CLEAR_BUFFER:
  3. ==================
  4. AUDIO_CLEAR_BUFFER
  5. ==================
  6. Name
  7. ----
  8. AUDIO_CLEAR_BUFFER
  9. .. attention:: This ioctl is deprecated
  10. Synopsis
  11. --------
  12. .. c:function:: int ioctl(int fd, AUDIO_CLEAR_BUFFER)
  13. :name: AUDIO_CLEAR_BUFFER
  14. Arguments
  15. ---------
  16. .. flat-table::
  17. :header-rows: 0
  18. :stub-columns: 0
  19. - .. row 1
  20. - int fd
  21. - File descriptor returned by a previous call to open().
  22. Description
  23. -----------
  24. This ioctl call asks the Audio Device to clear all software and hardware
  25. buffers of the audio decoder device.
  26. Return Value
  27. ------------
  28. On success 0 is returned, on error -1 and the ``errno`` variable is set
  29. appropriately. The generic error codes are described at the
  30. :ref:`Generic Error Codes <gen-errors>` chapter.