Commit | Line | Data |
---|---|---|
47d23e36 MCC |
1 | .. -*- coding: utf-8; mode: rst -*- |
2 | ||
3 | .. _AUDIO_PAUSE: | |
4 | ||
586027ce | 5 | =========== |
47d23e36 MCC |
6 | AUDIO_PAUSE |
7 | =========== | |
8 | ||
15e7d615 | 9 | Name |
586027ce | 10 | ---- |
47d23e36 | 11 | |
586027ce | 12 | AUDIO_PAUSE |
47d23e36 | 13 | |
cf8076c3 | 14 | .. attention:: This ioctl is deprecated |
15e7d615 MCC |
15 | |
16 | Synopsis | |
47d23e36 MCC |
17 | -------- |
18 | ||
cf8076c3 MCC |
19 | .. c:function:: int ioctl(int fd, AUDIO_PAUSE) |
20 | :name: AUDIO_PAUSE | |
47d23e36 | 21 | |
15e7d615 | 22 | Arguments |
586027ce | 23 | --------- |
47d23e36 MCC |
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 | ||
47d23e36 | 36 | |
15e7d615 | 37 | Description |
586027ce MCC |
38 | ----------- |
39 | ||
40 | This ioctl call suspends the audio stream being played. Decoding and | |
41 | playing are paused. It is then possible to restart again decoding and | |
42 | playing process of the audio stream using AUDIO_CONTINUE command. | |
43 | ||
44 | ||
15e7d615 | 45 | Return Value |
47d23e36 MCC |
46 | ------------ |
47 | ||
48 | On success 0 is returned, on error -1 and the ``errno`` variable is set | |
49 | appropriately. The generic error codes are described at the | |
50 | :ref:`Generic Error Codes <gen-errors>` chapter. |