IUseAudioProps

interface
Media

Props for the low-level useAudio composable — wires a frequency analyser and a play-on-flag mechanism. Renamed from IAudioProps to avoid collision with the OrigamAudio component interface.

TypeScript

Definition

The TypeScript interface definition as found in the origam source. Click the copy icon to copy the snippet.

typescript

API

Properties

Every property declared by this interface, with its type, optionality and default.

audio
string
URL or data-URI of the audio source to load into the analyser.
playAudio
boolean
Reactive flag — when toggled to true the composable starts playback; false pauses it.

Ecosystem

Used by

Components and composables that extend or consume this interface.

Usage

Examples

Ready-to-paste code snippets using this interface.

Consuming useAudio with typed props

typescript