Skip to main content

Function: routeAudioToSink()

function routeAudioToSink(
onFeedback: (listener: FeedbackListener) => Unsubscribe,
sink: FeedbackAudioSink,
cueMap: Partial<Record<FeedbackCue, string>>,
gainScale?: number
): Unsubscribe;

Defined in: packages/webxr-interactions/src/feedback.ts:71

Client opt-in: play a sound for the feedback intents named in cueMap. Cues absent from the map are ignored, so an app sonifies only the moments it has sounds for. Gain is the intent's intensity scaled by gainScale, capped at 1. Returns the unsubscribe.

Parameters

ParameterTypeDefault value
onFeedback(listener: FeedbackListener) => Unsubscribeundefined
sinkFeedbackAudioSinkundefined
cueMapPartial<Record<FeedbackCue, string>>undefined
gainScalenumber1

Returns

Unsubscribe