Class UnitySoundMixerSettings

Unity ScriptableObject implementation for sound mixer configuration settings.
Defines Unity AudioMixer configuration including volume ranges, exposed parameters, and interface mappings.
Serves as the bridge between Unity's audio system and the domain layer abstraction.

Inheritance

object

UnitySoundMixerSettings

Implements

ISoundMixerSettings

IFoundationSettings

Namespace: Serenity.SoundMixer.Installation.Settings

Assembly: Serenity.UnitySoundMixer.Installation.dll

Syntax

public class UnitySoundMixerSettings : ScriptableObject, ISoundMixerSettings, IFoundationSettings

Constructors

UnitySoundMixerSettings(AudioMixer, int, int, float, float, List<ConfigurationEntry>)

Initializes a new instance of UnitySoundMixerSettings with comprehensive configuration.
Creates a settings object with all necessary parameters for audio mixer management.

Declaration

public UnitySoundMixerSettings(AudioMixer audioMixer, int minimumSelectableValue, int maximumSelectableValue, float lowestAudioMixerValue, float maximumAudioMixerValue, List<ConfigurationEntry> exposeParameters)

Parameters

Type	Name	Description
AudioMixer	audioMixer	The Unity AudioMixer asset to use
int	minimumSelectableValue	The minimum user-selectable volume value
int	maximumSelectableValue	The maximum user-selectable volume value
float	lowestAudioMixerValue	The lowest AudioMixer decibel value
float	maximumAudioMixerValue	The maximum AudioMixer decibel value
List<ConfigurationEntry>	exposeParameters	List of exposed parameter mappings

Fields

AudioMixer

Declaration

public AudioMixer AudioMixer

Field Value

Type	Description
AudioMixer	Gets or sets the Unity AudioMixer asset used for audio processing. This mixer contains the audio groups and exposed parameters that will be controlled by the service.

EffectLoops

Declaration

public List<UnitySoundMixerEffectLoopDefinition> EffectLoops

Field Value

Type	Description
List<UnitySoundMixerEffectLoopDefinition>	Registered effect loop definitions for this mixer (e.g. EchoLoop, CaveReverbLoop). Resolved at runtime by id when applying/clearing effect loops. Optional and backward compatible: may be empty; null entries are ignored by the service.

ExposedParameters

Declaration

public List<ConfigurationEntry> ExposedParameters

Field Value

Type	Description
List<ConfigurationEntry>	Gets or sets the list of exposed AudioMixer parameters. Contains key-value pairs mapping parameter names to game settings IDs for dynamic volume control.

Guid

Declaration

public string Guid

Field Value

Type	Description
string	Global unique identifier for this settings instance.

Id

Declaration

public string Id

Field Value

Type	Description
string	Unique identifier for this settings instance.

LowestAudioMixerValue

Declaration

public float LowestAudioMixerValue

Field Value

Type	Description
float	Gets or sets the lowest AudioMixer decibel value. Represents the minimum decibel level that corresponds to the lowest user-selectable value.

MaximumAudioMixerValue

Declaration

public float MaximumAudioMixerValue

Field Value

Type	Description
float	Gets or sets the maximum AudioMixer decibel value. Represents the maximum decibel level that corresponds to the highest user-selectable value.

MaximumSelectableValue

Declaration

public int MaximumSelectableValue

Field Value

Type	Description
int	Gets or sets the maximum user-selectable volume value. Represents the highest value users can select in UI controls (typically 10 or 100).

MinimumSelectableValue

Declaration

public int MinimumSelectableValue

Field Value

Type	Description
int	Gets or sets the minimum user-selectable volume value. Represents the lowest value users can select in UI controls (typically 0).

Implements

ISoundMixerSettings

IFoundationSettings