Speaker

The Speaker class encapsulates an speaker for a scene. Old class name is AudioSource.

Properties

PropertyDescription

volume

(get) volume: ScalarValue (set) volume: ScalarSignal

(get) Returns the volume of the speaker in the range of [0.0, 1.0]. (set) Specifies the volume of the speaker in the range of [0.0, 1.0].

Note: To access this property you need to enable the AudioSourceVolume API capability.

Methods

MethodDescription

play

play(): void

Creates a new playing instance of the sound associated with this AudioSource.

stopAll

stopAll(speaker: Speaker): void

Stops all playing instances of this AudioSource.