Class AudioBusAbstract
Hierarchy (View Summary)
- AbstractAudioBus
- AudioBus
Properties
Readonlyengine
The audio engine this node belongs to.
Readonlyon
Observable for when the audio node is disposed.
Readonlyon
{ newName: string; node: AbstractNamedAudioNode; oldName: string },
> = ...
Observable for when the audio node is renamed.
Abstract Readonlystereo
The stereo features of the audio bus.
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
out
-
The output bus of the audio bus. Defaults to the audio engine's default main bus.
Returns Nullable<PrimaryAudioBus>
-
Parameters
- outBus: Nullable<PrimaryAudioBus>
Returns void
spatial
-
The spatial audio features.
Returns AbstractSpatialAudio
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 for an audio bus that has spatial audio and stereo output capabilities.
Instances of this class can be connected to other audio buses.
Audio buses are created by the CreateAudioBusAsync function.