undertone

Appearance

@liminal-hq/undertone / PlayOptions

Interface: PlayOptions ​

Defined in: scheduler.ts:21

Properties ​

bpm? ​

optional bpm?: number

Defined in: scheduler.ts:25

Tempo in beats per minute, four beats to a cycle. Default 120 (2-second cycles).

ctx? ​

optional ctx?: AudioContextLike

Defined in: scheduler.ts:23

Audio context to schedule against; a lazily-created shared AudioContext when omitted.

gated? ​

optional gated?: boolean

Defined in: scheduler.ts:34

Hold each event's envelope at its sustain level for its own share of the cycle, exactly like loop() — for previewing what one looped cycle will sound like. Default false: envelopes stay percussive (0.1.x SFX behaviour), which is what one-shot game sound effects want.

when? ​

optional when?: number

Defined in: scheduler.ts:27

Absolute start time on the context's clock. Default: now.