Mute control

This class is accessed via the mute property on a CamillaClient instance.

It provides methods for reading and setting the mute control.

class: Mute

Bases: _CommandGroup

Collection of methods for mute control

Source code in camilladsp/camilladsp.py

class Mute(_CommandGroup):
    """
    Collection of methods for mute control
    """

    def main(self) -> bool:
        """
        Get current main mute setting.
        Equivalent to calling `get_fader()` with `fader=0`.

        Returns:
            bool: True if muted, False otherwise.
        """
        mute = self.client.query("GetMute")
        return bool(mute)

    def set_main(self, value: bool):
        """
        Set main mute, true or false.
        Equivalent to calling `set_fader()` with `fader=0`.

        Args:
            value (bool): New mute setting.
        """
        self.client.query("SetMute", arg=bool(value))

    def fader(self, fader: int) -> bool:
        """
        Get current mute setting for a fader.

        Args:
            fader (int): Fader to read.
                Selected using an integer, 0 for `Main` and 1 to 4 for `Aux1` to `Aux4`.

        Returns:
            bool: True if muted, False otherwise.
        """
        _fader, mute = self.client.query("GetFaderMute", arg=int(fader))
        return bool(mute)

    def set_fader(self, fader: int, value: bool):
        """
        Set mute status for a fader, true or false.

        Args:
            fader (int): Fader to control.
                Selected using an integer, 0 for `Main` and 1 to 4 for `Aux1` to `Aux4`.
            value (bool): New mute setting.
        """
        self.client.query("SetFaderMute", arg=(int(fader), bool(value)))

    def toggle_fader(self, fader: int) -> bool:
        """
        Toggle mute status for a fader.

        Args:
            fader (int): Fader to control.
                Selected using an integer, 0 for `Main` and 1 to 4 for `Aux1` to `Aux4`.

        Returns:
            bool: True if the new status is muted, False otherwise.
        """
        _fader, new_mute = self.client.query("ToggleFaderMute", arg=int(fader))
        return new_mute

fader(fader)

Get current mute setting for a fader.

Parameters:

Name	Type	Description	Default
fader	int	Fader to read. Selected using an integer, 0 for Main and 1 to 4 for Aux1 to Aux4.	required

Returns:

Name	Type	Description
bool	bool	True if muted, False otherwise.

Source code in camilladsp/camilladsp.py

def fader(self, fader: int) -> bool:
    """
    Get current mute setting for a fader.

    Args:
        fader (int): Fader to read.
            Selected using an integer, 0 for `Main` and 1 to 4 for `Aux1` to `Aux4`.

    Returns:
        bool: True if muted, False otherwise.
    """
    _fader, mute = self.client.query("GetFaderMute", arg=int(fader))
    return bool(mute)

main()

Get current main mute setting. Equivalent to calling get_fader() with fader=0.

Returns:

Name	Type	Description
bool	bool	True if muted, False otherwise.

Source code in camilladsp/camilladsp.py

def main(self) -> bool:
    """
    Get current main mute setting.
    Equivalent to calling `get_fader()` with `fader=0`.

    Returns:
        bool: True if muted, False otherwise.
    """
    mute = self.client.query("GetMute")
    return bool(mute)

set_fader(fader, value)

Set mute status for a fader, true or false.

Parameters:

Name	Type	Description	Default
fader	int	Fader to control. Selected using an integer, 0 for Main and 1 to 4 for Aux1 to Aux4.	required
value	bool	New mute setting.	required

Source code in camilladsp/camilladsp.py

def set_fader(self, fader: int, value: bool):
    """
    Set mute status for a fader, true or false.

    Args:
        fader (int): Fader to control.
            Selected using an integer, 0 for `Main` and 1 to 4 for `Aux1` to `Aux4`.
        value (bool): New mute setting.
    """
    self.client.query("SetFaderMute", arg=(int(fader), bool(value)))

set_main(value)

Set main mute, true or false. Equivalent to calling set_fader() with fader=0.

Parameters:

Name	Type	Description	Default
value	bool	New mute setting.	required

Source code in camilladsp/camilladsp.py

def set_main(self, value: bool):
    """
    Set main mute, true or false.
    Equivalent to calling `set_fader()` with `fader=0`.

    Args:
        value (bool): New mute setting.
    """
    self.client.query("SetMute", arg=bool(value))

toggle_fader(fader)

Toggle mute status for a fader.

Parameters:

Name	Type	Description	Default
fader	int	Fader to control. Selected using an integer, 0 for Main and 1 to 4 for Aux1 to Aux4.	required

Returns:

Name	Type	Description
bool	bool	True if the new status is muted, False otherwise.

Source code in camilladsp/camilladsp.py

def toggle_fader(self, fader: int) -> bool:
    """
    Toggle mute status for a fader.

    Args:
        fader (int): Fader to control.
            Selected using an integer, 0 for `Main` and 1 to 4 for `Aux1` to `Aux4`.

    Returns:
        bool: True if the new status is muted, False otherwise.
    """
    _fader, new_mute = self.client.query("ToggleFaderMute", arg=int(fader))
    return new_mute