0001 .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
0002 .. c:namespace:: DTV.audio
0003
0004 .. _AUDIO_PAUSE:
0005
0006 ===========
0007 AUDIO_PAUSE
0008 ===========
0009
0010 Name
0011 ----
0012
0013 AUDIO_PAUSE
0014
0015 .. attention:: This ioctl is deprecated
0016
0017 Synopsis
0018 --------
0019
0020 .. c:macro:: AUDIO_PAUSE
0021
0022 ``int ioctl(int fd, AUDIO_PAUSE)``
0023
0024 Arguments
0025 ---------
0026
0027 .. flat-table::
0028 :header-rows: 0
0029 :stub-columns: 0
0030
0031 - .. row 1
0032
0033 - int fd
0034
0035 - File descriptor returned by a previous call to open().
0036
0037 Description
0038 -----------
0039
0040 This ioctl call suspends the audio stream being played. Decoding and
0041 playing are paused. It is then possible to restart again decoding and
0042 playing process of the audio stream using AUDIO_CONTINUE command.
0043
0044 Return Value
0045 ------------
0046
0047 On success 0 is returned, on error -1 and the ``errno`` variable is set
0048 appropriately. The generic error codes are described at the
0049 :ref:`Generic Error Codes <gen-errors>` chapter.
