DarkTonic.MasterAudio.MasterAudioGroup Class Reference

This class contains settings for the basic sound effects unit in Master Audio, known on the Sound Group. More...

Inheritance diagram for DarkTonic.MasterAudio.MasterAudioGroup:

Properties
int	ActiveVoices [get]
	This property will return the number of Activate voices in this Sound Group. More...
int	AddressableUnusedSecondsLifespan [get]
	This property will return the number of seconds the unused Addressable (if this Variation uses Addressables) will wait before being released from memory. More...
int	TotalVoices [get]
	This property will return the total number of voices available in this Sound Group. More...
bool	WillCleanUpDelegatesAfterStop [set]
	This property can be set to false to cancel the auto-delegate cleanup on all Variations in this Sound Group. So if you subscribe to SoundFinished, you will get notified of all times it finishes until you unsubscribe. More...
GroupBus	BusForGroup [get]
	This property will return the Bus for the Sound Group, if any is assigned. More...
float	OriginalVolume [get, set]
	This property will return the original volume of the Sound Group. More...

Events
System.Action	LastVariationFinishedPlay
	Subscribe to this event to be notified when the last Variation stops playing (i.e. zero Variations are playing) More...

Detailed Description

This class contains settings for the basic sound effects unit in Master Audio, known on the Sound Group.

Property Documentation

int DarkTonic.MasterAudio.MasterAudioGroup.ActiveVoices

get

This property will return the number of Activate voices in this Sound Group.

int DarkTonic.MasterAudio.MasterAudioGroup.AddressableUnusedSecondsLifespan

get

This property will return the number of seconds the unused Addressable (if this Variation uses Addressables) will wait before being released from memory.

GroupBus DarkTonic.MasterAudio.MasterAudioGroup.BusForGroup

get

This property will return the Bus for the Sound Group, if any is assigned.

float DarkTonic.MasterAudio.MasterAudioGroup.OriginalVolume

getset

This property will return the original volume of the Sound Group.

int DarkTonic.MasterAudio.MasterAudioGroup.TotalVoices

get

This property will return the total number of voices available in this Sound Group.

bool DarkTonic.MasterAudio.MasterAudioGroup.WillCleanUpDelegatesAfterStop

set

This property can be set to false to cancel the auto-delegate cleanup on all Variations in this Sound Group. So if you subscribe to SoundFinished, you will get notified of all times it finishes until you unsubscribe.

Event Documentation

System.Action DarkTonic.MasterAudio.MasterAudioGroup.LastVariationFinishedPlay

Subscribe to this event to be notified when the last Variation stops playing (i.e. zero Variations are playing)

---

The documentation for this class was generated from the following file:

• Assets/Plugins/DarkTonic/MasterAudio/Scripts/Settings/MasterAudioGroup.cs