Class StreamingSoundAbstract
Hierarchy (View Summary)
- AbstractSound
- StreamingSound
Properties
Readonlyengine
The audio engine this node belongs to.
Readonlyon
Observable for when the audio node is disposed.
Readonlyon
Observable for when the sound stops playing.
Readonlyon
{ newName: string; node: AbstractNamedAudioNode; oldName: string },
> = ...
Observable for when the audio node is renamed.
Abstractstereo
The stereo features of the sound.
Accessors
_
-
set _isSpatial(value: boolean): void
Parameters
- value: boolean
Returns void
active
-
get activeInstancesCount(): number
The number of active instances of the sound that are currently playing.
Returns number
analyzer
-
The audio analyzer features.
Returns AbstractAudioAnalyzer
autoplay
-
get autoplay(): boolean
Whether the sound should start playing automatically. Defaults to
false.Returns boolean
current
-
get currentTime(): number
The current playback time of the sound, in seconds.
Returns number
-
set currentTime(value: number): void
Parameters
- value: number
Returns void
loop
-
get loop(): boolean
Whether the sound should loop. Defaults to
false.Returns boolean
-
set loop(value: boolean): void
Parameters
- value: boolean
Returns void
max
-
get maxInstances(): number
The maximum number of instances that can play at the same time. Defaults to
Infinity.Returns number
-
set maxInstances(value: number): void
Parameters
- value: number
Returns void
name
-
get name(): string
The name of the audio node.
- Triggers
onNameChangedObservablewhen changed.
Returns string
- Triggers
-
set name(newName: string): void
Parameters
- newName: string
Returns void
out
-
Parameters
- outBus: Nullable<PrimaryAudioBus>
Returns void
preload
-
get preloadCompletedCount(): number
Returns the number of instances that have been preloaded.
Returns number
preload
-
get preloadCount(): number
The number of instances to preload. Defaults to
1.Returns number
spatial
-
The spatial audio features.
Returns AbstractSpatialAudio
start
-
get startOffset(): number
The time within the sound buffer to start playing at, in seconds. Defaults to
0.Returns number
-
set startOffset(value: number): void
Parameters
- value: number
Returns void
state
-
The state of the sound.
Returns SoundState
volume
-
get volume(): number
The audio output volume.
Returns number
-
set volume(value: number): void
Parameters
- value: number
Returns void
Methods
dispose
-
Releases associated resources.
Returns void
Abstractget
-
Gets a string identifying the name of the class
Returns string
the class's name as a string
pause
-
Pauses the sound.
Returns void
play
-
Plays the sound.
- Triggers
onEndedObservableif played for the full duration and theloopoption is not set.
Parameters
- options: Partial<IStreamingSoundPlayOptions> = {}
The options to use when playing the sound. Options set here override the sound's options.
Returns void
- Triggers
preload
-
Preloads an instance of the sound.
Returns Promise<void>
A promise that resolves when the instance is preloaded.
preload
-
Preloads the given number of instances of the sound.
Parameters
- count: number
The number of instances to preload.
Returns Promise<void>
A promise that resolves when all instances are preloaded.
- count: number
resume
-
Resumes the sound.
- Only options explicitly set here override the paused instance's current options; unset options keep their paused values so playback continues from where it was paused.
Parameters
Optionaloptions: Partial<IStreamingSoundPlayOptions>The options to use when resuming the sound.
Returns void
set
-
Sets the audio output volume with optional ramping. If the duration is 0 then the volume is set immediately, otherwise it is ramped to the new value over the given duration using the given shape. If a ramp is already in progress then the volume is not set and an error is thrown.
Parameters
- value: number
The value to set the volume to.
- options: Nullable<Partial<IAudioParameterRampOptions>> = null
The options to use for ramping the volume change.
Returns void
- value: number
stop
-
Stops the sound.
Returns void
Abstract class representing a streaming sound.
A streaming sound has a sound buffer that is loaded into memory in chunks as it is played. This allows it to be played more quickly than a static sound, but it also means that it cannot have loop points or playback rate changes.
Due to the way streaming sounds are typically implemented, there can be a significant delay when attempting to play a streaming sound for the first time. To prevent this delay, it is recommended to preload instances of the sound using the IStreamingSoundStoredOptions.preloadCount options, or the preloadInstanceAsync and preloadInstancesAsync methods before calling the
playmethod.Streaming sounds are created by the CreateStreamingSoundAsync function.