0001 .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
0002 .. c:namespace:: DTV.audio
0003
0004 .. _AUDIO_SET_MUTE:
0005
0006 ==============
0007 AUDIO_SET_MUTE
0008 ==============
0009
0010 Name
0011 ----
0012
0013 AUDIO_SET_MUTE
0014
0015 .. attention:: This ioctl is deprecated
0016
0017 Synopsis
0018 --------
0019
0020 .. c:macro:: AUDIO_SET_MUTE
0021
0022 ``int ioctl(int fd, AUDIO_SET_MUTE, boolean state)``
0023
0024 Arguments
0025 ---------
0026
0027 .. flat-table::
0028 :header-rows: 0
0029 :stub-columns: 0
0030
0031 -
0032
0033 - int fd
0034
0035 - File descriptor returned by a previous call to open().
0036
0037 -
0038
0039 - boolean state
0040
0041 - Indicates if audio device shall mute or not.
0042
0043 TRUE: Audio Mute
0044
0045 FALSE: Audio Un-mute
0046
0047 Description
0048 -----------
0049
0050 This ioctl is for Digital TV devices only. To control a V4L2 decoder use the
0051 V4L2 :ref:`VIDIOC_DECODER_CMD` with the
0052 ``V4L2_DEC_CMD_START_MUTE_AUDIO`` flag instead.
0053
0054 This ioctl call asks the audio device to mute the stream that is
0055 currently being played.
0056
0057 Return Value
0058 ------------
0059
0060 On success 0 is returned, on error -1 and the ``errno`` variable is set
0061 appropriately. The generic error codes are described at the
0062 :ref:`Generic Error Codes <gen-errors>` chapter.
