54f38fcae5
Since 2017, there is an space reserved for userspace API,
created by changeset 1d596dee38 ("docs: Create a user-space API guide").
As the media subsystem was one of the first subsystems to use
Sphinx, until this patch, we were keeping things on a separate
place.
Let's just use the new location, as having all uAPI altogether
will likely make things easier for developers.
Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
72 lines
1.5 KiB
ReStructuredText
72 lines
1.5 KiB
ReStructuredText
.. Permission is granted to copy, distribute and/or modify this
|
|
.. document under the terms of the GNU Free Documentation License,
|
|
.. Version 1.1 or any later version published by the Free Software
|
|
.. Foundation, with no Invariant Sections, no Front-Cover Texts
|
|
.. and no Back-Cover Texts. A copy of the license is included at
|
|
.. Documentation/userspace-api/media/fdl-appendix.rst.
|
|
..
|
|
.. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections
|
|
|
|
.. _AUDIO_SET_MUTE:
|
|
|
|
==============
|
|
AUDIO_SET_MUTE
|
|
==============
|
|
|
|
Name
|
|
----
|
|
|
|
AUDIO_SET_MUTE
|
|
|
|
.. attention:: This ioctl is deprecated
|
|
|
|
Synopsis
|
|
--------
|
|
|
|
.. c:function:: int ioctl(int fd, AUDIO_SET_MUTE, boolean state)
|
|
:name: AUDIO_SET_MUTE
|
|
|
|
|
|
Arguments
|
|
---------
|
|
|
|
.. flat-table::
|
|
:header-rows: 0
|
|
:stub-columns: 0
|
|
|
|
|
|
-
|
|
|
|
- int fd
|
|
|
|
- File descriptor returned by a previous call to open().
|
|
|
|
-
|
|
|
|
- boolean state
|
|
|
|
- Indicates if audio device shall mute or not.
|
|
|
|
TRUE: Audio Mute
|
|
|
|
FALSE: Audio Un-mute
|
|
|
|
|
|
Description
|
|
-----------
|
|
|
|
This ioctl is for Digital TV devices only. To control a V4L2 decoder use the
|
|
V4L2 :ref:`VIDIOC_DECODER_CMD` with the
|
|
``V4L2_DEC_CMD_START_MUTE_AUDIO`` flag instead.
|
|
|
|
This ioctl call asks the audio device to mute the stream that is
|
|
currently being played.
|
|
|
|
|
|
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.
|