Home
API reference

SFXPreset

strata-game-library/audio-synth

strata-game-library/audio-synth


strata-game-library/audio-synth / SFXPreset

Interface: SFXPreset

Defined in: core/types.ts:68

SFX preset definition.

Properties

duration?

optional duration: string

Defined in: core/types.ts:86

Duration override


envelope

envelope: EnvelopeConfig

Defined in: core/types.ts:78

Envelope configuration


filter?

optional filter: FilterConfig

Defined in: core/types.ts:82

Optional filter


frequency?

optional frequency: number | FrequencySweep

Defined in: core/types.ts:80

Optional frequency sweep


id

id: string

Defined in: core/types.ts:70

Unique identifier


name

name: string

Defined in: core/types.ts:72

Display name


noise?

optional noise: object

Defined in: core/types.ts:88

Additional noise layer

envelope

envelope: EnvelopeConfig

type

type: "white" | "pink" | "brown"

volume?

optional volume: number


oscillator

oscillator: object

Defined in: core/types.ts:74

Oscillator configuration

type

type: OscillatorType


volume?

optional volume: number

Defined in: core/types.ts:84

Volume in decibels