eo-typewriterjs / TAudioChannelOptions
Type Alias: TAudioChannelOptions
ts
type TAudioChannelOptions = object;Defined in: core/audio/types/audio-channel-options.type.ts:9
Description
Configuration for a single audio channel (typing or delete)
Properties
| Property | Modifier | Type | Description | Defined in |
|---|---|---|---|---|
sfx? | readonly | string | Description Name of the default sfx to use from the sfx pack. When not set, the first sfx in the pack is used. | core/audio/types/audio-channel-options.type.ts:15 |
sfxs? | readonly | readonly string[] | Description Restrict sample selection to this subset of sfx names. When set, only the listed sfxs are eligible for this channel. Overrides sfx when both are present. | core/audio/types/audio-channel-options.type.ts:23 |
strategy? | readonly | TAudioStrategy | Description Sample selection strategy. Defaults to "shuffleBag" for natural variance without repetitive streaks. | core/audio/types/audio-channel-options.type.ts:30 |
avoidImmediateRepeat? | readonly | boolean | Description When true, the manager will never play the same sample twice in a row. Only meaningful for the "random" strategy; shuffle-bag already handles this structurally. Defaults to true. | core/audio/types/audio-channel-options.type.ts:38 |
playbackRateJitter? | readonly | object | Description Optional playback-rate jitter applied to each sample for extra variance. Both min and max must be positive. Example: { min: 0.9, max: 1.1 }. When omitted, no jitter is applied. | core/audio/types/audio-channel-options.type.ts:46 |
playbackRateJitter.min | readonly | number | - | core/audio/types/audio-channel-options.type.ts:47 |
playbackRateJitter.max | readonly | number | - | core/audio/types/audio-channel-options.type.ts:48 |
volumeJitter? | readonly | object | Description Optional per-play volume jitter relative to the resolved channel volume. Range [0, 1] for both min and max. Example: { min: 0.8, max: 1.0 }. When omitted, no jitter is applied. | core/audio/types/audio-channel-options.type.ts:57 |
volumeJitter.min | readonly | number | - | core/audio/types/audio-channel-options.type.ts:58 |
volumeJitter.max | readonly | number | - | core/audio/types/audio-channel-options.type.ts:59 |
overlap? | readonly | boolean | Description When true, a new audio element is cloned for every play call so rapid typing does not cut off the previous sound. When false, the previous sound is interrupted. Defaults to true. | core/audio/types/audio-channel-options.type.ts:69 |