Class AbstractAudioBusAbstract
Hierarchy (View Summary)
- AbstractAudioOutNode
- AbstractAudioBus
Properties
Readonlyengine
The audio engine this node belongs to.
Readonlyon
Observable for when the audio node is disposed.
Readonlyon
onNameChangedObservable: Observable<
{ newName: string; node: AbstractNamedAudioNode; oldName: string },
> = ...
{ newName: string; node: AbstractNamedAudioNode; oldName: string },
> = ...
Observable for when the audio node is renamed.
Accessors
analyzer
-
The audio analyzer features.
Returns AbstractAudioAnalyzer
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
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
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
Abstract class representing an audio bus with volume control.
An audio bus is a node in the audio graph that can have multiple inputs and outputs. It is typically used to group sounds together and apply effects to them.