• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1.. -*- coding: utf-8; mode: rst -*-
2
3.. _AUDIO_SET_MUTE:
4
5==============
6AUDIO_SET_MUTE
7==============
8
9Name
10----
11
12AUDIO_SET_MUTE
13
14.. attention:: This ioctl is deprecated
15
16Synopsis
17--------
18
19.. c:function:: int  ioctl(int fd, AUDIO_SET_MUTE, boolean state)
20    :name: AUDIO_SET_MUTE
21
22
23Arguments
24---------
25
26.. flat-table::
27    :header-rows:  0
28    :stub-columns: 0
29
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
47
48Description
49-----------
50
51This ioctl is for Digital TV devices only. To control a V4L2 decoder use the
52V4L2 :ref:`VIDIOC_DECODER_CMD` with the
53``V4L2_DEC_CMD_START_MUTE_AUDIO`` flag instead.
54
55This ioctl call asks the audio device to mute the stream that is
56currently being played.
57
58
59Return Value
60------------
61
62On success 0 is returned, on error -1 and the ``errno`` variable is set
63appropriately. The generic error codes are described at the
64:ref:`Generic Error Codes <gen-errors>` chapter.
65