1.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
2.. c:namespace:: DTV.audio
3
4.. _AUDIO_PAUSE:
5
6===========
7AUDIO_PAUSE
8===========
9
10Name
11----
12
13AUDIO_PAUSE
14
15.. attention:: This ioctl is deprecated
16
17Synopsis
18--------
19
20.. c:macro:: AUDIO_PAUSE
21
22``int ioctl(int fd, AUDIO_PAUSE)``
23
24Arguments
25---------
26
27.. flat-table::
28    :header-rows:  0
29    :stub-columns: 0
30
31    -  .. row 1
32
33       -  int fd
34
35       -  File descriptor returned by a previous call to open().
36
37Description
38-----------
39
40This ioctl call suspends the audio stream being played. Decoding and
41playing are paused. It is then possible to restart again decoding and
42playing process of the audio stream using AUDIO_CONTINUE command.
43
44Return Value
45------------
46
47On success 0 is returned, on error -1 and the ``errno`` variable is set
48appropriately. The generic error codes are described at the
49:ref:`Generic Error Codes <gen-errors>` chapter.
50