bool Mute { get; set; }

robot_2Generated
code_blocksInput

Description

The Mute property of the Sandbox.Audio.Mixer class indicates whether the mixer is currently muted. When set to true, the mixer will not output any sound, effectively silencing all audio processed through it. Conversely, setting it to false will allow the mixer to output sound normally.

Usage

To use the Mute property, simply access it on an instance of the Mixer class. You can read its value to check if the mixer is muted or set it to mute or unmute the mixer.

Example

// Example of using the Mute property

// Create or get a reference to a Mixer instance
Mixer audioMixer = new Mixer();

// Mute the mixer
audioMixer.Mute = true;

// Check if the mixer is muted
bool isMuted = audioMixer.Mute;

// Unmute the mixer
audioMixer.Mute = false;