AudioSource

The audio source

Index

Constructors

• constructor

Properties

• clip
• gain
• mixer
• source
• station

Accessors

• destroyed
• loop
• time
• volume

Methods

• addEndHandler
• destroy
• fade
• isPlaying
• pause
• play
• removeEndHandler
• replaceAudioContext
• resume
• stop
• suspend

Constructors

constructor

• new AudioSource(mixer: AudioMixer, clip: AudioClip): AudioSource

• Parameters

  • mixer: AudioMixer

  • clip: AudioClip

  Returns AudioSource

Properties

clip

clip: AudioClip

gain

gain: gainNodeConstructor<IAudioContext>

mixer

mixer: AudioMixer

source

source: audioBufferSourceNodeConstructor<IAudioContext>

station

station: AudioStation

Accessors

destroyed

• get destroyed(): boolean

• Check if the audio source destroyed

  ---

  Returns boolean

loop

• get loop(): boolean
• set loop(value: boolean): void

• Get if the source is looping

  ---

  Returns boolean

• Set if the source is looping

  ---

  Parameters

  • value: boolean

  Returns void

time

• get time(): number
• set time(value: number): void

• Get the current progress of the source

  ---

  Returns number

• Set the current progress of the source, seek the source

  ---

  Parameters

  • value: number

  Returns void

volume

• get volume(): number
• set volume(value: number): void

• Get the volume of this source

  ---

  Returns number

• Set the volume of this source

  ---

  Parameters

  • value: number

  Returns void

Methods

addEndHandler

• addEndHandler(handler: () => void): void

• Add a handler to be called when the audio source end itself without manually stop

  ---

  Parameters

  • handler: () => void

  Returns void

destroy

• destroy(): void

• Dispose the audio source

  ---

  Returns void

fade

• fade(startVolume: number, endVolume: number, duration: number): void

• Fade the audio source from a start volume to an end volume May be interrupted by stop, pause, suspend, set volume, or another fade

  ---

  Parameters

  • startVolume: number

  • endVolume: number

  • duration: number

  Returns void

isPlaying

• isPlaying(): boolean

• Returns boolean

pause

• pause(): void

• Pause the source

  ---

  Returns void

play

• play(): void

• Play or resume the source Do not works when the source is already playing

  ---

  Returns void

removeEndHandler

• removeEndHandler(handler: () => void): void

• Remove a handler previously added by addEndHandler

  ---

  Parameters

  • handler: () => void

  Returns void

replaceAudioContext

• replaceAudioContext(newAudioContext: IAudioContext, newMixerNode: gainNodeConstructor<IAudioContext>): void

• Replace audio context used in this source Should be only used by AudioMixer#replaceAudioContext

  ---

  Parameters

  • newAudioContext: IAudioContext

  • newMixerNode: gainNodeConstructor<IAudioContext>

  Returns void

resume

• resume(): void

• Resume the source, this should only be called from mixer

  ---

  Returns void

stop

• stop(): void

• Stop the source, same as pause and seek to 0

  ---

  Returns void

suspend

• suspend(): void

• Suspend the source, this should only be called from mixer

  ---

  Returns void