AudioPlayer

Module: atlas/audio

Component that plays an audio source and supports positional audio.

Declaration

export class AudioPlayer extends Component { ... }

Extends: Component

constructor();

source: AudioSource;

override init(): void;

Starts or resumes playback.

play(): void;

Pauses playback.

pause(): void;

Stops playback.

stop(): void;

setVolume(volume: number): void;

Enables or disables repeated playback.

setLoop(loop: boolean): void;

Loads the audio resource for playback.

setSource(resource: Resource): void;

override update(dt: number): void;

Sets the position to an absolute value.

setPosition(position: Position3d): void;

Enables or disables positional audio for this player.

useSpatialAudio(enabled: boolean): void;