projects / deliverable / linux.git / blame
| 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 | |
| 15e7d615 MCC |
14 | |
| 15 | Synopsis | |
| 47d23e36 MCC |
16 | -------- |
| 17 | ||
| 5929cb17 | 18 | .. cpp:function:: int ioctl(int fd, int request = AUDIO_PAUSE) |
| 47d23e36 | 19 | |
| 47d23e36 | 20 | |
| 15e7d615 | 21 | Arguments |
| 586027ce | 22 | --------- |
| 47d23e36 MCC |
23 | |
| 24 | .. flat-table:: | |
| 25 | :header-rows: 0 | |
| 26 | :stub-columns: 0 | |
| 27 | ||
| 28 | ||
| 29 | - .. row 1 | |
| 30 | ||
| 31 | - int fd | |
| 32 | ||
| 33 | - File descriptor returned by a previous call to open(). | |
| 34 | ||
| 35 | - .. row 2 | |
| 36 | ||
| 37 | - int request | |
| 38 | ||
| 39 | - Equals AUDIO_PAUSE for this command. | |
| 40 | ||
| 41 | ||
| 15e7d615 | 42 | Description |
| 586027ce MCC |
43 | ----------- |
| 44 | ||
| 45 | This ioctl call suspends the audio stream being played. Decoding and | |
| 46 | playing are paused. It is then possible to restart again decoding and | |
| 47 | playing process of the audio stream using AUDIO_CONTINUE command. | |
| 48 | ||
| 49 | ||
| 15e7d615 | 50 | Return Value |
| 47d23e36 MCC |
51 | ------------ |
| 52 | ||
| 53 | On success 0 is returned, on error -1 and the ``errno`` variable is set | |
| 54 | appropriately. The generic error codes are described at the | |
| 55 | :ref:`Generic Error Codes <gen-errors>` chapter. |