tjh.dev
Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel
os
linux
1.. -*- coding: utf-8; mode: rst -*-
2
3.. _AUDIO_PAUSE:
4
5===========
6AUDIO_PAUSE
7===========
8
9Name
10----
11
12AUDIO_PAUSE
13
14
15Synopsis
16--------
17
18.. cpp:function:: int ioctl(int fd, int request = AUDIO_PAUSE)
19
20
21Arguments
22---------
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
42Description
43-----------
44
45This ioctl call suspends the audio stream being played. Decoding and
46playing are paused. It is then possible to restart again decoding and
47playing process of the audio stream using AUDIO_CONTINUE command.
48
49
50Return Value
51------------
52
53On success 0 is returned, on error -1 and the ``errno`` variable is set
54appropriately. The generic error codes are described at the
55:ref:`Generic Error Codes <gen-errors>` chapter.