Jacky's Simple Audio Manager  3.0.0-preview
A decentralized audio playing system for Unity, designed for simplicity and built to scale!
Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes | Properties | List of all members
JSAM.BaseAudioChannelHelper< T > Class Template Reference
Inheritance diagram for JSAM.BaseAudioChannelHelper< T >:

Public Member Functions

void Init (AudioMixerGroup defaultGroup)
 
virtual AudioSource Play (T file)
 
virtual void Stop (bool stopInstantly=true)
 
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 ()
 

Public Attributes

bool Reserved = false
 Set this to true to make AudioManager ignore this AudioChannel for Audio Playback. More...
 

Protected Member Functions

virtual void OnEnable ()
 
virtual void OnDisable ()
 
virtual void Update ()
 
void ClearProperties ()
 Called by Play() More...
 
virtual void OnTimeScaleChanged (float previousTimeScale)
 
void OnUpdateVolume (float volume)
 
IEnumerator FadeIn (float fadeTime)
 
virtual IEnumerator FadeOut (float fadeTime)
 

Protected Attributes

T audioFile
 
AudioChorusFilter chorusFilter
 
AudioDistortionFilter distortionFilter
 
AudioEchoFilter echoFilter
 
AudioHighPassFilter highPassFilter
 
AudioLowPassFilter lowPassFilter
 
AudioReverbFilter reverbFilter
 
AudioMixerGroup defaultMixerGroup
 
Transform originalParent
 

Properties

bool IsFree [get]
 Returns true if this Audio Channel is not playing any sounds and is not marked as "Reserved" More...
 
T 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]
 

Member Function Documentation

◆ ApplyEffects()

void JSAM.BaseAudioChannelHelper< T >.ApplyEffects ( )

◆ AssignNewAudioClip()

bool JSAM.BaseAudioChannelHelper< T >.AssignNewAudioClip ( )

Returns false if no AudioClips exists

Returns

◆ BeginFadeIn()

void JSAM.BaseAudioChannelHelper< T >.BeginFadeIn ( float  fadeTime)

◆ BeginFadeOut()

void JSAM.BaseAudioChannelHelper< T >.BeginFadeOut ( float  fadeTime)

◆ ClearEffects()

void JSAM.BaseAudioChannelHelper< T >.ClearEffects ( )

◆ ClearProperties()

void JSAM.BaseAudioChannelHelper< T >.ClearProperties ( )
protected

Called by Play()

◆ FadeIn()

IEnumerator JSAM.BaseAudioChannelHelper< T >.FadeIn ( float  fadeTime)
protected

Parameters
fadeTimeFade-in time in seconds
Returns

◆ FadeOut()

virtual IEnumerator JSAM.BaseAudioChannelHelper< T >.FadeOut ( float  fadeTime)
protectedvirtual

Parameters
fadeTimeFade-out time in seconds
Returns

Reimplemented in JSAM.MusicChannelHelper.

◆ Init()

void JSAM.BaseAudioChannelHelper< T >.Init ( AudioMixerGroup  defaultGroup)

◆ OnDisable()

virtual void JSAM.BaseAudioChannelHelper< T >.OnDisable ( )
protectedvirtual

Reimplemented in JSAM.SoundChannelHelper, and JSAM.MusicChannelHelper.

◆ OnEnable()

virtual void JSAM.BaseAudioChannelHelper< T >.OnEnable ( )
protectedvirtual

Reimplemented in JSAM.SoundChannelHelper, and JSAM.MusicChannelHelper.

◆ OnTimeScaleChanged()

virtual void JSAM.BaseAudioChannelHelper< T >.OnTimeScaleChanged ( float  previousTimeScale)
protectedvirtual

◆ OnUpdateVolume()

void JSAM.BaseAudioChannelHelper< T >.OnUpdateVolume ( float  volume)
protected

◆ Play()

virtual AudioSource JSAM.BaseAudioChannelHelper< T >.Play ( T  file)
virtual

◆ SetSpatializationTarget() [1/2]

virtual void JSAM.BaseAudioChannelHelper< T >.SetSpatializationTarget ( Transform  target)
virtual

◆ SetSpatializationTarget() [2/2]

virtual void JSAM.BaseAudioChannelHelper< T >.SetSpatializationTarget ( Vector3  position)
virtual

◆ Stop()

virtual void JSAM.BaseAudioChannelHelper< T >.Stop ( bool  stopInstantly = true)
virtual

Reimplemented in JSAM.SoundChannelHelper, and JSAM.MusicChannelHelper.

◆ Update()

virtual void JSAM.BaseAudioChannelHelper< T >.Update ( )
protectedvirtual

Reimplemented in JSAM.SoundChannelHelper.

Member Data Documentation

◆ audioFile

T JSAM.BaseAudioChannelHelper< T >.audioFile
protected

◆ chorusFilter

AudioChorusFilter JSAM.BaseAudioChannelHelper< T >.chorusFilter
protected

◆ defaultMixerGroup

AudioMixerGroup JSAM.BaseAudioChannelHelper< T >.defaultMixerGroup
protected

◆ distortionFilter

AudioDistortionFilter JSAM.BaseAudioChannelHelper< T >.distortionFilter
protected

◆ echoFilter

AudioEchoFilter JSAM.BaseAudioChannelHelper< T >.echoFilter
protected

◆ highPassFilter

AudioHighPassFilter JSAM.BaseAudioChannelHelper< T >.highPassFilter
protected

◆ lowPassFilter

AudioLowPassFilter JSAM.BaseAudioChannelHelper< T >.lowPassFilter
protected

◆ originalParent

Transform JSAM.BaseAudioChannelHelper< T >.originalParent
protected

◆ Reserved

bool JSAM.BaseAudioChannelHelper< T >.Reserved = false

Set this to true to make AudioManager ignore this AudioChannel for Audio Playback.

Good if you want to reserve this channel for certain entities that can't have overlapping sounds

◆ reverbFilter

AudioReverbFilter JSAM.BaseAudioChannelHelper< T >.reverbFilter
protected

Property Documentation

◆ AudioFile

T JSAM.BaseAudioChannelHelper< T >.AudioFile
get

◆ AudioSource

AudioSource JSAM.BaseAudioChannelHelper< T >.AudioSource
get

◆ IsFree

bool JSAM.BaseAudioChannelHelper< T >.IsFree
get

Returns true if this Audio Channel is not playing any sounds and is not marked as "Reserved"

◆ LoopEnd

int JSAM.BaseAudioChannelHelper< T >.LoopEnd
getprotected

◆ LoopStart

int JSAM.BaseAudioChannelHelper< T >.LoopStart
getprotected

◆ SpatializationPosition

Vector3 JSAM.BaseAudioChannelHelper< T >.SpatializationPosition
get

This property will only be assigned to if both the AudioFileObject and the AudioManager have spatialization enabled

◆ SpatializationTarget

Transform JSAM.BaseAudioChannelHelper< T >.SpatializationTarget
get

This property will only be assigned to if both the AudioFileObject and the AudioManager have spatialization enabled

◆ Volume

abstract float JSAM.BaseAudioChannelHelper< T >.Volume
getprotected
The documentation for this class was generated from the following file: