forked from Qortal/Brooklyn
50 lines
909 B
ReStructuredText
50 lines
909 B
ReStructuredText
.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
|
|
.. c:namespace:: DTV.audio
|
|
|
|
.. _AUDIO_PAUSE:
|
|
|
|
===========
|
|
AUDIO_PAUSE
|
|
===========
|
|
|
|
Name
|
|
----
|
|
|
|
AUDIO_PAUSE
|
|
|
|
.. attention:: This ioctl is deprecated
|
|
|
|
Synopsis
|
|
--------
|
|
|
|
.. c:macro:: AUDIO_PAUSE
|
|
|
|
``int ioctl(int fd, AUDIO_PAUSE)``
|
|
|
|
Arguments
|
|
---------
|
|
|
|
.. flat-table::
|
|
:header-rows: 0
|
|
:stub-columns: 0
|
|
|
|
- .. row 1
|
|
|
|
- int fd
|
|
|
|
- File descriptor returned by a previous call to open().
|
|
|
|
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.
|