IAudioScopedSlotBindings
interface
Slots
Bindings handed to the #controls scoped slot of <OrigamAudio>. State is exposed as plain unwrapped values (snapshot at render time) — Vue reactive re-invokes the slot on every meaningful change.
TypeScript
Definition
The TypeScript interface definition as found in the origam source. Click the copy icon to copy the snippet.
API
Properties
Every property declared by this interface, with its type, optionality and default.
- playingrequiredboolean
- True while the audio is actively playing.
- pausedrequiredboolean
- True while the audio is paused.
- currentTimerequirednumber
- Current playhead position in seconds.
- durationrequirednumber
- Total duration of the current track in seconds.
- bufferedrequirednumber
- Amount of audio buffered, in seconds.
- volumerequirednumber
- Current volume level (0..1).
- mutedrequiredboolean
- True when the audio is muted.
- playbackRaterequirednumber
- Current playback rate (e.g. 1 = normal speed, 2 = double speed).
- loadingrequiredboolean
- True while the audio source is loading.
- errorrequiredMediaError | Error | null
- The current error object, or null when no error.
- methodsrequiredIAudioPlayerMethods
- Imperative player methods (play, pause, seek, setVolume, …) from useAudioPlayer.
Ecosystem
Used by
Components and composables that extend or consume this interface.
Usage
Examples
Ready-to-paste code snippets using this interface.
Custom controls via the #controls scoped slot