1681-engine / index / SoundEngine

Class: SoundEngine

Defined in: src/audio/SoundEngine.ts:54

Constructors

Constructor

new SoundEngine(): SoundEngine;

Defined in: src/audio/SoundEngine.ts:65

Returns

SoundEngine

Properties

listener

listener: () => 
  | {
  x: number;
  y: number;
}
  | null;

Defined in: src/audio/SoundEngine.ts:62

Where the local player stands, set by the world scene; null off the world screens.

Returns

| { x: number; y: number; } | null

Accessors

audioContext

Get Signature

get audioContext(): AudioContext | null;

Defined in: src/audio/SoundEngine.ts:102

The effects' audio context once something opened it (the first gesture does), else null: never created here, so asking does not open a context the browser would hold suspended. AssetLoader.audio decodes through it.

Returns

AudioContext | null

Methods

play()

play(name, opts?): void;

Defined in: src/audio/SoundEngine.ts:106

Parameters

Parameter	Type
name	string | undefined
opts	SoundOptions

Returns

void