@tilde-nlp/asr-client v1.0.0

asr-api-client library

Library is created for implementing dictation. There is no UI components as this package is meant to be only as service for comunication.

Examples

Execute this code when you need to start recording voice, and replace configuration values as necessary.

First, you need to create new AsrClient. For more info about configuration - check asr-client-configuration interface.

const config: AsrClientConfiguration = {
      appId: YOUR_APP_ID, // ask from person responsible for implementation
      appSecret: YOUR_APP_SECRET, // ask from person responsible for implementation
      language: LANGUAGE, // input language
      apiUrl: API_URL, // defaults to "runa.tilde.lv"
      visualizerId: VISUALIZER_ID, // id for canvas element if you would like to see audio visualization
      onResult: result => console.log(result), // partial or final result
      onRecordingStartStop: isRecording=> console.log(isRecording), // boolean value emitted whenever isRecording changes
      onError: error=> console.error(error) // error callback
    }
const asrClient = new AsrClient(config);

then you have access to method to start recording

asrClient.beginVoiceRecognition();

to stop recording

asrClient.endVoiceRecognition();

When you have created client, you can also access visualizer and see input visualization

asrClient.audioVisualizer?.visualizeAudio()