Home
API reference

SynthManager

strata-game-library/audio-synth

strata-game-library/audio-synth


strata-game-library/audio-synth / SynthManager

Class: SynthManager

Defined in: core/SynthManager.ts:29

Creates and manages procedural audio synthesis.

Example

const manager = createSynthManager({ masterVolume: 0.8 });
await manager.init();
manager.playSFX('gunshot');

Implements

Constructors

Constructor

new SynthManager(config): SynthManager

Defined in: core/SynthManager.ts:39

Parameters

config

SynthManagerConfig = {}

Returns

SynthManager

Methods

dispose()

dispose(): void

Defined in: core/SynthManager.ts:281

Dispose all resources.

Returns

void

Implementation of

ISynthManager.dispose


init()

init(): Promise<void>

Defined in: core/SynthManager.ts:50

Initialize the Tone.js audio context. MUST be called after a user gesture (click/touch).

Returns

Promise<void>

Implementation of

ISynthManager.init


isReady()

isReady(): boolean

Defined in: core/SynthManager.ts:71

Check if the audio context is ready.

Returns

boolean

Implementation of

ISynthManager.isReady


playMusic()

playMusic(patternId): void

Defined in: core/SynthManager.ts:161

Play background music from a pattern ID.

Parameters

patternId

string

Returns

void

Implementation of

ISynthManager.playMusic


playSFX()

playSFX(presetOrId): void

Defined in: core/SynthManager.ts:78

Play a sound effect from a preset or preset ID.

Parameters

presetOrId

string | SFXPreset

Returns

void

Implementation of

ISynthManager.playSFX


setMasterVolume()

setMasterVolume(volume): void

Defined in: core/SynthManager.ts:260

Set master volume.

Parameters

volume

number

Returns

void

Implementation of

ISynthManager.setMasterVolume


stopAll()

stopAll(): void

Defined in: core/SynthManager.ts:268

Stop all sounds and reset.

Returns

void

Implementation of

ISynthManager.stopAll


stopMusic()

stopMusic(): void

Defined in: core/SynthManager.ts:240

Stop background music.

Returns

void

Implementation of

ISynthManager.stopMusic