Interface SoundOptions

interface SoundOptions {
    caption?: string;
    create?: (path: string) => Playable;
    poolSize?: number;
    volume?: number;
}

Properties

caption?: string

shown by a captioning overlay (via Captions.onCaption) every time this sound plays

create?: (path: string) => Playable

creates one playable instance for the resolved path; defaults to a real Audio element

poolSize?: number

overlapping instances before the oldest is reused; a footstep needs more than a shout

volume?: number