xref: /OK3568_Linux_fs/kernel/Documentation/userspace-api/media/dvb/audio-set-mute.rst (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593Smuzhiyun.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
2*4882a593Smuzhiyun.. c:namespace:: DTV.audio
3*4882a593Smuzhiyun
4*4882a593Smuzhiyun.. _AUDIO_SET_MUTE:
5*4882a593Smuzhiyun
6*4882a593Smuzhiyun==============
7*4882a593SmuzhiyunAUDIO_SET_MUTE
8*4882a593Smuzhiyun==============
9*4882a593Smuzhiyun
10*4882a593SmuzhiyunName
11*4882a593Smuzhiyun----
12*4882a593Smuzhiyun
13*4882a593SmuzhiyunAUDIO_SET_MUTE
14*4882a593Smuzhiyun
15*4882a593Smuzhiyun.. attention:: This ioctl is deprecated
16*4882a593Smuzhiyun
17*4882a593SmuzhiyunSynopsis
18*4882a593Smuzhiyun--------
19*4882a593Smuzhiyun
20*4882a593Smuzhiyun.. c:macro:: AUDIO_SET_MUTE
21*4882a593Smuzhiyun
22*4882a593Smuzhiyun``int ioctl(int fd, AUDIO_SET_MUTE, boolean state)``
23*4882a593Smuzhiyun
24*4882a593SmuzhiyunArguments
25*4882a593Smuzhiyun---------
26*4882a593Smuzhiyun
27*4882a593Smuzhiyun.. flat-table::
28*4882a593Smuzhiyun    :header-rows:  0
29*4882a593Smuzhiyun    :stub-columns: 0
30*4882a593Smuzhiyun
31*4882a593Smuzhiyun    -
32*4882a593Smuzhiyun
33*4882a593Smuzhiyun       -  int fd
34*4882a593Smuzhiyun
35*4882a593Smuzhiyun       -  File descriptor returned by a previous call to open().
36*4882a593Smuzhiyun
37*4882a593Smuzhiyun    -
38*4882a593Smuzhiyun
39*4882a593Smuzhiyun       -  boolean state
40*4882a593Smuzhiyun
41*4882a593Smuzhiyun       -  Indicates if audio device shall mute or not.
42*4882a593Smuzhiyun
43*4882a593Smuzhiyun          TRUE: Audio Mute
44*4882a593Smuzhiyun
45*4882a593Smuzhiyun          FALSE: Audio Un-mute
46*4882a593Smuzhiyun
47*4882a593SmuzhiyunDescription
48*4882a593Smuzhiyun-----------
49*4882a593Smuzhiyun
50*4882a593SmuzhiyunThis ioctl is for Digital TV devices only. To control a V4L2 decoder use the
51*4882a593SmuzhiyunV4L2 :ref:`VIDIOC_DECODER_CMD` with the
52*4882a593Smuzhiyun``V4L2_DEC_CMD_START_MUTE_AUDIO`` flag instead.
53*4882a593Smuzhiyun
54*4882a593SmuzhiyunThis ioctl call asks the audio device to mute the stream that is
55*4882a593Smuzhiyuncurrently being played.
56*4882a593Smuzhiyun
57*4882a593SmuzhiyunReturn Value
58*4882a593Smuzhiyun------------
59*4882a593Smuzhiyun
60*4882a593SmuzhiyunOn success 0 is returned, on error -1 and the ``errno`` variable is set
61*4882a593Smuzhiyunappropriately. The generic error codes are described at the
62*4882a593Smuzhiyun:ref:`Generic Error Codes <gen-errors>` chapter.
63