audio-set-mute.rst

.. -*- coding: utf-8; mode: rst -*-

.. _AUDIO_SET_MUTE:

==============
AUDIO_SET_MUTE
==============

NAME
----

AUDIO_SET_MUTE

SYNOPSIS
--------

.. c:function:: int  ioctl(int fd, int request = AUDIO_SET_MUTE, boolean state)


ARGUMENTS
---------

.. flat-table::
    :header-rows:  0
    :stub-columns: 0


    -  .. row 1

       -  int fd

       -  File descriptor returned by a previous call to open().

    -  .. row 2

       -  int request

       -  Equals AUDIO_SET_MUTE for this command.

    -  .. row 3

       -  boolean state

       -  Indicates if audio device shall mute or not.

    -  .. row 4

       -
       -  TRUE Audio Mute

    -  .. row 5

       -
       -  FALSE Audio Un-mute


DESCRIPTION
-----------

This ioctl is for DVB devices only. To control a V4L2 decoder use the
V4L2 :ref:`VIDIOC_DECODER_CMD` with the
``V4L2_DEC_CMD_START_MUTE_AUDIO`` flag instead.

This ioctl call asks the audio device to mute the stream that is
currently being played.


RETURN VALUE
------------

On success 0 is returned, on error -1 and the ``errno`` variable is set
appropriately. The generic error codes are described at the
:ref:`Generic Error Codes <gen-errors>` chapter.