API reference
AudioSynthContextValue
strata-game-library/audio-synth
strata-game-library/audio-synth
strata-game-library/audio-synth / AudioSynthContextValue
Interface: AudioSynthContextValue
Defined in: core/types.ts:166
Audio context value for React context.
Properties
isReady
isReady:
boolean
Defined in: core/types.ts:170
Whether audio is ready
manager
manager:
ISynthManager|null
Defined in: core/types.ts:168
Synth manager instance
playMusic()
playMusic: (
patternId) =>void
Defined in: core/types.ts:174
Play background music
Parameters
patternId
string
Returns
void
playSFX()
playSFX: (
preset) =>void
Defined in: core/types.ts:172
Play a sound effect
Parameters
preset
string | SFXPreset
Returns
void
setMasterVolume()
setMasterVolume: (
volume) =>void
Defined in: core/types.ts:178
Set master volume
Parameters
volume
number
Returns
void
stopMusic()
stopMusic: () =>
void
Defined in: core/types.ts:176
Stop background music
Returns
void
