aboutsummaryrefslogtreecommitdiffstats
path: root/Documentation/media/uapi/dvb/audio-pause.rst
blob: 9ca263e90c6c21df74dc1f8af4ddbbf7656a9acd (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
.. -*- coding: utf-8; mode: rst -*-

.. _AUDIO_PAUSE:

===========
AUDIO_PAUSE
===========

Name
----

AUDIO_PAUSE


Synopsis
--------

.. cpp:function:: int  ioctl(int fd, int request = AUDIO_PAUSE)


Arguments
---------

.. flat-table::
    :header-rows:  0
    :stub-columns: 0


    -  .. row 1

       -  int fd

       -  File descriptor returned by a previous call to open().

    -  .. row 2

       -  int request

       -  Equals AUDIO_PAUSE for this command.


Description
-----------

This ioctl call suspends the audio stream being played. Decoding and
playing are paused. It is then possible to restart again decoding and
playing process of the audio stream using AUDIO_CONTINUE command.


Return Value
------------

On success 0 is returned, on error -1 and the ``errno`` variable is set
appropriately. The generic error codes are described at the
:ref:`Generic Error Codes <gen-errors>` chapter.