Class SoundPlayer<T>

Use this to play sounds. If you want to position your sounds, use a SoundSource instead.

Type Parameters

T extends AudioNode = AudioNode

Hierarchy (view full)

SoundPlayer
- SoundSource

Index

Constructors

Properties

channels node sounds

Methods

createSourceNode onSoundEnded play playOnChannel stopAll stopChannel

Constructors

constructor

new SoundPlayer<T>(node): SoundPlayer<T>
Type Parameters
- T extends AudioNode = AudioNode
Parameters
- node: T
  The destination node to connect AudioBufferSourceNode AudioBufferSourceNodes to.
Returns SoundPlayer<T>
- Defined in SoundPlayer.ts:24

Properties

`Protected` `Readonly` channels

channels: Map<string, AudioBufferSourceNode> = ...

All sounds played on a channel.

`Readonly` node

node: T

The destination node to connect AudioBufferSourceNode AudioBufferSourceNodes to. In the case of a SoundSource, this will be the panner node.

`Protected` `Readonly` sounds

sounds: AudioBufferSourceNode[] = []

All free sounds (those not played on a channel).

Methods

`Protected` createSourceNode

createSourceNode(audioBuffer, options?): AudioBufferSourceNode
Creates an AudioBufferSourceNode and adds an "ended" event listener to its node.
Parameters
- audioBuffer: AudioBuffer
  The buffer to play.
- Optional options: PlayOptions
  The options to apply on playback.
Returns AudioBufferSourceNode
The new AudioBufferSourceNode.
- Defined in SoundPlayer.ts:34

`Protected` onSoundEnded

onSoundEnded(sourceNode): void
Will be called when an AudioBufferSourceNode ended.
Parameters
- sourceNode: AudioBufferSourceNode
  The AudioBufferSourceNode node that ended.
Returns void
- Defined in SoundPlayer.ts:98

play

play(audioBuffer, options?): AudioBufferSourceNode
Play an audio buffer.
Parameters
- audioBuffer: AudioBuffer
  The buffer to play.
- Optional options: PlayOptions
  The options to apply on playback.
Returns AudioBufferSourceNode
A new AudioBufferSourceNode.
- Defined in SoundPlayer.ts:50

playOnChannel

playOnChannel(channel, audioBuffer, options?): AudioBufferSourceNode
Play an audio buffer on a channel. If an AudioBufferSourceNode is already running on the specified channel, it will be stopped first.
Parameters
- channel: string
  The channel to play the buffer on.
- audioBuffer: AudioBuffer
  The buffer to play.
- Optional options: PlayOptions
  The options to apply on playback.
Returns AudioBufferSourceNode
A new AudioBufferSourceNode.
- Defined in SoundPlayer.ts:64

stopAll

stopAll(): void
Stop all sounds.

Returns void
- Defined in SoundPlayer.ts:87

stopChannel

stopChannel(channel): void
Stop the AudioBufferSourceNode on a channel if any is currently playing.
Parameters
- channel: string
  The channel to stop.
Returns void
- Defined in SoundPlayer.ts:76