audio-pause.rst 871 B

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950
  1. .. -*- coding: utf-8; mode: rst -*-
  2. .. _AUDIO_PAUSE:
  3. ===========
  4. AUDIO_PAUSE
  5. ===========
  6. Name
  7. ----
  8. AUDIO_PAUSE
  9. .. attention:: This ioctl is deprecated
  10. Synopsis
  11. --------
  12. .. c:function:: int ioctl(int fd, AUDIO_PAUSE)
  13. :name: AUDIO_PAUSE
  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 suspends the audio stream being played. Decoding and
  25. playing are paused. It is then possible to restart again decoding and
  26. playing process of the audio stream using AUDIO_CONTINUE command.
  27. Return Value
  28. ------------
  29. On success 0 is returned, on error -1 and the ``errno`` variable is set
  30. appropriately. The generic error codes are described at the
  31. :ref:`Generic Error Codes <gen-errors>` chapter.