Table of Contents

Class SoundManager

Namespace
CodeBase.SoundSystem
Assembly
4Experience.CodeBase.SoundSystem.Runtime.dll
public class SoundManager : SingletonMonoBehaviour<SoundManager>
Inheritance
Object
Component
Behaviour
MonoBehaviour
SoundManager
Inherited Members
Extension Methods

Fields

IS_MUTED_ALL_SAVE_KEY

private const string IS_MUTED_ALL_SAVE_KEY = "SoundSystem_IsMutedAll"

Field Value

string

Properties

AudioSourceGroupDataCollection

private List<AudioSourceGroupData> AudioSourceGroupDataCollection { get; set; }

Property Value

List<AudioSourceGroupData>

CachedAudioMixerGroup

private AudioMixerGroup CachedAudioMixerGroup { get; set; }

Property Value

AudioMixerGroup

CachedAudioSourceGroupData

private AudioSourceGroupData CachedAudioSourceGroupData { get; set; }

Property Value

AudioSourceGroupData

CachedSoundSetup

private SoundSetup CachedSoundSetup { get; set; }

Property Value

SoundSetup

IsDataLoaded

private bool IsDataLoaded { get; set; }

Property Value

bool

IsMutedAll

public bool IsMutedAll { get; private set; }

Property Value

bool

PoolManagerComponent

private AudioSourcePoolManager PoolManagerComponent { get; set; }

Property Value

AudioSourcePoolManager

Methods

CacheAudioMixerGroup(string)

private void CacheAudioMixerGroup(string mixerGroupName)

Parameters

mixerGroupName string

GetAudioSourceVolume(SoundType)

public float GetAudioSourceVolume(SoundType sourceType)

Parameters

sourceType SoundType

Returns

float

GetAudioSourceVolume(int)

public float GetAudioSourceVolume(int soundID)

Parameters

soundID int

Returns

float

GetClipLenghtInSeconds(int)

public float GetClipLenghtInSeconds(int soundID)

Parameters

soundID int

Returns

float

GetClipLenghtInSeconds(string)

public static float GetClipLenghtInSeconds(string audioClipName)

Parameters

audioClipName string

Returns

float

GetClipProgressInSeconds(int)

public float GetClipProgressInSeconds(int soundID)

Parameters

soundID int

Returns

float

GetClipProgressNormalized(int)

public float GetClipProgressNormalized(int soundID)

Parameters

soundID int

Returns

float

Initialize()

Method called when a Singleton instance is created within the Awake callback. It is used to override the initialization behavior.

protected override void Initialize()

IsAudioSourceMuted(SoundType)

public bool IsAudioSourceMuted(SoundType soundType)

Parameters

soundType SoundType

Returns

bool

IsAudioSourceMuted(int)

public bool IsAudioSourceMuted(int soundID)

Parameters

soundID int

Returns

bool

IsPlaying(int)

public bool IsPlaying(int soundID)

Parameters

soundID int

Returns

bool

LoadAllSoundData()

private void LoadAllSoundData()

MuteAll()

public void MuteAll()

MuteByID(int)

public void MuteByID(int soundID)

Parameters

soundID int

MuteByType(SoundType)

public void MuteByType(SoundType type)

Parameters

type SoundType

PauseAll()

public void PauseAll()

PauseByID(int)

public void PauseByID(int soundID)

Parameters

soundID int

PauseByType(SoundType)

public void PauseByType(SoundType type)

Parameters

type SoundType

SaveAllSoundData()

private void SaveAllSoundData()

SetAudioSourceOutput(SoundType, string)

public void SetAudioSourceOutput(SoundType sourceType, string audioMixerGroupName)

Parameters

sourceType SoundType
audioMixerGroupName string

SetClipProgress(int, float)

public void SetClipProgress(int soundID, float startClipProgress)

Parameters

soundID int
startClipProgress float

SetClipTime(int, float)

public void SetClipTime(int soundID, float startTimeInSeconds)

Parameters

soundID int
startTimeInSeconds float

SetMutedAllStatus(bool)

public void SetMutedAllStatus(bool isMuted)

Parameters

isMuted bool

SetOutputAudioMixerGroupAll(string)

public void SetOutputAudioMixerGroupAll(string audioMixerGroupName)

Parameters

audioMixerGroupName string

SetOutputAudioMixerGroupAll(AudioMixerGroup)

public void SetOutputAudioMixerGroupAll(AudioMixerGroup audioMixerGroup)

Parameters

audioMixerGroup AudioMixerGroup

SetOutputAudioMixerGroupByID(int, string)

public void SetOutputAudioMixerGroupByID(int soundID, string audioMixerGroupName)

Parameters

soundID int
audioMixerGroupName string

SetOutputAudioMixerGroupByID(int, AudioMixerGroup)

public void SetOutputAudioMixerGroupByID(int soundID, AudioMixerGroup audioMixerGroup)

Parameters

soundID int
audioMixerGroup AudioMixerGroup

SetOutputAudioMixerGroupByType(SoundType, string)

public void SetOutputAudioMixerGroupByType(SoundType type, string audioMixerGroupName)

Parameters

type SoundType
audioMixerGroupName string

SetOutputAudioMixerGroupByType(SoundType, AudioMixerGroup)

public void SetOutputAudioMixerGroupByType(SoundType type, AudioMixerGroup audioMixerGroup)

Parameters

type SoundType
audioMixerGroup AudioMixerGroup

SetSourcePositionAll(Transform)

public void SetSourcePositionAll(Transform soundComponentTransform)

Parameters

soundComponentTransform Transform

SetSourcePositionByID(int, Transform)

public void SetSourcePositionByID(int soundID, Transform soundComponentTransform)

Parameters

soundID int
soundComponentTransform Transform

SetSourcePositionByType(SoundType, Transform)

public void SetSourcePositionByType(SoundType type, Transform soundComponentTransform)

Parameters

type SoundType
soundComponentTransform Transform

SetVolumeAll(float)

public void SetVolumeAll(float volume)

Parameters

volume float

SetVolumeByID(int, float)

public void SetVolumeByID(int soundID, float volume)

Parameters

soundID int
volume float

SetVolumeByType(SoundType, float)

public void SetVolumeByType(SoundType type, float volume)

Parameters

type SoundType
volume float

StopAll()

public void StopAll()

StopByID(int)

public void StopByID(int soundID)

Parameters

soundID int

StopByType(SoundType)

public void StopByType(SoundType type)

Parameters

type SoundType

TryCacheAudioSourceGroupData(SoundType)

private bool TryCacheAudioSourceGroupData(SoundType type)

Parameters

type SoundType

Returns

bool

TryCacheAudioSourceGroupData(int)

private bool TryCacheAudioSourceGroupData(int soundID)

Parameters

soundID int

Returns

bool

TryPlay(out int, SoundType, string, bool, Transform)

public bool TryPlay(out int soundID, SoundType type, string soundName, bool isLooping = false, Transform soundSourceTransform = null)

Parameters

soundID int
type SoundType
soundName string
isLooping bool
soundSourceTransform Transform

Returns

bool

TryPlay(out int, SoundType, AudioClip, bool, Transform)

public bool TryPlay(out int soundID, SoundType type, AudioClip clip, bool isLooping = false, Transform soundComponentTransform = null)

Parameters

soundID int
type SoundType
clip AudioClip
isLooping bool
soundComponentTransform Transform

Returns

bool

TryPlayFromProgress(out int, SoundType, string, float, bool, Transform)

public bool TryPlayFromProgress(out int soundID, SoundType type, string soundName, float startClipProgress, bool isLooping = false, Transform soundSourceTransform = null)

Parameters

soundID int
type SoundType
soundName string
startClipProgress float
isLooping bool
soundSourceTransform Transform

Returns

bool

TryPlayFromProgress(out int, SoundType, AudioClip, float, bool, Transform)

public bool TryPlayFromProgress(out int soundID, SoundType type, AudioClip clip, float startClipProgress, bool isLooping = false, Transform soundSourceTransform = null)

Parameters

soundID int
type SoundType
clip AudioClip
startClipProgress float
isLooping bool
soundSourceTransform Transform

Returns

bool

TryPlayFromTime(out int, SoundType, string, float, bool, Transform)

public bool TryPlayFromTime(out int soundID, SoundType type, string soundName, float startTimeInSeconds, bool isLooping = false, Transform soundSourceTransform = null)

Parameters

soundID int
type SoundType
soundName string
startTimeInSeconds float
isLooping bool
soundSourceTransform Transform

Returns

bool

TryPlayFromTime(out int, SoundType, AudioClip, float, bool, Transform)

public bool TryPlayFromTime(out int soundID, SoundType type, AudioClip clip, float startTimeInSeconds, bool isLooping = false, Transform soundSourceTransform = null)

Parameters

soundID int
type SoundType
clip AudioClip
startTimeInSeconds float
isLooping bool
soundSourceTransform Transform

Returns

bool

TryShowWarningWhenAudioSourcesExceed(SoundType)

private void TryShowWarningWhenAudioSourcesExceed(SoundType type)

Parameters

type SoundType

UnmuteAll()

public void UnmuteAll()

UnmuteByID(int)

public void UnmuteByID(int soundID)

Parameters

soundID int

UnmuteByType(SoundType)

public void UnmuteByType(SoundType type)

Parameters

type SoundType

UnpauseAll()

public void UnpauseAll()

UnpauseByID(int)

public void UnpauseByID(int soundID)

Parameters

soundID int

UnpauseByType(SoundType)

public void UnpauseByType(SoundType type)

Parameters

type SoundType