Jacky's Simple Audio Manager  3.0.0-preview
A decentralized audio playing system for Unity, designed for simplicity and built to scale!
JSAM.JSAMSettings Class Reference
Inheritance diagram for JSAM.JSAMSettings:

Public Types

enum  SpatializeUpdateMode { SpatializeUpdateMode.Default, SpatializeUpdateMode.FixedUpdate, SpatializeUpdateMode.LateUpdate, SpatializeUpdateMode.Parented }
 Specifies how your audio channels will follow their targets in 3D space during runtime. More...
 

Public Member Functions

void Reset ()
 

Public Attributes

bool Spatialize => spatialSound
 
int StartingSoundChannels => startingSoundChannels
 
int StartingMusicChannels => startingMusicChannels
 
float DefaultSoundMaxDistance => defaultSoundMaxDistance
 
bool DisableConsoleLogs => disableConsoleLogs
 
new bool DontDestroyOnLoad => dontDestroyOnLoad
 
bool DynamicSourceAllocation => dynamicSourceAllocation
 
GameObject SoundChannelPrefab => soundChannelPrefabOverride
 
GameObject MusicChannelPrefab => musicChannelPrefabOverride
 
bool StopSoundsOnSceneLoad => stopSoundsOnSceneLoad
 
bool SpatializeOnLateUpdate => spatializeLateUpdate
 
SpatializeUpdateMode SpatializationMode => spatializationMode
 
bool TimeScaledSounds => timeScaledSounds
 
AudioMixer Mixer => mixer
 
AudioMixerGroup MasterGroup => masterGroup
 
string MasterVolumePararm => masterVolumeParam
 
AudioMixerGroup MusicGroup => musicGroup
 
string MusicVolumePararm => musicVolumeParam
 
AudioMixerGroup SoundGroup => soundGroup
 
string SoundVolumePararm => soundVolumeParam
 
AudioMixerGroup VoiceGroup => voiceGroup
 
string VoiceVolumePararm => voiceVolumeParam
 
bool SaveVolumeToPlayerPrefs => saveVolumeToPlayerPrefs
 
string MasterVolumeKey => masterVolumeKey
 
string MasterMutedKey => masterMutedKey
 
string MusicVolumeKey => musicVolumeKey
 
string MusicMutedKey => musicMutedKey
 
string SoundVolumeKey => soundVolumeKey
 
string SoundMutedKey => soundMutedKey
 

Properties

int QuickReferenceFontSize [get]
 
static JSAMSettings Settings [get]
 

Member Enumeration Documentation

◆ SpatializeUpdateMode

Specifies how your audio channels will follow their targets in 3D space during runtime.

Only applies if you have Spatial Sound enabled

Enumerator
Default 

Audio channels track their targets in world space every Update.

FixedUpdate 

Audio channels track their targets in FixedUpdate.

Good for targets that move during FixedUpdate

LateUpdate 

Audio channels track their targets in LateUpdate.

Good for targets that move during LateUpdate

Parented 

Audio channels are parented in the hierarchy to their targets.

Less performance overhead, but will clutter your object hierarchies during runtime

Member Function Documentation

◆ Reset()

void JSAM.JSAMSettings.Reset ( )

Member Data Documentation

◆ DefaultSoundMaxDistance

float JSAM.JSAMSettings.DefaultSoundMaxDistance => defaultSoundMaxDistance

◆ DisableConsoleLogs

bool JSAM.JSAMSettings.DisableConsoleLogs => disableConsoleLogs

◆ DontDestroyOnLoad

new bool JSAM.JSAMSettings.DontDestroyOnLoad => dontDestroyOnLoad

◆ DynamicSourceAllocation

bool JSAM.JSAMSettings.DynamicSourceAllocation => dynamicSourceAllocation

◆ MasterGroup

AudioMixerGroup JSAM.JSAMSettings.MasterGroup => masterGroup

◆ MasterMutedKey

string JSAM.JSAMSettings.MasterMutedKey => masterMutedKey

◆ MasterVolumeKey

string JSAM.JSAMSettings.MasterVolumeKey => masterVolumeKey

◆ MasterVolumePararm

string JSAM.JSAMSettings.MasterVolumePararm => masterVolumeParam

◆ Mixer

AudioMixer JSAM.JSAMSettings.Mixer => mixer

◆ MusicChannelPrefab

GameObject JSAM.JSAMSettings.MusicChannelPrefab => musicChannelPrefabOverride

◆ MusicGroup

AudioMixerGroup JSAM.JSAMSettings.MusicGroup => musicGroup

◆ MusicMutedKey

string JSAM.JSAMSettings.MusicMutedKey => musicMutedKey

◆ MusicVolumeKey

string JSAM.JSAMSettings.MusicVolumeKey => musicVolumeKey

◆ MusicVolumePararm

string JSAM.JSAMSettings.MusicVolumePararm => musicVolumeParam

◆ SaveVolumeToPlayerPrefs

bool JSAM.JSAMSettings.SaveVolumeToPlayerPrefs => saveVolumeToPlayerPrefs

◆ SoundChannelPrefab

GameObject JSAM.JSAMSettings.SoundChannelPrefab => soundChannelPrefabOverride

◆ SoundGroup

AudioMixerGroup JSAM.JSAMSettings.SoundGroup => soundGroup

◆ SoundMutedKey

string JSAM.JSAMSettings.SoundMutedKey => soundMutedKey

◆ SoundVolumeKey

string JSAM.JSAMSettings.SoundVolumeKey => soundVolumeKey

◆ SoundVolumePararm

string JSAM.JSAMSettings.SoundVolumePararm => soundVolumeParam

◆ SpatializationMode

SpatializeUpdateMode JSAM.JSAMSettings.SpatializationMode => spatializationMode

◆ Spatialize

bool JSAM.JSAMSettings.Spatialize => spatialSound

◆ SpatializeOnLateUpdate

bool JSAM.JSAMSettings.SpatializeOnLateUpdate => spatializeLateUpdate

◆ StartingMusicChannels

int JSAM.JSAMSettings.StartingMusicChannels => startingMusicChannels

◆ StartingSoundChannels

int JSAM.JSAMSettings.StartingSoundChannels => startingSoundChannels

◆ StopSoundsOnSceneLoad

bool JSAM.JSAMSettings.StopSoundsOnSceneLoad => stopSoundsOnSceneLoad

◆ TimeScaledSounds

bool JSAM.JSAMSettings.TimeScaledSounds => timeScaledSounds

◆ VoiceGroup

AudioMixerGroup JSAM.JSAMSettings.VoiceGroup => voiceGroup

◆ VoiceVolumePararm

string JSAM.JSAMSettings.VoiceVolumePararm => voiceVolumeParam

Property Documentation

◆ QuickReferenceFontSize

int JSAM.JSAMSettings.QuickReferenceFontSize
get

◆ Settings

JSAMSettings JSAM.JSAMSettings.Settings
staticget

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