Skip to content

Function: useAudioPlayerState() ​

useAudioPlayerState<Selected>(selector, target?): ComputedRef<Selected | undefined>

Defined in: audio/composables.ts:18

Subscribe to an audio snapshot selection; unavailable players yield undefined.

Type Parameters ​

Selected ​

Selected

Parameters ​

selector ​

(state) => Selected

Selects from the immutable upstream audio snapshot.

target? ​

AudioPlayerTarget

Explicit player target, or injected audio context when omitted.

Returns ​

ComputedRef<Selected | undefined>

A readonly selection, undefined while unavailable.