1.. Permission is granted to copy, distribute and/or modify this 2.. document under the terms of the GNU Free Documentation License, 3.. Version 1.1 or any later version published by the Free Software 4.. Foundation, with no Invariant Sections, no Front-Cover Texts 5.. and no Back-Cover Texts. A copy of the license is included at 6.. Documentation/media/uapi/fdl-appendix.rst. 7.. 8.. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections 9 10.. _AUDIO_PAUSE: 11 12=========== 13AUDIO_PAUSE 14=========== 15 16Name 17---- 18 19AUDIO_PAUSE 20 21.. attention:: This ioctl is deprecated 22 23Synopsis 24-------- 25 26.. c:function:: int ioctl(int fd, AUDIO_PAUSE) 27 :name: AUDIO_PAUSE 28 29Arguments 30--------- 31 32.. flat-table:: 33 :header-rows: 0 34 :stub-columns: 0 35 36 37 - .. row 1 38 39 - int fd 40 41 - File descriptor returned by a previous call to open(). 42 43 44Description 45----------- 46 47This ioctl call suspends the audio stream being played. Decoding and 48playing are paused. It is then possible to restart again decoding and 49playing process of the audio stream using AUDIO_CONTINUE command. 50 51 52Return Value 53------------ 54 55On success 0 is returned, on error -1 and the ``errno`` variable is set 56appropriately. The generic error codes are described at the 57:ref:`Generic Error Codes <gen-errors>` chapter. 58