1.. -*- coding: utf-8; mode: rst -*-
2
3.. _AUDIO_PAUSE:
4
5===========
6AUDIO_PAUSE
7===========
8
9Name
10----
11
12AUDIO_PAUSE
13
14.. attention:: This ioctl is deprecated
15
16Synopsis
17--------
18
19.. c:function:: int  ioctl(int fd, AUDIO_PAUSE)
20    :name: AUDIO_PAUSE
21
22Arguments
23---------
24
25.. flat-table::
26    :header-rows:  0
27    :stub-columns: 0
28
29
30    -  .. row 1
31
32       -  int fd
33
34       -  File descriptor returned by a previous call to open().
35
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
44
45Return Value
46------------
47
48On success 0 is returned, on error -1 and the ``errno`` variable is set
49appropriately. The generic error codes are described at the
50:ref:`Generic Error Codes <gen-errors>` chapter.
51