| Mauro Carvalho Chehab | 47d23e3 | 2016-07-05 10:37:31 -0300 | [diff] [blame] | 1 | .. -*- coding: utf-8; mode: rst -*- |
| 2 | |
| 3 | .. _AUDIO_PAUSE: |
| 4 | |
| Mauro Carvalho Chehab | 586027c | 2016-07-05 07:58:48 -0300 | [diff] [blame] | 5 | =========== |
| Mauro Carvalho Chehab | 47d23e3 | 2016-07-05 10:37:31 -0300 | [diff] [blame] | 6 | AUDIO_PAUSE |
| 7 | =========== |
| 8 | |
| Mauro Carvalho Chehab | 15e7d61 | 2016-07-05 15:14:35 -0300 | [diff] [blame] | 9 | Name |
| Mauro Carvalho Chehab | 586027c | 2016-07-05 07:58:48 -0300 | [diff] [blame] | 10 | ---- |
| Mauro Carvalho Chehab | 47d23e3 | 2016-07-05 10:37:31 -0300 | [diff] [blame] | 11 | |
| Mauro Carvalho Chehab | 586027c | 2016-07-05 07:58:48 -0300 | [diff] [blame] | 12 | AUDIO_PAUSE |
| Mauro Carvalho Chehab | 47d23e3 | 2016-07-05 10:37:31 -0300 | [diff] [blame] | 13 | |
| Mauro Carvalho Chehab | cf8076c | 2016-08-19 16:56:15 -0300 | [diff] [blame] | 14 | .. attention:: This ioctl is deprecated |
| Mauro Carvalho Chehab | 15e7d61 | 2016-07-05 15:14:35 -0300 | [diff] [blame] | 15 | |
| 16 | Synopsis |
| Mauro Carvalho Chehab | 47d23e3 | 2016-07-05 10:37:31 -0300 | [diff] [blame] | 17 | -------- |
| 18 | |
| Mauro Carvalho Chehab | cf8076c | 2016-08-19 16:56:15 -0300 | [diff] [blame] | 19 | .. c:function:: int ioctl(int fd, AUDIO_PAUSE) |
| 20 | :name: AUDIO_PAUSE |
| Mauro Carvalho Chehab | 47d23e3 | 2016-07-05 10:37:31 -0300 | [diff] [blame] | 21 | |
| Mauro Carvalho Chehab | 15e7d61 | 2016-07-05 15:14:35 -0300 | [diff] [blame] | 22 | Arguments |
| Mauro Carvalho Chehab | 586027c | 2016-07-05 07:58:48 -0300 | [diff] [blame] | 23 | --------- |
| Mauro Carvalho Chehab | 47d23e3 | 2016-07-05 10:37:31 -0300 | [diff] [blame] | 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 | |
| Mauro Carvalho Chehab | 47d23e3 | 2016-07-05 10:37:31 -0300 | [diff] [blame] | 36 | |
| Mauro Carvalho Chehab | 15e7d61 | 2016-07-05 15:14:35 -0300 | [diff] [blame] | 37 | Description |
| Mauro Carvalho Chehab | 586027c | 2016-07-05 07:58:48 -0300 | [diff] [blame] | 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 | |
| Mauro Carvalho Chehab | 15e7d61 | 2016-07-05 15:14:35 -0300 | [diff] [blame] | 45 | Return Value |
| Mauro Carvalho Chehab | 47d23e3 | 2016-07-05 10:37:31 -0300 | [diff] [blame] | 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. |