VADModule

TypeScript API implementation of the useVAD hook.

API Reference

• For detailed API Reference for VADModule see: VADModule API Reference.
• For all VAD models available out-of-the-box in React Native ExecuTorch see: VAD Models.

High Level Overview

import { VADModule, FSMN_VAD } from 'react-native-executorch';

const model = new VADModule();
await model.load(FSMN_VAD, (progress) => {
  console.log(progress);
});

await model.forward(waveform);

Methods

All methods of VADModule are explained in details here: VADModule API Reference

Loading the model

To initialize the module, create an instance and call the load method with the following parameters:

• model - Object containing:

  • modelSource - Location of the used model.

• onDownloadProgressCallback - Callback to track download progress.

This method returns a promise, which can resolve to an error or void.

For more information on loading resources, take a look at loading models page.

Running the model

To run the model, you can use the forward method on the module object. Before running the model's forward method, make sure to extract the audio waveform you want to process. You'll need to handle this step yourself, ensuring the audio is sampled at 16 kHz. Once you have the waveform, pass it as an argument to the forward method. The method returns a promise that resolves to the array of detected speech segments.

Managing memory

The module is a regular JavaScript object, and as such its lifespan will be managed by the garbage collector. In most cases this should be enough, and you should not worry about freeing the memory of the module yourself, but in some cases you may want to release the memory occupied by the module before the garbage collector steps in. In this case use the method delete on the module object you will no longer use, and want to remove from the memory. Note that you cannot use forward after delete unless you load the module again.