Class AudioBus¶
Namespace: Apogee.Audio
Assembly: Apogee.Audio.dll
A bus of the mix: a group of sounds with a volume, a mute and a pause of its own (Music, Vehicles, Environment, UI). See
public sealed class AudioBus : EngineObject
Inheritance¶
object ← EngineObject ← AudioBus
Inherited Members¶
EngineObject.IsAdopted, EngineObject.Handle, EngineObject.IsDestroyed, EngineObject.Class, EngineObject.Adopt(), EngineObject.TryGet(SlotHandle, out EngineObject), EngineObject.Destroy(), object.Equals(object?), object.Equals(object?, object?), object.GetHashCode(), object.GetType(), object.ReferenceEquals(object?, object?), object.ToString()
Properties¶
Class¶
What the registry knows about this object's class.
public override ClassInfo Class { get; }
Property Value¶
Muted¶
public bool Muted { get; set; }
Property Value¶
Name¶
public string Name { get; }
Property Value¶
Volume¶
The volume, 0 to 1 and above. The volume of the master bus is
public float Volume { get; set; }
Property Value¶
Methods¶
SetPaused(bool)¶
Pauses everything on the bus, and resumes it.
public void SetPaused(bool paused)
Parameters¶
paused bool
StopAll()¶
Stops everything on the bus.
public void StopAll()