Help Center/ MetaStudio/ API Reference/ Intelligent Interaction/ Intelligent Interaction Client SDK/ Web SDK/ API Reference/ Web Voice Wakeup
Updated on 2025-05-08 GMT+08:00
View PDF
Share

Web Voice Wakeup

Wakeup (see Preset Wakeup Capability) is a preset capability of MetaStudio. To update the wakeup phrases, follow Custom Wakeup Capability. MetaStudio will provide you with the custom wakeup model. You need to update the model to a local model path by referring to Updating a Wakeup Model.

Usage Requirements

  • The web SDK should be 3.0.1 or later.
  • Only the ASR configured on MetaStudio or the preset ASR (TTS) is supported. Virtual avatar control using a WebSocket API, that is, text control, is not supported.
  • Before calling the API create, you must have clicked the page integrated with the web SDK.

    Only with click operations can the browser obtain the permission to collect sound. Sound collection is a must-have for using voice wakeup.

  • Use a supported browser by referring to Table 1.
    Table 1 Browser compatibility

    OS

    Browser

    Browser Version

    Windows

    Google Chrome

    91+

    Microsoft Edge

    91+

    Android

    Mobile Google Chrome

    91+

    iOS

    Mobile Safari

    17.3+

    macOS

    Safari

    16.5+

Preset Wakeup Capability

The web SDK has supported wakeup since 3.0.1. However, if a WebSocket API is used for virtual avatar control, the preset voice wakeup capability of the web SDK is not available. Preset wakeup allows using three wakeup phrases ("Hello, Sara", "Wait a moment", and "Thank you") to wake up a virtual avatar, interrupt and exit a dialog.

You can call the API create and configure the parameter enableLocalWakeup in config to enable voice wakeup.

Custom Wakeup Capability

If the customer wants to use organization-specific wakeup phrases, they need to contact MetaStudio technical support to customize a wakeup model. Wakeup model customization takes about five working days, with up to eight custom wakeup phrases.

Examples of custom wakeup phrases:

  • Wakeup: Hello/Hi, Sara
  • Interruption: Wait a moment
  • Exiting: Thank you/Goodbye

Updating a Wakeup Model

After obtaining the wakeup model customized by MetaStudio, the customer needs to replace the original hwICSUiSdk file modelData.js. Then, place wasmData.js and modelData.js in the project's static resource folder or other locations accessible through HTTP requests. Finally, call the API initResourcePath to set a correct resource path, and call the API create or setConfig to create an interaction task.

Figure 1 Replacing the file modelData.js
Parent Topic: API Reference