uneeq-js 2.42.2 → 2.43.0

package/dist/src/service/digital-human-video-play-manager.d.ts

@@ -1,9 +1,10 @@
 import { Subject } from 'rxjs';
 export declare class DigitalHumanVideoPlayManager {
     private messages;
+    private publicUnmuteDigitalHumanMethod;
     private video;
     private remoteVideoPlayCount;
-    constructor(messages: Subject<any>);
+    constructor(messages: Subject<any>, publicUnmuteDigitalHumanMethod: () => void);
     play(video: HTMLVideoElement): void;
     unmuteVideo(): void;
     private playRemoteVideo;

package/dist/src/service/voice-input-manager.d.ts

@@ -16,11 +16,13 @@ export declare class VoiceInputManager {
     private digitalHumanSpeaking;
     private recording;
     private silenceTimeout?;
+    private stream?;
     constructor(options: UneeqOptions, api: API, messages: Subject<any>, enableMicrophone: (enabled: boolean) => void);
     setVoiceInputMode(mode: VoiceInputMode | string): void;
     startRecording(): void;
     stopRecording(): void;
     handleSessionEnd(): void;
+    resumeAudioContext(): void;
     initMicActivity(stream: MediaStream): void;
     private audioContextNotSupported;
     private handleAppMessages;

package/dist/src/types/PersonaStartRequest.d.ts

@@ -1,3 +1,5 @@
 export interface PersonaStartRequest {
     enableTransparentBackground?: boolean;
+    backgroundImageUrl?: string;
+    nameTagImageUrl?: string;
 }

package/dist/src/types/UneeqOptions.d.ts

@@ -53,4 +53,12 @@ export interface UneeqOptions {
      * This option specifies what the default voice input mode will be.
      */
     voiceInputMode: VoiceInputMode | string;
+    /**
+     * This option specifies the URL of the background image to be used when the digital human is rendered.
+     */
+    backgroundImageUrl?: string;
+    /**
+     * This option specifies the URL of the name tag image to be used when the digital human is rendered.
+     */
+    nameTagImageUrl?: string;
 }

package/dist/src/uneeq.d.ts

@@ -27,6 +27,7 @@ export declare class Uneeq {
     private availableResponseTime;
     private streamManager;
     constructor(options: UneeqOptions);
+    setLoggerEnabled(enabled: boolean): void;
     /**
      * Initialise the session. ReadyMessage will be sent when init is ready.
      */

package/dist/umd/index.js

@@ -5774,7 +5774,6 @@ class Uneeq {
         this.version = package_json_1.default.version;
         this.messages = new rxjs_1.Subject();
         this.internalMessages$ = new rxjs_1.Subject();
-        this.dhVideoPlayManager = new digital_human_video_play_manager_1.DigitalHumanVideoPlayManager(this.messages);
         this.sessionPaused = false;
         this.sessionStarted = false; /* Whether the user is live in a session with an avatar (different from sessionPaused) */
         this.unavailableAvatarMsgSent = false;
@@ -5786,6 +5785,8 @@ class Uneeq {
         this.options.sendLocalAudio = options.sendLocalAudio === undefined ? true : options.sendLocalAudio;
         this.options.enableClientPerformanceMessage = options.enableClientPerformanceMessage || false;
         this.options.enableTransparentBackground = options.enableTransparentBackground || false;
+        this.options.backgroundImageUrl = options.backgroundImageUrl || '';
+        this.options.nameTagImageUrl = options.nameTagImageUrl || '';
         // TODO update default mode to VOICE_ACTIVITY once we are confident in the solution.
         this.options.voiceInputMode = options.voiceInputMode || VoiceInputMode_1.VoiceInputMode.PUSH_TO_TALK;
         this.api = new api_1.API(this.options.url, this.options.apiKey);
@@ -5804,6 +5805,11 @@ class Uneeq {
         logger_1.logger.log(`Uneeq Created (version ${this.version})`);
         this.streamManager = new stream_manager_1.StreamManager();
         this.metricsService = new metrics_service_1.MetricsService(this.options, this.internalMessages$, this.messages);
+        this.dhVideoPlayManager = new digital_human_video_play_manager_1.DigitalHumanVideoPlayManager(this.messages, () => { this.unmuteDigitalHuman(); });
+    }
+    /* Enable or disable logging */
+    setLoggerEnabled(enabled) {
+        logger_1.logger.enabled = enabled;
     }
     /**
      * Initialise the session. ReadyMessage will be sent when init is ready.
@@ -6024,6 +6030,7 @@ class Uneeq {
     }
     /* Unmute the digital human video - this might be called if the video started in muted mode.*/
     unmuteDigitalHuman() {
+        this.voiceInputManager.resumeAudioContext();
         this.dhVideoPlayManager.unmuteVideo();
     }
     gatherWebRtcMetrics() {
@@ -6092,7 +6099,6 @@ class Uneeq {
                 .filter((message) => message.faceMeMessageType === 'DevicePermissionAllowedInternal')
                 .pipe(operators_1.take(1))
                 .subscribe((msg) => {
-                console.log('DevicePermissionAllowedInternal');
                 this.messages.next(new MessageTypes_1.DevicePermissionAllowedMessage());
                 this.startAvatarWhenAvailable();
             });
@@ -6128,7 +6134,11 @@ class Uneeq {
                 };
                 this.internalMessages$.next({ faceMeMessageType: 'prom', promMsg: availabilityChkMetric });
                 this.messages.next(new MessageTypes_1.AvatarAvailableMessage());
-                this.api.avatarStart({ enableTransparentBackground: this.options.enableTransparentBackground });
+                this.api.avatarStart({
+                    enableTransparentBackground: this.options.enableTransparentBackground,
+                    backgroundImageUrl: this.options.backgroundImageUrl,
+                    nameTagImageUrl: this.options.nameTagImageUrl
+                });
             }
             else {
                 if (!this.unavailableAvatarMsgSent) {
@@ -18106,7 +18116,7 @@ function zipAll(project) {
 /* 224 */
 /***/ (function(module) {
 
-module.exports = JSON.parse("{\"name\":\"uneeq-js\",\"version\":\"2.42.2\",\"description\":\"\",\"main\":\"dist/index.js\",\"types\":\"dist/src/index.d.ts\",\"scripts\":{\"start\":\"npx webpack -w\",\"test-local\":\"./node_modules/karma/bin/karma start karma.conf.js -logLevel=DEBUG\",\"test\":\"./node_modules/karma/bin/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\":\"./node_modules/tslint/bin/tslint -p tsconfig.json --fix\",\"docs\":\"./node_modules/typedoc/bin/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\",\"promjs\":\"^0.4.1\",\"rxjs\":\"^6.2.2\",\"rxjs-compat\":\"^6.3.2\",\"simple-peer\":\"9.11.0\",\"webrtc-adapter\":\"8.1.0\"},\"devDependencies\":{\"@types/jasmine\":\"^2.8.8\",\"@types/node\":\"^10.9.4\",\"fetch-mock\":\"7.7.3\",\"ignore-styles\":\"^5.0.1\",\"jasmine\":\"^3.2.0\",\"jasmine-class-mock\":\"^1.0.1\",\"jasmine-core\":\"^3.3.0\",\"karma\":\"^5.0.0\",\"karma-chrome-launcher\":\"^2.2.0\",\"karma-firefox-launcher\":\"^1.1.0\",\"karma-jasmine\":\"^2.0.1\",\"karma-jasmine-html-reporter\":\"^1.4.0\",\"karma-requirejs\":\"^1.1.0\",\"karma-safari-launcher\":\"^1.0.0\",\"karma-typescript\":\"^5.0.0\",\"karma-typescript-es6-transform\":\"^5.0.0\",\"nock\":\"^9.6.1\",\"requirejs\":\"^2.3.6\",\"ts-loader\":\"^5.0.0\",\"ts-node\":\"^7.0.1\",\"tslint\":\"^5.11.0\",\"tslint-no-focused-test\":\"^0.5.0\",\"typedoc\":\"^0.18.0\",\"typescript\":\"^3.9.7\",\"webpack\":\"^4.17.1\",\"webpack-cli\":\"^3.1.0\"}}");
+module.exports = JSON.parse("{\"name\":\"uneeq-js\",\"version\":\"2.43.0\",\"description\":\"\",\"main\":\"dist/index.js\",\"types\":\"dist/src/index.d.ts\",\"scripts\":{\"start\":\"npx webpack -w\",\"test-local\":\"./node_modules/karma/bin/karma start karma.conf.js -logLevel=DEBUG\",\"test\":\"./node_modules/karma/bin/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\":\"./node_modules/tslint/bin/tslint -p tsconfig.json --fix\",\"docs\":\"./node_modules/typedoc/bin/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\",\"promjs\":\"^0.4.1\",\"rxjs\":\"^6.2.2\",\"rxjs-compat\":\"^6.3.2\",\"simple-peer\":\"9.11.0\",\"webrtc-adapter\":\"8.1.0\"},\"devDependencies\":{\"@types/jasmine\":\"^2.8.8\",\"@types/node\":\"^10.9.4\",\"fetch-mock\":\"7.7.3\",\"ignore-styles\":\"^5.0.1\",\"jasmine\":\"^3.2.0\",\"jasmine-class-mock\":\"^1.0.1\",\"jasmine-core\":\"^3.3.0\",\"karma\":\"^5.0.0\",\"karma-chrome-launcher\":\"^2.2.0\",\"karma-firefox-launcher\":\"^1.1.0\",\"karma-jasmine\":\"^2.0.1\",\"karma-jasmine-html-reporter\":\"^1.4.0\",\"karma-requirejs\":\"^1.1.0\",\"karma-safari-launcher\":\"^1.0.0\",\"karma-typescript\":\"^5.0.0\",\"karma-typescript-es6-transform\":\"^5.0.0\",\"nock\":\"^9.6.1\",\"requirejs\":\"^2.3.6\",\"ts-loader\":\"^5.0.0\",\"ts-node\":\"^7.0.1\",\"tslint\":\"^5.11.0\",\"tslint-no-focused-test\":\"^0.5.0\",\"typedoc\":\"^0.18.0\",\"typescript\":\"^3.9.7\",\"webpack\":\"^4.17.1\",\"webpack-cli\":\"^3.1.0\"}}");
 
 /***/ }),
 /* 225 */
@@ -32300,8 +32310,9 @@ exports.DigitalHumanVideoPlayManager = void 0;
 const MessageTypes_1 = __webpack_require__(267);
 const logger_1 = __webpack_require__(233);
 class DigitalHumanVideoPlayManager {
-    constructor(messages) {
+    constructor(messages, publicUnmuteDigitalHumanMethod) {
         this.messages = messages;
+        this.publicUnmuteDigitalHumanMethod = publicUnmuteDigitalHumanMethod;
         // Used to track the number of attempts to re-play the DH video (Safari 15+ stream not visible)
         this.remoteVideoPlayCount = 0;
     }
@@ -32319,9 +32330,9 @@ class DigitalHumanVideoPlayManager {
         // Play the digital human video when session is live (i.e. video and audio streaming in both directions)
         if (this.video) {
             /*
-            Note: do not set autplay = true, or safari will handle the play() differently to Chrome
+            Note: do not set autoplay = true, or safari will handle the play() differently to Chrome
             When autoplay is set to true Safari will automatically try to play the video as muted. This
-            causes the second play as muted behaviour to fail and fall in our catch block. The consequence
+            causes the second play as muted behavior to fail and fall in our catch block. The consequence
             is that the DigitalHumanPlayedInMutedModeSuccess is not sent. tldr; do not set autoplay = true
             */
             // Catch general video errors and video unmute errors
@@ -32337,7 +32348,7 @@ class DigitalHumanVideoPlayManager {
                     logger_1.logger.log('Muting the digital human and playing it succeeded.');
                     // video did play once it was muted.
                     this.messages.next(new MessageTypes_1.DigitalHumanPlayedInMutedModeSuccess());
-                    this.video.addEventListener('click', () => { this.unmuteVideo(); }, { once: true });
+                    this.video.addEventListener('click', () => { this.publicUnmuteDigitalHumanMethod(); }, { once: true });
                 })
                     .catch((err) => {
                     logger_1.logger.log('Could not play digital human video even as muted, starting exponential backoff.', err);
@@ -53423,6 +53434,7 @@ const operators_1 = __webpack_require__(126);
 const soundmeter_1 = __webpack_require__(307);
 const MessageTypes_1 = __webpack_require__(267);
 const VoiceInputMode_1 = __webpack_require__(308);
+const logger_1 = __webpack_require__(233);
 class VoiceInputManager {
     constructor(options, api, messages, enableMicrophone) {
         this.options = options;
@@ -53483,7 +53495,18 @@ class VoiceInputManager {
             this.soundMeter.stop();
         }
     }
+    /* If the publish audio context is resumed, we want to re-init the mic activity monitoring */
+    resumeAudioContext() {
+        logger_1.logger.log('UneeQ: resuming publish stream audio context and initializing mic activity.');
+        if (this.audioContext) {
+            this.audioContext.resume();
+            if (this.stream) {
+                this.initMicActivity(this.stream);
+            }
+        }
+    }
     initMicActivity(stream) {
+        this.stream = stream;
         this.soundMeter = new soundmeter_1.SoundMeter(this.audioContext);
         this.soundMeter.connectToSource(stream, (e) => this.micActivityConnected(e));
     }
@@ -53498,6 +53521,7 @@ class VoiceInputManager {
         this.messages.subscribe((msg) => {
             switch (msg.uneeqMessageType) {
                 case MessageTypes_1.UneeqMessageType.StartedSpeaking:
+                    console.log('StartSpeaking message');
                     this.digitalHumanSpeaking = true;
                     break;
                 case MessageTypes_1.UneeqMessageType.FinishedSpeaking:
@@ -53555,7 +53579,7 @@ class VoiceInputManager {
         // Run Volume Activity detection process
         if (this.options.voiceInputMode === VoiceInputMode_1.VoiceInputMode.VOICE_ACTIVITY &&
             (!this.digitalHumanSpeaking || this.voiceActivityAllowInterruptions)) {
-            // possible improvement: system could wait to get multiple activty messages above threshold before starting recording
+            // possible improvement: system could wait to get multiple activity messages above threshold before starting recording
             if (level > this.microphoneEngageVolume) {
                 if (!this.recording) {
                     this.apiStartRecording();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "uneeq-js",
-  "version": "2.42.2",
+  "version": "2.43.0",
   "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.43.0
+* Adding support for setting a background image and name tag image when starting a session using new fields in UneeqOptions. Url restrictions apply, please reach out to the Customer Service team.
+
+#### 2.42.3
+* Fixed issue that caused voiceActivity input not to work when using autoStart
+
 #### 2.42.2
 * Improved responsiveness of RecordingStartedMessage when using VOICE_ACTIVITY input mode.