Home
API reference

ISynthManager

strata-game-library/audio-synth

strata-game-library/audio-synth


strata-game-library/audio-synth / ISynthManager

Interface: ISynthManager

Defined in: core/types.ts:144

Synth manager interface.

Methods

dispose()

dispose(): void

Defined in: core/types.ts:160

Dispose all resources

Returns

void


init()

init(): Promise<void>

Defined in: core/types.ts:146

Initialize the audio context

Returns

Promise<void>


isReady()

isReady(): boolean

Defined in: core/types.ts:148

Check if initialized

Returns

boolean


playMusic()

playMusic(patternId): void

Defined in: core/types.ts:152

Play background music

Parameters

patternId

string

Returns

void


playSFX()

playSFX(preset): void

Defined in: core/types.ts:150

Play a sound effect

Parameters

preset

string | SFXPreset

Returns

void


setMasterVolume()

setMasterVolume(volume): void

Defined in: core/types.ts:156

Set master volume

Parameters

volume

number

Returns

void


stopAll()

stopAll(): void

Defined in: core/types.ts:158

Stop all sounds

Returns

void


stopMusic()

stopMusic(): void

Defined in: core/types.ts:154

Stop background music

Returns

void