18c2ecf20Sopenharmony_ci.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
28c2ecf20Sopenharmony_ci.. c:namespace:: DTV.audio
38c2ecf20Sopenharmony_ci
48c2ecf20Sopenharmony_ci.. _AUDIO_SET_MUTE:
58c2ecf20Sopenharmony_ci
68c2ecf20Sopenharmony_ci==============
78c2ecf20Sopenharmony_ciAUDIO_SET_MUTE
88c2ecf20Sopenharmony_ci==============
98c2ecf20Sopenharmony_ci
108c2ecf20Sopenharmony_ciName
118c2ecf20Sopenharmony_ci----
128c2ecf20Sopenharmony_ci
138c2ecf20Sopenharmony_ciAUDIO_SET_MUTE
148c2ecf20Sopenharmony_ci
158c2ecf20Sopenharmony_ci.. attention:: This ioctl is deprecated
168c2ecf20Sopenharmony_ci
178c2ecf20Sopenharmony_ciSynopsis
188c2ecf20Sopenharmony_ci--------
198c2ecf20Sopenharmony_ci
208c2ecf20Sopenharmony_ci.. c:macro:: AUDIO_SET_MUTE
218c2ecf20Sopenharmony_ci
228c2ecf20Sopenharmony_ci``int ioctl(int fd, AUDIO_SET_MUTE, boolean state)``
238c2ecf20Sopenharmony_ci
248c2ecf20Sopenharmony_ciArguments
258c2ecf20Sopenharmony_ci---------
268c2ecf20Sopenharmony_ci
278c2ecf20Sopenharmony_ci.. flat-table::
288c2ecf20Sopenharmony_ci    :header-rows:  0
298c2ecf20Sopenharmony_ci    :stub-columns: 0
308c2ecf20Sopenharmony_ci
318c2ecf20Sopenharmony_ci    -
328c2ecf20Sopenharmony_ci
338c2ecf20Sopenharmony_ci       -  int fd
348c2ecf20Sopenharmony_ci
358c2ecf20Sopenharmony_ci       -  File descriptor returned by a previous call to open().
368c2ecf20Sopenharmony_ci
378c2ecf20Sopenharmony_ci    -
388c2ecf20Sopenharmony_ci
398c2ecf20Sopenharmony_ci       -  boolean state
408c2ecf20Sopenharmony_ci
418c2ecf20Sopenharmony_ci       -  Indicates if audio device shall mute or not.
428c2ecf20Sopenharmony_ci
438c2ecf20Sopenharmony_ci          TRUE: Audio Mute
448c2ecf20Sopenharmony_ci
458c2ecf20Sopenharmony_ci          FALSE: Audio Un-mute
468c2ecf20Sopenharmony_ci
478c2ecf20Sopenharmony_ciDescription
488c2ecf20Sopenharmony_ci-----------
498c2ecf20Sopenharmony_ci
508c2ecf20Sopenharmony_ciThis ioctl is for Digital TV devices only. To control a V4L2 decoder use the
518c2ecf20Sopenharmony_ciV4L2 :ref:`VIDIOC_DECODER_CMD` with the
528c2ecf20Sopenharmony_ci``V4L2_DEC_CMD_START_MUTE_AUDIO`` flag instead.
538c2ecf20Sopenharmony_ci
548c2ecf20Sopenharmony_ciThis ioctl call asks the audio device to mute the stream that is
558c2ecf20Sopenharmony_cicurrently being played.
568c2ecf20Sopenharmony_ci
578c2ecf20Sopenharmony_ciReturn Value
588c2ecf20Sopenharmony_ci------------
598c2ecf20Sopenharmony_ci
608c2ecf20Sopenharmony_ciOn success 0 is returned, on error -1 and the ``errno`` variable is set
618c2ecf20Sopenharmony_ciappropriately. The generic error codes are described at the
628c2ecf20Sopenharmony_ci:ref:`Generic Error Codes <gen-errors>` chapter.
63