tjh.dev
Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel
os
linux
1.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
2.. c:namespace:: DTV.audio
3
4.. _AUDIO_SET_MUTE:
5
6==============
7AUDIO_SET_MUTE
8==============
9
10Name
11----
12
13AUDIO_SET_MUTE
14
15.. attention:: This ioctl is deprecated
16
17Synopsis
18--------
19
20.. c:macro:: AUDIO_SET_MUTE
21
22``int ioctl(int fd, AUDIO_SET_MUTE, boolean state)``
23
24Arguments
25---------
26
27.. flat-table::
28 :header-rows: 0
29 :stub-columns: 0
30
31 -
32
33 - int fd
34
35 - File descriptor returned by a previous call to open().
36
37 -
38
39 - boolean state
40
41 - Indicates if audio device shall mute or not.
42
43 TRUE: Audio Mute
44
45 FALSE: Audio Un-mute
46
47Description
48-----------
49
50This ioctl is for Digital TV devices only. To control a V4L2 decoder use the
51V4L2 :ref:`VIDIOC_DECODER_CMD` with the
52``V4L2_DEC_CMD_START_MUTE_AUDIO`` flag instead.
53
54This ioctl call asks the audio device to mute the stream that is
55currently being played.
56
57Return Value
58------------
59
60On success 0 is returned, on error -1 and the ``errno`` variable is set
61appropriately. The generic error codes are described at the
62:ref:`Generic Error Codes <gen-errors>` chapter.