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

Public Member Functions

override AudioSource Play (SoundFileObject file)
 
override void Stop (bool stopInstantly=true)
 
- Public Member Functions inherited from JSAM.BaseAudioChannelHelper< SoundFileObject >
void Init (AudioMixerGroup defaultGroup)
 
virtual AudioSource Play (T file)
 
bool AssignNewAudioClip ()
 Returns false if no AudioClips exists More...
 
virtual void SetSpatializationTarget (Transform target)
 
virtual void SetSpatializationTarget (Vector3 position)
 
void BeginFadeIn (float fadeTime)
 
void BeginFadeOut (float fadeTime)
 
void ApplyEffects ()
 
void ClearEffects ()
 

Protected Member Functions

override void OnEnable ()
 
override void OnDisable ()
 
override void Update ()
 
- Protected Member Functions inherited from JSAM.BaseAudioChannelHelper< SoundFileObject >
void ClearProperties ()
 Called by Play() More...
 
virtual void OnTimeScaleChanged (float previousTimeScale)
 
void OnUpdateVolume (float volume)
 
IEnumerator FadeIn (float fadeTime)
 
virtual IEnumerator FadeOut (float fadeTime)
 

Properties

override float Volume [get]
 
- Properties inherited from JSAM.BaseAudioChannelHelper< SoundFileObject >
bool IsFree [get]
 Returns true if this Audio Channel is not playing any sounds and is not marked as "Reserved" More...
 
AudioFile [get]
 
abstract float Volume [get]
 
Transform SpatializationTarget [get]
 This property will only be assigned to if both the AudioFileObject and the AudioManager have spatialization enabled More...
 
Vector3 SpatializationPosition [get]
 This property will only be assigned to if both the AudioFileObject and the AudioManager have spatialization enabled More...
 
int LoopStart [get]
 
int LoopEnd [get]
 
AudioSource AudioSource [get]
 

Additional Inherited Members

- Public Attributes inherited from JSAM.BaseAudioChannelHelper< SoundFileObject >
bool Reserved
 Set this to true to make AudioManager ignore this AudioChannel for Audio Playback. More...
 
- Protected Attributes inherited from JSAM.BaseAudioChannelHelper< SoundFileObject >
audioFile
 
AudioChorusFilter chorusFilter
 
AudioDistortionFilter distortionFilter
 
AudioEchoFilter echoFilter
 
AudioHighPassFilter highPassFilter
 
AudioLowPassFilter lowPassFilter
 
AudioReverbFilter reverbFilter
 
AudioMixerGroup defaultMixerGroup
 
Transform originalParent
 

Member Function Documentation

◆ OnDisable()

override void JSAM.SoundChannelHelper.OnDisable ( )
protectedvirtual

◆ OnEnable()

override void JSAM.SoundChannelHelper.OnEnable ( )
protectedvirtual

◆ Play()

override AudioSource JSAM.SoundChannelHelper.Play ( SoundFileObject  file)

◆ Stop()

override void JSAM.SoundChannelHelper.Stop ( bool  stopInstantly = true)
virtual

◆ Update()

override void JSAM.SoundChannelHelper.Update ( )
protectedvirtual

Property Documentation

◆ Volume

override float JSAM.SoundChannelHelper.Volume
getprotected

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