@camera.ui/sdk / plugin / AudioDetectionInterface

Interface: AudioDetectionInterface

Defined in: plugin/interfaces.ts:227

Interface for plugins that provide audio detection. Implement testAudioDetection() to handle detection test requests from the UI.

Methods

audioDetectionSettings()?

optional audioDetectionSettings(): Promise<JsonSchema[] | undefined>

Defined in: plugin/interfaces.ts:233

Optional settings schema for audio detection configuration UI

Returns

Promise<JsonSchema[] | undefined>

---

detectAudio()?

optional detectAudio(audio, config?): Promise<AudioDetectionPluginResponse | undefined>

Defined in: plugin/interfaces.ts:231

Run audio detection on pre-processed audio frames. Used by automations/benchmarks.

Parameters

audio

AudioFrameData

config?

Record<string, unknown>

Returns

Promise<AudioDetectionPluginResponse | undefined>

---

testAudioDetection()

testAudioDetection(audioData, metadata, config): Promise<AudioDetectionPluginResponse | undefined>

Defined in: plugin/interfaces.ts:229

Run audio detection on audio data. Used by the UI for testing/previewing.

Parameters

audioData

Buffer<ArrayBufferLike> | Uint8Array<ArrayBufferLike>

metadata

AudioMetadata

config

Record<string, unknown>

Returns

Promise<AudioDetectionPluginResponse | undefined>