Atlas Engine
API Referencefinewave

AudioSource

Playback controls for audio data, including spatialization and effects.

Module: finewave

Playback controls for audio data, including spatialization and effects.

Declaration

export class AudioSource { ... }

Methods

setData

setData(data: AudioData): void;

fromFile

fromFile(resource: Resource): void;

play

Starts or resumes playback.

play(): void;

pause

Pauses playback.

pause(): void;

stop

Stops playback.

stop(): void;

setLoop

Enables or disables repeated playback.

setLoop(loop: boolean): void;

setVolume

setVolume(volume: number): void;

setPitch

setPitch(pitch: number): void;

setPosition

Sets the position to an absolute value.

setPosition(position: Position3d): void;

setVelocity

setVelocity(velocity: Position3d): void;

isPlaying

isPlaying(): boolean;

playFrom

Starts playback at the supplied offset in seconds.

playFrom(position: number): void;

disableSpatialization

Disables positional audio processing for this source.

disableSpatialization(): void;

applyEffect

Applies an audio effect to this source.

applyEffect(effect: AudioEffect): void;

getPosition

getPosition(): Position3d;

getListenerPosition

getListenerPosition(): Position3d;

useSpatialization

Enables positional audio processing for this source.

useSpatialization(): void;

On this page