Function: useVoiceActivityDetector()

useVoiceActivityDetector(config, options?): object

Defined in: hooks/useVoiceActivityDetector.ts:24

React hook to load and run a Voice Activity Detection (VAD) model.

This hook manages downloading (if remote URLs are provided) and loading the model assets, compiling them, tracking download progress and load errors, and releasing native memory when the component unmounts or the configuration changes.

For imperative usage, see createFsmnVoiceActivityDetector.

Parameters

config

FsmnVadModel

The VAD model configuration. See FsmnVadModel.

options?

ResourceOptions

Load and caching options. See ResourceOptions.

Returns

object

The same object as FsmnVoiceActivityDetector (without dispose), combined with loading state and download progress.

detectVoice

detectVoice: any = model.detectVoice

detectVoiceOnStream

detectVoiceOnStream: any = model.detectVoiceOnStream

detectVoiceWorklet

detectVoiceWorklet: any = model.detectVoiceWorklet

downloadProgress

downloadProgress: any

error

error: any

isReady

isReady: boolean = !!model

resetStream

resetStream: any = model.resetStream

resource

resource: any

See

FsmnVoiceActivityDetector