@telegenta/webclient 3.2.2 → 3.4.0

package/demos/phone_client.html

@@ -245,6 +245,9 @@
 
                                 // Enable call initialized tone
                                 playCallInitializedTone: true,
+
+                                // Enable call ended tone
+                                playCallEndedTone: true,
                             };
 
                             try {

package/dist/telegenta.js

@@ -219,15 +219,15 @@ function createUUID() {
         d += performance.now(); //use high-precision timer if available
     }
     return 'xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx'.replace(/[xy]/g, function (c) {
-        let r = (d + Math.random() * 16) % 16 | 0;
+        let r = ((d + Math.random() * 16) % 16) | 0;
         d = Math.floor(d / 16);
-        return (c === 'x' ? r : (r & 0x3 | 0x8)).toString(16);
+        return (c === 'x' ? r : (r & 0x3) | 0x8).toString(16);
     });
 }
 
 // Compare properties of two objects. Comparison check if all properties in obj1 exists and has same values in obj2
 function compareObjects(obj1, obj2) {
-    if ((!obj1) || (!obj2)) {
+    if (!obj1 || !obj2) {
         return false;
     }
 
@@ -241,7 +241,7 @@ function compareObjects(obj1, obj2) {
             return false;
         }
 
-        return (obj1[k] === obj2[k]);
+        return obj1[k] === obj2[k];
     });
 }
 
@@ -257,13 +257,13 @@ function createDurationString(milliSeconds) {
     }
     // Hour
     if (seconds / 3600 >= 1) {
-        s = s + Math.floor(seconds / 3600) % 24 + 'h ';
+        s = s + (Math.floor(seconds / 3600) % 24) + 'h ';
     }
 
     // Seconds
     if (seconds >= 0) {
-        s = s + ("00" + Math.floor(seconds / 60) % 60).slice(-2) + ':';
-        s = s + ("00" + (seconds % 60)).slice(-2);
+        s = s + ('00' + (Math.floor(seconds / 60) % 60)).slice(-2) + ':';
+        s = s + ('00' + (seconds % 60)).slice(-2);
     } else {
         s = '00:00';
     }
@@ -273,23 +273,23 @@ function createDurationString(milliSeconds) {
 
 // Browser checks
 function browserIsOpera() {
-    return ((navigator.userAgent.indexOf("Opera") || navigator.userAgent.indexOf('OPR')) !== -1)
+    return (navigator.userAgent.indexOf('Opera') || navigator.userAgent.indexOf('OPR')) !== -1;
 }
 
 function browserIsChrome() {
-    return (navigator.userAgent.indexOf("Chrome") !== -1)
+    return navigator.userAgent.indexOf('Chrome') !== -1;
 }
 
 function browserIsFirefox() {
-    return (navigator.userAgent.indexOf("Firefox") !== -1)
+    return navigator.userAgent.indexOf('Firefox') !== -1;
 }
 
 function browserIsSafari() {
-    return (navigator.userAgent.indexOf("Safari") !== -1)
+    return navigator.userAgent.indexOf('Safari') !== -1;
 }
 
 function browserIsEdge() {
-    return (navigator.userAgent.indexOf("Edge") !== -1)
+    return navigator.userAgent.indexOf('Edge') !== -1;
 }
 
 // SIP header names are RFC 3261 tokens
@@ -329,6 +329,14 @@ function buildCustomHeaders(setHeader) {
     });
 }
 
+// Rewrite Opus stereo=1 to stereo=0 on every a=fmtp line.
+// Firefox always offers stereo=1 and Media Switches then opens a 2-channel leg, on which
+// the recording carries the same mix on both channels.
+// The result is recordings contain identical audio on both channels, affecting transcription diarization.
+function withoutOpusStereo(sdp) {
+    return sdp.replace(/^a=fmtp:.*$/gm, (line) => line.replace(/stereo=1/g, 'stereo=0'));
+}
+
 // Request timeout after 10 sec
 const REQUEST_TIMEOUT = 10000;
 
@@ -1559,6 +1567,7 @@ const options = {
     autoRemoveSessionTime: 3000,
     playRingOnIncoming: true,
     playCallInitializedTone: false,
+    playCallEndedTone: false,
 };
 
 // DTMF Frequency table
@@ -1595,6 +1604,11 @@ const ST_CALLINIT = [
     { d: 200, f1: 500, f2: 0, g: 0 },
     { d: 200, f1: 700, f2: 0, g: 5000 },
 ];
+const ST_CALLENDED = [
+    { d: 150, f1: 600, f2: 0, g: 50 },
+    { d: 150, f1: 500, f2: 0, g: 50 },
+    { d: 150, f1: 400, f2: 0, g: 0 },
+];
 const ST_RINGBACK = [{ d: 1000, f1: 425, f2: 0, g: 4000 }];
 const ST_INCOMING = [
     { d: 150, f1: 400, f2: 0, g: 0 },
@@ -1753,10 +1767,7 @@ class Phone extends EventEmitter {
             return false;
         }
         const sinkId = deviceId || '';
-        await Promise.all([
-            this._remoteAudioElement.setSinkId(sinkId),
-            this._toneAudioElement.setSinkId(sinkId),
-        ]);
+        await Promise.all([this._remoteAudioElement.setSinkId(sinkId), this._toneAudioElement.setSinkId(sinkId)]);
         return true;
     }
 
@@ -1778,6 +1789,7 @@ class Phone extends EventEmitter {
      * @param {number} [phoneOptions.autoRemoveSessionTime=3000] Automatically remove session after interval specified
      * @param {number} [phoneOptions.playRingOnIncoming=true] Play ringing tones on incoming calls
      * @param {number} [phoneOptions.playCallInitializedTone=false] Play tone when call has been initiated (before progress/ringback tones)
+     * @param {boolean} [phoneOptions.playCallEndedTone=false] Play tone once when an answered call ends without the agent hanging up (remote hangup, server hangup, connection loss, timeouts)
      *
      * @throws MediaNotPrepared - If {@link prepareMedia} was not called and resolved prior to calling this method
      * @throws InvalidOptions - If one or more options are invalid
@@ -2213,14 +2225,18 @@ class Phone extends EventEmitter {
 
         // Set timer to stop tone again
         const self = this;
-        this._toneTimer = setTimeout(function () {
-            self.stopTone();
+        const timer = setTimeout(function () {
+            // A later playTone() has taken over the oscillators; don't silence it or cancel its timer
+            if (self._toneTimer === timer) {
+                self.stopTone();
+            }
 
             // Handle callback now
             if (callback) {
                 callback();
             }
         }, duration);
+        this._toneTimer = timer;
     }
 
     /**
@@ -2263,6 +2279,18 @@ class Phone extends EventEmitter {
         }
     }
 
+    // Play a tone sequence once. A repeat tone starting meanwhile (e.g. a new call's ringing) cancels the rest.
+    _playToneSequence(sequence, pos = 0) {
+        const toneDef = sequence[pos];
+        if (!toneDef || this._repeatToneActive) {
+            return;
+        }
+        const self = this;
+        this.playTone(toneDef.d, toneDef.f1, toneDef.f2, function () {
+            setTimeout(self._playToneSequence.bind(self, sequence, pos + 1), toneDef.g);
+        });
+    }
+
     // End repeating tones
     _endRepeatTone() {
         if (this._repeatToneActive) {
@@ -2592,6 +2620,7 @@ class Session extends EventEmitter {
         this._isListenCall = false;
         this._whisperMode = null;
         this._manualDisposition = null;
+        this._transferInitiated = false;
 
         // Quality report
         this._rtcpStatsTimer = null;
@@ -2752,6 +2781,13 @@ class Session extends EventEmitter {
         // Hookup events
         const self = this;
 
+        // make sure to remove stereo=1 from the SDP
+        this._webRTCSession.on('sdp', function (e) {
+            if (e.originator === 'local') {
+                e.sdp = withoutOpusStereo(e.sdp);
+            }
+        });
+
         // ICE CANDIDATES
         this._webRTCSession.on('icecandidate', function (event) {
             const c = event.candidate;
@@ -2851,10 +2887,17 @@ class Session extends EventEmitter {
             self._setSessionState('ACTIVE');
         });
 
-        this._webRTCSession.on('ended', function (/* data */) {
+        this._webRTCSession.on('ended', function (data) {
             // End any ringsbacks if needed
             self._phone._endRepeatTone();
 
+            // jssip fires 'ended' once a call is answered. Its own errors (connection loss, timeouts, ICE failure)
+            // also end as 'local' but with their own cause, so only a local BYE is the agent hanging up.
+            const agentHangup = data.originator === 'local' && data.cause === JsSIP.C.causes.BYE;
+            if (self._phone.options.playCallEndedTone && !agentHangup && !self._transferInitiated) {
+                self._phone._playToneSequence(ST_CALLENDED);
+            }
+
             self._callEndTime = Date.now();
 
             // Clear answer call timeout timer if needed
@@ -3296,6 +3339,10 @@ class Session extends EventEmitter {
     transfer(dstSession) {
         this.log.info(`Transferring ${this.uuid} => ${dstSession.uuid}`);
 
+        // The server hangs up both legs once the transfer completes - that's the agent's doing, no call-ended tone
+        this._transferInitiated = true;
+        dstSession._transferInitiated = true;
+
         // Create ReferSubscriber event class
         const referSubscriber = this._webRTCSession.refer(this._webRTCSession._request.ruri, {
             replaces: dstSession._webRTCSession,
@@ -3310,10 +3357,15 @@ class Session extends EventEmitter {
 
         referSubscriber.on('requestFailed', function (cause) {
             self.log.error(`Transfer rejected: ${cause}`);
+            // Legs stay up, so a later hangup by the other party should get the cue
+            self._transferInitiated = false;
+            dstSession._transferInitiated = false;
         });
 
         referSubscriber.on('failed', function (cause) {
             self.log.error(`Transfer failed: ${cause}`);
+            self._transferInitiated = false;
+            dstSession._transferInitiated = false;
         });
     }
 
@@ -3881,4 +3933,4 @@ class Session extends EventEmitter {
     }
 }
 
-export { EventClient, EventServiceNotConnected, InvalidMediaDevice, InvalidOptions, InvalidParameter, LOGLVL, LogHandler, MediaNotPrepared, NoActiveSession, NotAllowed, NotReady, Phone, Request, Requestor, Session, UnableToConnect, browserIsChrome, browserIsEdge, browserIsFirefox, browserIsOpera, browserIsSafari, buildCustomHeaders, compareObjects, createDurationString, createUUID };
+export { EventClient, EventServiceNotConnected, InvalidMediaDevice, InvalidOptions, InvalidParameter, LOGLVL, LogHandler, MediaNotPrepared, NoActiveSession, NotAllowed, NotReady, Phone, Request, Requestor, Session, UnableToConnect, browserIsChrome, browserIsEdge, browserIsFirefox, browserIsOpera, browserIsSafari, buildCustomHeaders, compareObjects, createDurationString, createUUID, withoutOpusStereo };