Docs

Sound banks & previews ​

Resolve state-specific sounds and local auditions.

Generated from the reviewed SDK 0.1.0 contract snapshot. Unreviewed workspace changes are not included.

Public exports ​

Import from @scape/sdk.

GizmoPreview, gizmoPreviewError, resolveGizmoSounds.

Type declarations ​

These declarations preserve source comments and related types. Import only the public exports listed above; module-relative paths below describe how the package is organized.

ts
import { type ObjectDefinition } from './api.js';
import { type GizmoSounds, type GizmoSound } from './audio.js';
export interface GizmoPreview {
    sound: GizmoSound;
    gain: number;
}
export declare function gizmoPreviewError(value: unknown): string | null;
/** State-dependent recipes are prepared/cached by the host; synthesis never runs in a definition callback. */
export declare function resolveGizmoSounds(definition: ObjectDefinition, state: unknown): GizmoSounds;

Usage and limits ​

See Gizmo guides, working examples, and limits for lifecycle, validation and host behavior.

All SDK exports