@exotel-npm-dev/webrtc-client-sdk 2.0.1 → 2.0.2

package/Changelog

@@ -1,5 +1,14 @@
 Change Log
 
+## v2.0.2 21 July, 2025
+-[VST-1038] make auto audio device change handling configurable and fixing Missing sent_request event in registerCallback
+
+## v2.0.1 19 June, 2025
+-[VST-1031] Maintaining v1.0.23
+
+## v1.0.24 19 June, 2025
+-[VST-1031] Deprecated, v1.0.21 for customers using CRM SDK with old SDK
+
 ## v1.0.23 10 June, 2025
 -[VST-1011] Increasing Registration Expiry from 60s to 300s
 

package/Makefile

@@ -12,7 +12,7 @@ build-local:
 
 dep:
 	npm uninstall @exotel-npm-dev/webrtc-core-sdk
-	npm install @exotel-npm-dev/webrtc-core-sdk@latest
+	npm install @exotel-npm-dev/webrtc-core-sdk@1.0.21
 
 publish: build
-	npm publish
+	npm publish --tag legacy

package/dist/exotelsdk.js

@@ -1,6 +1,6 @@
 /*!
  * 
- * WebRTC CLient SIP version 2.0.1
+ * WebRTC CLient SIP version 2.0.2
  *
  */
 (function webpackUniversalModuleDefinition(root, factory) {
@@ -48,6 +48,7 @@ __webpack_require__.r(__webpack_exports__);
 
 
 const logger = _coreSDKLogger__WEBPACK_IMPORTED_MODULE_0__["default"];
+let enableAutoAudioDeviceChangeHandling = false;
 const audioDeviceManager = {
     resetInputDevice: false,
     resetOutputDevice: false,
@@ -65,21 +66,23 @@ const audioDeviceManager = {
         this.resetOutputDevice = value;
     },
 
-    async changeAudioInputDevice(deviceId, onSuccess, onError) {
+    async changeAudioInputDevice(deviceId, onSuccess, onError, forceDeviceChange) {
         logger.log(`SIPJSPhone:changeAudioInputDevice entry`);
         try {
-            if (deviceId == audioDeviceManager.currentAudioInputDeviceId) {
-                logger.log(`SIPJSPhone:changeAudioInputDevice current input device is same as ${deviceId} hence not changing`);
-                if (onError) onError("current input device is same as " + deviceId + " hence not changing");
-                return;
-            }
-            const inputDevice = audioDeviceManager.mediaDevices.find(device => device.deviceId === deviceId && device.kind === 'audioinput');
-            if (!inputDevice) {
-                logger.error("input device id " + deviceId + "not found");
-                if (onError) onError("deviceIdNotFound");
-                return;
+            if (enableAutoAudioDeviceChangeHandling && !forceDeviceChange) {
+                if (deviceId == audioDeviceManager.currentAudioInputDeviceId) {
+                    logger.log(`SIPJSPhone:changeAudioInputDevice current input device is same as ${deviceId} hence not changing`);
+                    if (onError) onError("current input device is same as " + deviceId + " hence not changing");
+                    return;
+                }
+                const inputDevice = audioDeviceManager.mediaDevices.find(device => device.deviceId === deviceId && device.kind === 'audioinput');
+                if (!inputDevice) {
+                    logger.error("input device id " + deviceId + "not found");
+                    if (onError) onError("deviceIdNotFound");
+                    return;
+                }
+                logger.log(`SIPJSPhone:changeAudioInputDevice acquiring input device ${deviceId} : ${inputDevice.label}`);
             }
-            logger.log(`SIPJSPhone:changeAudioInputDevice acquiring input device ${deviceId} : ${inputDevice.label}`);
             const stream = await navigator.mediaDevices.getUserMedia({
                 audio: { deviceId: { exact: deviceId } }
             });
@@ -90,30 +93,31 @@ const audioDeviceManager = {
         }
     },
 
-    async changeAudioOutputDevice(audioRemote, deviceId, onSuccess, onError) {
-        logger.log(`audioDeviceManager:changeAudioOutputDevice : entry`);
-        if (deviceId == audioDeviceManager.currentAudioOutputDeviceId) {
-            logger.log(`SIPJSPhone:changeAudioOutputDevice current output device is same as ${deviceId}`);
-            if (onError) onError("current output device is same as " + deviceId);
-            return;
-        }
+    async changeAudioOutputDevice(audioRemote, deviceId, onSuccess, onError, forceDeviceChange) {
+        logger.log(`audioDeviceManager:changeAudioOutputDevice : entry`);        
         const audioElement = audioRemote;
         if (typeof audioElement.sinkId !== 'undefined') {
             try {
-
-                if (!audioDeviceManager.mediaDevices || audioDeviceManager.mediaDevices.length == 0) {
-                    logger.error("audioDeviceManager:changeAudioOutputDevice mediaDeviceList is empty ");
-                    if (onError) logger.error(deviceId + "not found in mediaDeviceList in audioManager");
-                    return;
-                }
-                const outputDevice = audioDeviceManager.mediaDevices.find(device => device.deviceId === deviceId && device.kind === 'audiooutput');
-                if (!outputDevice) {
-                    logger.error("audioDeviceManager:changeAudioOutputDevice output device id " + deviceId + "not found");
-                    if (onError) onError("deviceIdNotFound");
-                    return;
+                if (enableAutoAudioDeviceChangeHandling && !forceDeviceChange) {
+                    if (deviceId == audioDeviceManager.currentAudioOutputDeviceId) {
+                        logger.log(`SIPJSPhone:changeAudioOutputDevice current output device is same as ${deviceId}`);
+                        if (onError) onError("current output device is same as " + deviceId);
+                        return;
+                    }
+                    if (!audioDeviceManager.mediaDevices || audioDeviceManager.mediaDevices.length == 0) {
+                        logger.error("audioDeviceManager:changeAudioOutputDevice mediaDeviceList is empty ");
+                        if (onError) onError(deviceId + "not found in mediaDeviceList in audioManager");
+                        return;
+                    }
+                    const outputDevice = audioDeviceManager.mediaDevices.find(device => device.deviceId === deviceId && device.kind === 'audiooutput');
+                    if (!outputDevice) {
+                        logger.error("audioDeviceManager:changeAudioOutputDevice output device id " + deviceId + "not found");
+                        if (onError) onError("deviceIdNotFound");
+                        return;
+                    }
+                    logger.log(`audioDeviceManager:changeAudioOutputDevice acquiring output device ${deviceId} : ${outputDevice.label}`);
+                    // audioElement.load();
                 }
-                logger.log(`audioDeviceManager:changeAudioOutputDevice acquiring output device ${deviceId} : ${outputDevice.label}`);
-                // audioElement.load();
                 await audioElement.setSinkId(deviceId);
                 audioDeviceManager.currentAudioOutputDeviceId = deviceId;
                 logger.log(`audioDeviceManager:changeAudioOutputDevice Output device changed to: ${deviceId}`);
@@ -178,6 +182,10 @@ const audioDeviceManager = {
         if (callback) callback();
     },
 
+    setEnableAutoAudioDeviceChangeHandling(flag) {
+        enableAutoAudioDeviceChangeHandling = flag;
+    },
+
 };
 
 audioDeviceManager.enumerateDevices();
@@ -20843,6 +20851,7 @@ var SIP = __webpack_require__(/*! ./sip-0.20.0.js */ "./node_modules/@exotel-npm
 
 
 
+let enableAutoAudioDeviceChangeHandling = false;
 var lastTransportState = "";
 var lastRegistererState = "";
 var initializeComplete = false;
@@ -21724,8 +21733,8 @@ function handleWebSocketMessageContent(content, direction) {
 	switch (direction) {
 		case "sent":
 
-			if (sipMessage.method == "CONNECTION")
-				_webrtcSIPPhoneEventDelegate__WEBPACK_IMPORTED_MODULE_2__["default"].sendWebRTCEventsToFSM("sent_request", sipMessage.method);
+			if (sipMessage.method == "REGISTER")
+				_webrtcSIPPhoneEventDelegate__WEBPACK_IMPORTED_MODULE_2__["default"].sendWebRTCEventsToFSM("sent_request", "CONNECTION");
 
 			_webrtcSIPPhoneEventDelegate__WEBPACK_IMPORTED_MODULE_2__["default"].onCallStatSipSendCallback(newtext, "sipjs");
 
@@ -22151,7 +22160,8 @@ const SIPJSPhone = {
 		return lastRegistererState;
 	},
 
-	changeAudioInputDevice(deviceId, onSuccess, onError) {
+	changeAudioInputDevice(deviceId, onSuccess, onError, forceDeviceChange) {
+		logger.log(`SIPJSPhone: changeAudioInputDevice called with deviceId=${deviceId}, forceDeviceChange=${forceDeviceChange}, enableAutoAudioDeviceChangeHandling=${enableAutoAudioDeviceChangeHandling}`);
 		_audioDeviceManager_js__WEBPACK_IMPORTED_MODULE_0__.audioDeviceManager.changeAudioInputDevice(deviceId, function (stream) {
 			const trackChanged = SIPJSPhone.replaceSenderTrack(stream, deviceId);
 			if (trackChanged) {
@@ -22163,7 +22173,7 @@ const SIPJSPhone = {
 				logger.error("sipjsphone: changeAudioInputDevice: failed");
 				onError("replaceSenderTrack failed for webrtc");
 			}
-		}, onError);
+		}, onError, forceDeviceChange);
 	},
 	changeAudioOutputDeviceForAdditionalAudioElement(deviceId) {
 		const additionalAudioElements = [ringtone, beeptone, ringbacktone, dtmftone];
@@ -22179,14 +22189,15 @@ const SIPJSPhone = {
 			logger.error("sipjsphone:changeAudioOutputDeviceForAdditionalAudioElement failed to setSink for additonal AudioElements", e);
 		}
 	},
-	changeAudioOutputDevice(deviceId, onSuccess, onError) {
+	changeAudioOutputDevice(deviceId, onSuccess, onError, forceDeviceChange) {
+		logger.log(`SIPJSPhone: changeAudioOutputDevice called with deviceId=${deviceId}, forceDeviceChange=${forceDeviceChange}, enableAutoAudioDeviceChangeHandling=${enableAutoAudioDeviceChangeHandling}`);
 		if (!ctxSip.callActiveID) {
 			audioRemote = document.createElement("audio");
 		}
 		_audioDeviceManager_js__WEBPACK_IMPORTED_MODULE_0__.audioDeviceManager.changeAudioOutputDevice(audioRemote, deviceId, function () {
 			SIPJSPhone.changeAudioOutputDeviceForAdditionalAudioElement(deviceId);
 			onSuccess();
-		}, onError);
+		}, onError, forceDeviceChange);
 	},
 
 	stopStreamTracks(stream) {
@@ -22242,45 +22253,52 @@ const SIPJSPhone = {
 		SIPJSPhone.audioInputDeviceChangeCallback = audioInputDeviceChangeCallback;
 		SIPJSPhone.audioOutputDeviceChangeCallback = audioOutputDeviceChangeCallback;
 		SIPJSPhone.onDeviceChangeCallback = onDeviceChangeCallback;
-	}
-
-};
-
-
-navigator.mediaDevices.addEventListener('devicechange', function (event) {
-	try {
-		if (!ctxSip.callActiveID) {
-			audioRemote = document.createElement("audio");
-		}
-		_audioDeviceManager_js__WEBPACK_IMPORTED_MODULE_0__.audioDeviceManager.enumerateDevices(function () {
-
-			if (SIPJSPhone.onDeviceChangeCallback) {
-				logger.info("SIPJSPhone:ondevicechange relaying event to callback");
-				SIPJSPhone.onDeviceChangeCallback(event);
-				return;
-			}
-			_audioDeviceManager_js__WEBPACK_IMPORTED_MODULE_0__.audioDeviceManager.onAudioDeviceChange(audioRemote,
-				function (stream, deviceId) {
-					const trackChanged = SIPJSPhone.replaceSenderTrack(stream, deviceId);
-					if (trackChanged) {
-						_audioDeviceManager_js__WEBPACK_IMPORTED_MODULE_0__.audioDeviceManager.currentAudioInputDeviceId = deviceId;
-						if (SIPJSPhone.audioInputDeviceChangeCallback) {
-							SIPJSPhone.audioInputDeviceChangeCallback(deviceId);
-						}
-					}
-				}, function (deviceId) {
-					SIPJSPhone.changeAudioOutputDeviceForAdditionalAudioElement(deviceId);
-					_audioDeviceManager_js__WEBPACK_IMPORTED_MODULE_0__.audioDeviceManager.currentAudioOutputDeviceId = deviceId;
-					if (SIPJSPhone.audioOutputDeviceChangeCallback) {
-						SIPJSPhone.audioOutputDeviceChangeCallback(deviceId);
+	},
+	attachGlobalDeviceChangeListener() {
+		logger.log("SIPJSPhone: Attaching global devicechange event listener (enableAutoAudioDeviceChangeHandling is true)");
+		navigator.mediaDevices.addEventListener('devicechange', (event) => {
+			try {
+				if (!ctxSip.callActiveID) {
+					audioRemote = document.createElement("audio");
+				}
+				_audioDeviceManager_js__WEBPACK_IMPORTED_MODULE_0__.audioDeviceManager.enumerateDevices(() => {
+					if (SIPJSPhone.onDeviceChangeCallback) {
+						logger.info("SIPJSPhone:ondevicechange relaying event to callback");
+						SIPJSPhone.onDeviceChangeCallback(event);
 					}
+					_audioDeviceManager_js__WEBPACK_IMPORTED_MODULE_0__.audioDeviceManager.onAudioDeviceChange(
+						audioRemote,
+						(stream, deviceId) => {
+							const trackChanged = SIPJSPhone.replaceSenderTrack(stream, deviceId);
+							if (trackChanged) {
+								_audioDeviceManager_js__WEBPACK_IMPORTED_MODULE_0__.audioDeviceManager.currentAudioInputDeviceId = deviceId;
+								if (SIPJSPhone.audioInputDeviceChangeCallback) {
+									SIPJSPhone.audioInputDeviceChangeCallback(deviceId);
+								}
+							}
+						},
+						(deviceId) => {
+							SIPJSPhone.changeAudioOutputDeviceForAdditionalAudioElement(deviceId);
+							_audioDeviceManager_js__WEBPACK_IMPORTED_MODULE_0__.audioDeviceManager.currentAudioOutputDeviceId = deviceId;
+							if (SIPJSPhone.audioOutputDeviceChangeCallback) {
+								SIPJSPhone.audioOutputDeviceChangeCallback(deviceId);
+							}
+						}
+					);
 				});
+			} catch (e) {
+				logger.error("SIPJSPhone:ondevicechange something went wrong during device change", e);
+			}
 		});
+	},
+    setEnableAutoAudioDeviceChangeHandling(flag) {
+		logger.log("sipjsphone: setEnableAutoAudioDeviceChangeHandling: entry, enableAutoAudioDeviceChangeHandling = ",flag);
+        enableAutoAudioDeviceChangeHandling = flag;
+		_audioDeviceManager_js__WEBPACK_IMPORTED_MODULE_0__.audioDeviceManager.setEnableAutoAudioDeviceChangeHandling(flag);
+    }
+};
+
 
-	} catch (e) {
-		logger.error("SIPJSPhone:ondevicechange something went wrong during device change", e);
-	}
-});
 
 /* harmony default export */ const __WEBPACK_DEFAULT_EXPORT__ = (SIPJSPhone);
 
@@ -22310,7 +22328,6 @@ __webpack_require__.r(__webpack_exports__);
 
 
 
-
 var phone = null;
 let webrtcSIPEngine = null;
 const logger = _coreSDKLogger__WEBPACK_IMPORTED_MODULE_0__["default"];
@@ -22444,8 +22461,8 @@ const webrtcSIPPhone = {
 
 
 
-	registerPhone: (engine, delegate) => {
-		logger.log("webrtcSIPPhone: registerPhone : ",engine);
+	registerPhone: (engine, delegate, enableAutoAudioDeviceChangeHandling = false) => {
+		logger.log("webrtcSIPPhone: registerPhone : ",engine, "enableAutoAudioDeviceChangeHandling:", enableAutoAudioDeviceChangeHandling);
 		webrtcSIPEngine = engine;
 		switch (engine) {
 			case "sipjs":
@@ -22456,8 +22473,10 @@ const webrtcSIPPhone = {
 		}
 		_webrtcSIPPhoneEventDelegate__WEBPACK_IMPORTED_MODULE_2__["default"].registerDelegate(delegate);
 		_webrtcSIPPhoneEventDelegate__WEBPACK_IMPORTED_MODULE_2__["default"].onRegisterWebRTCSIPEngine(engine);
-
-
+		phone.setEnableAutoAudioDeviceChangeHandling(enableAutoAudioDeviceChangeHandling);
+		if (enableAutoAudioDeviceChangeHandling) {
+			phone.attachGlobalDeviceChangeListener();
+		}
 	},
 
 	getWebRTCStatus: () => {
@@ -22527,14 +22546,14 @@ const webrtcSIPPhone = {
 		}
 	},
 
-	changeAudioInputDevice(deviceId, onSuccess, onError) {
+	changeAudioInputDevice(deviceId, onSuccess, onError, forceDeviceChange=false) {
 		logger.log("webrtcSIPPhone: changeAudioInputDevice : ", deviceId, onSuccess, onError);
-		_sipjsphone__WEBPACK_IMPORTED_MODULE_1__["default"].changeAudioInputDevice(deviceId, onSuccess, onError);
+		_sipjsphone__WEBPACK_IMPORTED_MODULE_1__["default"].changeAudioInputDevice(deviceId, onSuccess, onError, forceDeviceChange);
 	},
 
-	changeAudioOutputDevice(deviceId, onSuccess, onError) {
+	changeAudioOutputDevice(deviceId, onSuccess, onError, forceDeviceChange=false) {
 		logger.log("webrtcSIPPhone: changeAudioOutputDevice : ", deviceId, onSuccess, onError);
-		_sipjsphone__WEBPACK_IMPORTED_MODULE_1__["default"].changeAudioOutputDevice(deviceId, onSuccess, onError);
+		_sipjsphone__WEBPACK_IMPORTED_MODULE_1__["default"].changeAudioOutputDevice(deviceId, onSuccess, onError, forceDeviceChange);
 	},
 	setPreferredCodec(codecName) {
 		logger.log("webrtcSIPPhone: setPreferredCodec : ", codecName);
@@ -24240,7 +24259,7 @@ class ExotelWebClient {
       if (this.clientSDKLoggerCallback) this.clientSDKLoggerCallback("log", arg1, args);
     });
   }
-  initWebrtc = (sipAccountInfo_, RegisterEventCallBack, CallListenerCallback, SessionCallback) => {
+  initWebrtc = (sipAccountInfo_, RegisterEventCallBack, CallListenerCallback, SessionCallback, enableAutoAudioDeviceChangeHandling = false) => {
     if (!this.eventListener) {
       this.eventListener = new _listeners_ExotelVoiceClientListener__WEBPACK_IMPORTED_MODULE_3__.ExotelVoiceClientListener();
     }
@@ -24253,6 +24272,7 @@ class ExotelWebClient {
     if (!this.call) {
       this.call = new _api_callAPI_Call__WEBPACK_IMPORTED_MODULE_0__.Call();
     }
+    sipAccountInfo_.enableAutoAudioDeviceChangeHandling = enableAutoAudioDeviceChangeHandling;
     logger.log("ExWebClient: initWebrtc: Exotel Client Initialised with " + JSON.stringify(sipAccountInfo_));
     this.sipAccountInfo = sipAccountInfo_;
     if (!this.sipAccountInfo["userName"] || !this.sipAccountInfo["sipdomain"] || !this.sipAccountInfo["port"]) {
@@ -24488,7 +24508,7 @@ class ExotelWebClient {
     //webRTCPhones[userName] = webRTC;
 
     /* New-Way  */
-    _exotel_npm_dev_webrtc_core_sdk__WEBPACK_IMPORTED_MODULE_8__.webrtcSIPPhone.registerPhone("sipjs", delegationHandler);
+    _exotel_npm_dev_webrtc_core_sdk__WEBPACK_IMPORTED_MODULE_8__.webrtcSIPPhone.registerPhone("sipjs", delegationHandler, sipAccountInfo.enableAutoAudioDeviceChangeHandling);
     _exotel_npm_dev_webrtc_core_sdk__WEBPACK_IMPORTED_MODULE_8__.webrtcSIPPhone.registerWebRTCClient(this.sipAccntInfo, synchronousHandler);
 
     /**
@@ -24539,13 +24559,13 @@ class ExotelWebClient {
       callback("media_permission_denied");
     });
   };
-  changeAudioInputDevice(deviceId, onSuccess, onError) {
+  changeAudioInputDevice(deviceId, onSuccess, onError, forceDeviceChange = false) {
     logger.log(`ExWebClient: changeAudioInputDevice: Entry`);
-    _exotel_npm_dev_webrtc_core_sdk__WEBPACK_IMPORTED_MODULE_8__.webrtcSIPPhone.changeAudioInputDevice(deviceId, onSuccess, onError);
+    _exotel_npm_dev_webrtc_core_sdk__WEBPACK_IMPORTED_MODULE_8__.webrtcSIPPhone.changeAudioInputDevice(deviceId, onSuccess, onError, forceDeviceChange);
   }
-  changeAudioOutputDevice(deviceId, onSuccess, onError) {
+  changeAudioOutputDevice(deviceId, onSuccess, onError, forceDeviceChange = false) {
     logger.log(`ExWebClient: changeAudioOutputDevice: Entry`);
-    _exotel_npm_dev_webrtc_core_sdk__WEBPACK_IMPORTED_MODULE_8__.webrtcSIPPhone.changeAudioOutputDevice(deviceId, onSuccess, onError);
+    _exotel_npm_dev_webrtc_core_sdk__WEBPACK_IMPORTED_MODULE_8__.webrtcSIPPhone.changeAudioOutputDevice(deviceId, onSuccess, onError, forceDeviceChange);
   }
   downloadLogs() {
     logger.log(`ExWebClient: downloadLogs: Entry`);