forked from Minki/linux
cf8076c314
Name all ioctl references and make them match the ioctls that are documented. That will improve the cross-reference index, as it will have all ioctls and syscalls there. While here, improve the documentation, marking the deprecated ioctls, and making the non-deprecated ones more like the rest of the media book. Also, add a notice for ioctls that still require documentation. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
51 lines
871 B
ReStructuredText
51 lines
871 B
ReStructuredText
.. -*- coding: utf-8; mode: rst -*-
|
|
|
|
.. _AUDIO_PAUSE:
|
|
|
|
===========
|
|
AUDIO_PAUSE
|
|
===========
|
|
|
|
Name
|
|
----
|
|
|
|
AUDIO_PAUSE
|
|
|
|
.. attention:: This ioctl is deprecated
|
|
|
|
Synopsis
|
|
--------
|
|
|
|
.. c:function:: int ioctl(int fd, AUDIO_PAUSE)
|
|
:name: 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.
|