AudioStation

The audio manager

Index

Constructors

• constructor

Properties

• audioContext
• clips
• eventTarget
• mixers

Accessors

• activated
• destroyed
• time

Methods

• activate
• deactivate
• destroy
• load
• loadFromBuffer
• reset

Constructors

constructor

• new AudioStation(audioContextOption?: AudioContextOptions): AudioStation

• Parameters

  • optionalaudioContextOption: AudioContextOptions

  Returns AudioStation

Properties

audioContext

audioContext: IAudioContext

clips

clips: Set<AudioClip>

readonlyeventTarget

eventTarget: AudioStationEventTarget = ...

mixers

mixers: Set<AudioMixer>

Accessors

activated

• get activated(): boolean

• Is the AudioContext used in the AudioStation running

  ---

  Returns boolean

destroyed

• get destroyed(): boolean

• Check if the audio buffer destroyed

  ---

  Returns boolean

time

• get time(): number

• Get time from the AudioContext, useful for scheduling

  ---

  Returns number

Methods

activate

• activate(): Promise<void>

• Attempt to resume the AudioContext used in the AudioStation

  ---

  Returns Promise<void>

deactivate

• deactivate(): Promise<void>

• Attempt to suspend the AudioContext used in the AudioStation

  ---

  Returns Promise<void>

destroy

• destroy(): Promise<void>

• Destroy the AudioContext used in the AudioStation

  ---

  Returns Promise<void>

load

• load(url: string): Promise<AudioClip>

• Load audio buffer from a specific url

  ---

  Parameters

  • url: string

  Returns Promise<AudioClip>

loadFromBuffer

• loadFromBuffer(arrayBuffer: ArrayBuffer): Promise<AudioClip>

• Parameters

  • arrayBuffer: ArrayBuffer

  Returns Promise<AudioClip>

reset

• reset(): void

• Reset the audio station when its audio context is broken Designed for iOS, but potentially useful on other platforms

  ---

  Returns void