Class VAD

constructor

• new VAD(session, opts): VAD

• Parameters

  • session: InferenceSession
  • opts: VADOptions

  Returns VAD

label

stream

• stream(): VADStream

• Returns a VADStream that can be used to push audio frames and receive VAD events.

  Returns VADStream

updateOptions

• updateOptions(opts): void

• Updates the VAD options with new values.

  Parameters

  • opts: Partial<VADOptions>

    Partial options object containing the values to update

  Returns void

  Remarks

  This method will merge the provided options with existing options and update all active streams. Only the properties specified in opts will be updated, other properties retain their current values.

Static load

• load(opts?): Promise<VAD>

• Load and initialize the Silero VAD model.

  This method loads the ONNX model and prepares it for inference. When options are not provided, sane defaults are used.

  Parameters

  • opts: Partial<VADOptions> = {}

  Returns Promise<VAD>

  Promise<VAD>: An instance of the VAD class ready for streaming.

  Remarks

  This method may take time to load the model into memory. It is recommended to call this method inside your prewarm mechanism.

  Example

  export default defineAgent({
    prewarm: async (proc: JobProcess) => {
      proc.userData.vad = await VAD.load();
    },
    entry: async (ctx: JobContext) => {
      const vad = ctx.proc.userData.vad! as VAD;
      // the rest of your agent logic
    },
  });
  Copy