uneeq-js 2.47.4 → 2.47.6

package/dist/src/service/api.d.ts

@@ -23,7 +23,7 @@ export declare class API {
     avatarAsk(text: string): Promise<void>;
     avatarStartRecording(): Promise<void>;
     avatarStopRecording(): Promise<void>;
-    avatarStopSpeaking(): Promise<void>;
+    stopSpeaking(): Promise<void>;
     getAvailableAvatarCount(): Promise<AvatarAvailableCountResponse>;
     startSessionWithToken(data: NewSessionRequest): Promise<NewSessionResponse>;
     setAvatarDebug(enabled: boolean): Promise<any>;

package/dist/src/service/speech-handler.d.ts

@@ -9,9 +9,15 @@ export declare class SpeechHandler {
     private recordingLive;
     private headerBlob;
     private scriptsLoadedPromise;
+    private digitalHumanSpeaking;
+    private stream;
     constructor(options: SpeechHandlerOptions);
+    stopRecognition(): void;
+    pause(): boolean;
+    resume(): boolean;
     private loadScript;
     private loadScripts;
+    private handleAppMessages;
     private initWebsocket;
     private loadSavedAudioHeaders;
     private initVoiceActivityDetection;

package/dist/src/uneeq.d.ts

@@ -102,6 +102,16 @@ export declare class Uneeq {
      * When successful a corresponding AvatarRequestCompleted should be received.
      */
     stopSpeaking(): Promise<void>;
+    /**
+     * Pause speech recognition. The users speech will not be processed, or sent off their device.
+     * This is the equivilent of muting the users microphone.
+     */
+    pauseSpeechRecognition(): boolean;
+    /**
+     * Resume speech recognition. The users speech will being being processed again.
+     * This is the equivilent of unmuting the users microphone.
+     */
+    resumeSpeechRecognition(): boolean;
     /**
      * Pauses a live session. Local video and audio will stop being sent and remote avatar video audio will be stopped.
      * On success, SessionPausedMessage will be sent.

package/dist/umd/index.js

@@ -3900,7 +3900,27 @@ class Uneeq {
      * When successful a corresponding AvatarRequestCompleted should be received.
      */
     stopSpeaking() {
-        return this.api.avatarStopSpeaking();
+        return this.api.stopSpeaking();
+    }
+    /**
+     * Pause speech recognition. The users speech will not be processed, or sent off their device.
+     * This is the equivilent of muting the users microphone.
+     */
+    pauseSpeechRecognition() {
+        if (this.speechHandler) {
+            return this.speechHandler.pause();
+        }
+        return false;
+    }
+    /**
+     * Resume speech recognition. The users speech will being being processed again.
+     * This is the equivilent of unmuting the users microphone.
+     */
+    resumeSpeechRecognition() {
+        if (this.speechHandler) {
+            return this.speechHandler.resume();
+        }
+        return false;
     }
     /**
      * Pauses a live session. Local video and audio will stop being sent and remote avatar video audio will be stopped.
@@ -13240,7 +13260,7 @@ exports.race = race;
 /***/ ((module) => {
 
 "use strict";
-module.exports = JSON.parse('{"name":"uneeq-js","version":"2.47.4","description":"","main":"dist/index.js","types":"dist/src/index.d.ts","scripts":{"start":"npx webpack -w","test-local":"npx karma start karma.conf.js -logLevel=DEBUG","test":"npx karma start --browsers ChromeHeadless --single-run","test:windows":"karma start karma.conf.js","build":"webpack --config webpack.config.prod.js && webpack --config webpack.config.umd.js","lint":"npx tslint -p tsconfig.json --fix","docs":"npx typedoc --options"},"files":["dist","!dist/test"],"author":"","license":"ISC","dependencies":{"@stomp/stompjs":"^6.0.0","@uehreka/seriously":"^1.0.1","fast-text-encoding":"^1.0.0","intrinsic-scale":"^3.0.4","onnxruntime-web":"^1.15.1","promjs":"^0.4.1","ring-buffer-ts":"^1.2.0","rxjs":"^7.8.1","rxjs-compat":"^6.6.7","simple-peer":"^9.11.1","webrtc-adapter":"^8.2.3"},"devDependencies":{"@types/dom-mediacapture-record":"^1.0.16","@types/jasmine":"^2.8.8","@types/node":"^10.9.4","fetch-mock":"7.7.3","ignore-styles":"^5.0.1","jasmine":"^5.1.0","jasmine-core":"^5.1.0","karma":"^6.4.2","karma-chrome-launcher":"^3.2.0","karma-firefox-launcher":"^2.1.2","karma-jasmine":"^5.1.0","karma-jasmine-html-reporter":"^2.1.0","karma-requirejs":"^1.1.0","karma-typescript":"^5.5.4","karma-typescript-es6-transform":"^5.5.4","nock":"^9.6.1","requirejs":"^2.3.6","ts-loader":"^9.4.4","ts-node":"^7.0.1","tslint":"^5.11.0","tslint-no-focused-test":"^0.5.0","typedoc":"^0.18.0","typescript":"^5.1.6","webpack":"^5.88.2","webpack-cli":"^5.1.4"}}');
+module.exports = JSON.parse('{"name":"uneeq-js","version":"2.47.6","description":"","main":"dist/index.js","types":"dist/src/index.d.ts","scripts":{"start":"npx webpack -w","test-local":"npx karma start karma.conf.js -logLevel=DEBUG","test":"npx karma start --browsers ChromeHeadless --single-run","test:windows":"karma start karma.conf.js","build":"webpack --config webpack.config.prod.js && webpack --config webpack.config.umd.js","lint":"npx tslint -p tsconfig.json --fix","docs":"npx typedoc --options"},"files":["dist","!dist/test"],"author":"","license":"ISC","dependencies":{"@stomp/stompjs":"^6.0.0","@uehreka/seriously":"^1.0.1","fast-text-encoding":"^1.0.0","intrinsic-scale":"^3.0.4","onnxruntime-web":"^1.15.1","promjs":"^0.4.1","ring-buffer-ts":"^1.2.0","rxjs":"^7.8.1","rxjs-compat":"^6.6.7","simple-peer":"^9.11.1","webrtc-adapter":"^8.2.3"},"devDependencies":{"@types/dom-mediacapture-record":"^1.0.16","@types/jasmine":"^2.8.8","@types/node":"^10.9.4","fetch-mock":"7.7.3","ignore-styles":"^5.0.1","jasmine":"^5.1.0","jasmine-core":"^5.1.0","karma":"^6.4.2","karma-chrome-launcher":"^3.2.0","karma-firefox-launcher":"^2.1.2","karma-jasmine":"^5.1.0","karma-jasmine-html-reporter":"^2.1.0","karma-requirejs":"^1.1.0","karma-typescript":"^5.5.4","karma-typescript-es6-transform":"^5.5.4","nock":"^9.6.1","requirejs":"^2.3.6","ts-loader":"^9.4.4","ts-node":"^7.0.1","tslint":"^5.11.0","tslint-no-focused-test":"^0.5.0","typedoc":"^0.18.0","typescript":"^5.1.6","webpack":"^5.88.2","webpack-cli":"^5.1.4"}}');
 
 /***/ }),
 /* 242 */
@@ -13293,7 +13313,7 @@ class API {
     avatarStopRecording() {
         return this.postRequest('/api/v1/avatar/' + this._callId + '/audioCapture/stop');
     }
-    avatarStopSpeaking() {
+    stopSpeaking() {
         return this.postRequest('/api/v1/avatar/' + this._callId + '/stopSpeaking');
     }
     getAvailableAvatarCount() {
@@ -51174,11 +51194,44 @@ class SpeechHandler {
         this.logPrefix = 'UneeQ: Speech Recognition: ';
         this.speechBuffer = new ring_buffer_ts_1.RingBuffer(speechBufferLength);
         this.recordingLive = false;
-        console.warn('UneeQ: SPEECH_RECOGNITION input mode is in development, you may experience issues.');
+        this.digitalHumanSpeaking = false;
+        console.warn(this.logPrefix + 'SPEECH_RECOGNITION input mode is in development, you may experience issues.');
         this.options.assetBasePath = this.options.assetBasePath || defaultAssetPath;
         this.loadSavedAudioHeaders();
         this.loadScripts();
         this.initWebsocket(this.options);
+        this.handleAppMessages();
+    }
+    stopRecognition() {
+        if (this.mediaRecorder) {
+            this.mediaRecorder.stop();
+        }
+        if (this.stream) {
+            this.stream.getTracks().forEach((track) => {
+                track.stop();
+            });
+        }
+        if (this.micVad) {
+            this.micVad.pause();
+        }
+    }
+    pause() {
+        if (this.stream && this.micVad) {
+            this.stream.getTracks().forEach((track) => track.enabled = false);
+            this.micVad.pause();
+            return true;
+        }
+        logger_1.logger.warn(this.logPrefix + 'Could not pause speech recognition.');
+        return false;
+    }
+    resume() {
+        if (this.stream && this.micVad) {
+            this.stream.getTracks().forEach((track) => track.enabled = true);
+            this.micVad.start();
+            return true;
+        }
+        logger_1.logger.warn(this.logPrefix + 'Could not resume speech recognition.');
+        return false;
     }
     loadScript(url) {
         return new Promise((resolve) => {
@@ -51201,6 +51254,22 @@ class SpeechHandler {
             });
         });
     }
+    handleAppMessages() {
+        this.options.messages.subscribe((msg) => {
+            switch (msg.uneeqMessageType) {
+                case MessageTypes_1.UneeqMessageType.StartedSpeaking:
+                    this.digitalHumanSpeaking = true;
+                    break;
+                case MessageTypes_1.UneeqMessageType.FinishedSpeaking:
+                    this.digitalHumanSpeaking = false;
+                    break;
+                case MessageTypes_1.UneeqMessageType.SessionEnded:
+                    this.stopRecognition();
+                    break;
+                default:
+            }
+        });
+    }
     initWebsocket(options) {
         let connectionUrl = options.apiUrl.replace('https://api.', 'wss://speech-recognition-service.');
         connectionUrl += '/ws/recognize?session_id=' + options.sessionId;
@@ -51304,6 +51373,7 @@ class SpeechHandler {
     initMicrophone() {
         navigator.mediaDevices.getUserMedia({ audio: { sampleRate: audioSampleRate, channelCount: audioChannelCount } })
             .then((stream) => {
+            this.stream = stream;
             this.initVoiceActivityDetection(stream);
             this.initMediaRecorder(stream);
         })
@@ -51343,6 +51413,10 @@ class SpeechHandler {
         if (result.final) {
             this.options.api.avatarAsk(result.transcript);
         }
+        else if (this.digitalHumanSpeaking) {
+            this.options.api.stopSpeaking();
+            this.digitalHumanSpeaking = false;
+        }
         this.options.messages.next(new MessageTypes_1.SpeechTranscriptionMessage(result));
     }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "uneeq-js",
-  "version": "2.47.4",
+  "version": "2.47.6",
   "description": "",
   "main": "dist/index.js",
   "types": "dist/src/index.d.ts",

package/readme.md

@@ -8,6 +8,12 @@ https://docs.uneeq.io/build-your-own-experience
 To use uneeq-js with a typescript version < 3.8, 'skipLibCheck' must be set to true.
 
 ## Release Notes
+#### 2.47.6
+* Speech Recognition: added support for pause and resume.
+
+#### 2.47.5
+* Speech Recognition mode: Stop the digital human from speaking when an interim speech result is received.
+
 #### 2.47.4
 * Fixed a race condition when loading speech recognition assets