Commit | Line | Data |
---|---|---|
47d23e36 MCC |
1 | .. -*- coding: utf-8; mode: rst -*- |
2 | ||
3 | .. _AUDIO_SET_MUTE: | |
4 | ||
586027ce | 5 | ============== |
47d23e36 MCC |
6 | AUDIO_SET_MUTE |
7 | ============== | |
8 | ||
15e7d615 | 9 | Name |
586027ce | 10 | ---- |
47d23e36 | 11 | |
586027ce | 12 | AUDIO_SET_MUTE |
47d23e36 | 13 | |
cf8076c3 | 14 | .. attention:: This ioctl is deprecated |
15e7d615 MCC |
15 | |
16 | Synopsis | |
47d23e36 MCC |
17 | -------- |
18 | ||
cf8076c3 MCC |
19 | .. c:function:: int ioctl(int fd, AUDIO_SET_MUTE, boolean state) |
20 | :name: AUDIO_SET_MUTE | |
47d23e36 | 21 | |
47d23e36 | 22 | |
15e7d615 | 23 | Arguments |
586027ce | 24 | --------- |
47d23e36 MCC |
25 | |
26 | .. flat-table:: | |
27 | :header-rows: 0 | |
28 | :stub-columns: 0 | |
29 | ||
30 | ||
cf8076c3 | 31 | - |
47d23e36 MCC |
32 | |
33 | - int fd | |
34 | ||
35 | - File descriptor returned by a previous call to open(). | |
36 | ||
cf8076c3 | 37 | - |
47d23e36 MCC |
38 | |
39 | - boolean state | |
40 | ||
41 | - Indicates if audio device shall mute or not. | |
42 | ||
cf8076c3 | 43 | TRUE: Audio Mute |
47d23e36 | 44 | |
cf8076c3 | 45 | FALSE: Audio Un-mute |
47d23e36 MCC |
46 | |
47 | ||
15e7d615 | 48 | Description |
586027ce MCC |
49 | ----------- |
50 | ||
51 | This ioctl is for DVB devices only. To control a V4L2 decoder use the | |
52 | V4L2 :ref:`VIDIOC_DECODER_CMD` with the | |
53 | ``V4L2_DEC_CMD_START_MUTE_AUDIO`` flag instead. | |
54 | ||
55 | This ioctl call asks the audio device to mute the stream that is | |
56 | currently being played. | |
57 | ||
58 | ||
15e7d615 | 59 | Return Value |
47d23e36 MCC |
60 | ------------ |
61 | ||
62 | On success 0 is returned, on error -1 and the ``errno`` variable is set | |
63 | appropriately. The generic error codes are described at the | |
64 | :ref:`Generic Error Codes <gen-errors>` chapter. |