Documentation/media/uapi/dvb/audio-set-mute.rst

   1 .. Permission is granted to copy, distribute and/or modify this
   2 .. document under the terms of the GNU Free Documentation License,
   3 .. Version 1.1 or any later version published by the Free Software
   4 .. Foundation, with no Invariant Sections, no Front-Cover Texts
   5 .. and no Back-Cover Texts. A copy of the license is included at
   6 .. Documentation/media/uapi/fdl-appendix.rst.
   7 ..
   8 .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections
   9
  10 .. _AUDIO_SET_MUTE:
  11
  12 ==============
  13 AUDIO_SET_MUTE
  14 ==============
  15
  16 Name
  17 ----
  18
  19 AUDIO_SET_MUTE
  20
  21 .. attention:: This ioctl is deprecated
  22
  23 Synopsis
  24 --------
  25
  26 .. c:function:: int  ioctl(int fd, AUDIO_SET_MUTE, boolean state)
  27     :name: AUDIO_SET_MUTE
  28
  29
  30 Arguments
  31 ---------
  32
  33 .. flat-table::
  34     :header-rows:  0
  35     :stub-columns: 0
  36
  37
  38     -
  39
  40        -  int fd
  41
  42        -  File descriptor returned by a previous call to open().
  43
  44     -
  45
  46        -  boolean state
  47
  48        -  Indicates if audio device shall mute or not.
  49
  50           TRUE: Audio Mute
  51
  52           FALSE: Audio Un-mute
  53
  54
  55 Description
  56 -----------
  57
  58 This ioctl is for Digital TV devices only. To control a V4L2 decoder use the
  59 V4L2 :ref:`VIDIOC_DECODER_CMD` with the
  60 ``V4L2_DEC_CMD_START_MUTE_AUDIO`` flag instead.
  61
  62 This ioctl call asks the audio device to mute the stream that is
  63 currently being played.
  64
  65
  66 Return Value
  67 ------------
  68
  69 On success 0 is returned, on error -1 and the ``errno`` variable is set
  70 appropriately. The generic error codes are described at the
  71 :ref:`Generic Error Codes <gen-errors>` chapter.