@flashphoner/websdk 2.0.208 → 2.0.212

package/flashphoner.js

@@ -11487,6 +11487,9 @@ var getSession = function getSession(id) {
  * @param {Object=} options.sipOptions Sip configuration
  * @param {Object=} options.mediaOptions Media connection configuration
  * @param {Integer=} options.timeout Connection timeout in milliseconds
+ * @param {Integer=} options.pingInterval Server ping interval in milliseconds [0]
+ * @param {Integer=} options.receiveProbes A maximum subsequental pings received missing count [0]
+ * @param {Integer=} options.probesInterval Interval to check subsequental pings received [0]
  * @returns {Session} Created session
  * @throws {Error} Error if API is not initialized
  * @throws {TypeError} Error if options.urlServer is not specified
@@ -11513,6 +11516,8 @@ var createSession = function createSession(options) {
   var mediaOptions = options.mediaOptions;
   var keepAlive = options.keepAlive;
   var timeout = options.timeout;
+  var wsPingSender = new WSPingSender(options.pingInterval || 0);
+  var wsPingReceiver = new WSPingReceiver(options.receiveProbes || 0, options.probesInterval || 0);
   var connectionTimeout;
   var cConfig; //SIP config
 
@@ -11630,7 +11635,7 @@ var createSession = function createSession(options) {
         mediaProviders: Object.keys(MediaProvider),
         keepAlive: keepAlive,
         authToken: authToken,
-        clientVersion: "2.0.208",
+        clientVersion: "2.0.212",
         clientOSVersion: window.navigator.appVersion,
         clientBrowserVersion: window.navigator.userAgent,
         msePacketizationVersion: 2,
@@ -11643,7 +11648,11 @@ var createSession = function createSession(options) {
 
 
       send("connection", cConfig);
-      logger.setConnection(wsConnection);
+      logger.setConnection(wsConnection); // Send ping messages to server to check if connection is still alive #WCS-3410
+
+      wsPingSender.start(); // Check subsequintel pings received from server to check if connection is still alive #WCS-3410
+
+      wsPingReceiver.start();
     };
 
     wsConnection.onmessage = function (event) {
@@ -11659,6 +11668,7 @@ var createSession = function createSession(options) {
       switch (data.message) {
         case 'ping':
           send("pong", null);
+          wsPingReceiver.success();
           break;
 
         case 'getUserData':
@@ -11818,7 +11828,11 @@ var createSession = function createSession(options) {
     sessionStatus = newStatus;
 
     if (sessionStatus == SESSION_STATUS.DISCONNECTED || sessionStatus == SESSION_STATUS.FAILED) {
-      //remove streams
+      // Stop pinging server #WCS-3410
+      wsPingSender.stop(); // Stop checking pings received #WCS-3410
+
+      wsPingReceiver.stop(); //remove streams
+
       for (var prop in streamRefreshHandlers) {
         if (streamRefreshHandlers.hasOwnProperty(prop) && typeof streamRefreshHandlers[prop] === 'function') {
           streamRefreshHandlers[prop]({
@@ -11834,6 +11848,73 @@ var createSession = function createSession(options) {
     if (callbacks[sessionStatus]) {
       callbacks[sessionStatus](session, obj);
     }
+  } // Websocket periodic ping sender
+
+
+  function WSPingSender(interval) {
+    this.interval = interval || 0;
+    this.intervalId = null;
+
+    this.start = function () {
+      if (this.interval > 0) {
+        this.intervalId = setInterval(function () {
+          send("ping", null);
+        }, this.interval);
+      }
+    };
+
+    this.stop = function () {
+      if (this.intervalId) {
+        clearInterval(this.intervalId);
+      }
+    };
+
+    return this;
+  } // Websocket ping receive prober
+
+
+  function WSPingReceiver(receiveProbes, probesInterval) {
+    this.maxPings = receiveProbes || 0;
+    this.interval = probesInterval || 0;
+    this.intervalId = null;
+    this.pingsMissing = 0;
+
+    this.start = function () {
+      if (this.maxPings > 0 && this.interval > 0) {
+        var receiver = this;
+        this.intervalId = setInterval(function () {
+          receiver.checkPingsReceived();
+        }, this.interval);
+      }
+    };
+
+    this.stop = function () {
+      if (this.intervalId) {
+        clearInterval(this.intervalId);
+      }
+
+      this.pingsMissing = 0;
+    };
+
+    this.checkPingsReceived = function () {
+      this.pingsMissing++;
+
+      if (this.pingsMissing >= this.maxPings) {
+        this.failure();
+      }
+    };
+
+    this.success = function () {
+      this.pingsMissing = 0;
+    };
+
+    this.failure = function () {
+      logger.info(LOG_PREFIX, "Missing " + this.pingsMissing + " pings from server, connection seems to be down");
+      onSessionStatusChange(SESSION_STATUS.FAILED);
+      wsConnection.close();
+    };
+
+    return this;
   }
   /**
    * @callback sdpHook
@@ -12698,7 +12779,7 @@ var createSession = function createSession(options) {
    * @param {HTMLElement} options.display Div element stream should be displayed in
    * @param {Object=} options.custom User provided custom object that will be available in REST App code
    * @param {Integer} [options.flashBufferTime=0] Specifies how long to buffer messages before starting to display the stream (Flash-only)
-   * @param {String=} options.stripCodecs Comma separated string of codecs which should be stripped from WebRTC SDP (ex. "H264,PCMA,PCMU,G722")
+   * @param {string=} options.stripCodecs Comma separated string of codecs which should be stripped from WebRTC SDP (ex. "H264,PCMA,PCMU,G722")
    * @param {string=} options.rtmpUrl Rtmp url stream should be forwarded to
    * @param {Object=} options.mediaConnectionConstraints Stream specific constraints for underlying RTCPeerConnection
    * @param {Boolean=} options.flashShowFullScreenButton Show full screen button in flash
@@ -12707,6 +12788,7 @@ var createSession = function createSession(options) {
    * @param {Integer=} options.playoutDelay Time delay between network reception of media and playout
    * @param {string=} options.useCanvasMediaStream EXPERIMENTAL: when publish bind browser's media stream to the canvas. It can be useful for image filtering
    * @param {string=} options.videoContentHint Video content hint for browser ('detail' by default to maintain resolution), {@link Flashphoner.constants.CONTENT_HINT_TYPE}
+   * @param {Boolean=} options.unmutePlayOnStart Unmute playback on start. May be used after user gesture only, so set 'unmutePlayOnStart: false' for autoplay
    * @param {sdpHook} sdpHook The callback that handles sdp from the server
    * @returns {Stream} Stream
    * @throws {TypeError} Error if no options provided
@@ -12818,6 +12900,7 @@ var createSession = function createSession(options) {
     var playoutDelay = options.playoutDelay;
     var useCanvasMediaStream = options.useCanvasMediaStream;
     var videoContentHint = options.videoContentHint;
+    var unmutePlayOnStart = options.unmutePlayOnStart;
     var audioState_;
     var videoState_;
     var connectionQuality;
@@ -12994,7 +13077,8 @@ var createSession = function createSession(options) {
         connectionConstraints: mediaConnectionConstraints,
         audioOutputId: audioOutputId,
         remoteVideo: remoteVideo,
-        playoutDelay: playoutDelay
+        playoutDelay: playoutDelay,
+        unmutePlayOnStart: unmutePlayOnStart
       }, streamRefreshHandlers[id_]).then(function (newConnection) {
         mediaConnection = newConnection;
 
@@ -14522,7 +14606,9 @@ var createConnection = function createConnection(options) {
     var screenShare = false;
     var playoutDelay = options.playoutDelay; // Set video track contentHint to `detail` by default to workaround Chromium 91 bug #WCS-3257
 
-    var videoContentHint = options.videoContentHint ? options.videoContentHint : 'detail';
+    var videoContentHint = options.videoContentHint ? options.videoContentHint : 'detail'; // Pass the option to unmute automatically (true by default) #WCS-2425
+
+    var unmutePlayOnStart = options.unmutePlayOnStart !== undefined ? options.unmutePlayOnStart : true;
 
     if (bidirectional) {
       localVideo = getCacheInstance(localDisplay);
@@ -14541,7 +14627,7 @@ var createConnection = function createConnection(options) {
       remoteVideo = getCacheInstance(remoteDisplay);
 
       if (!remoteVideo) {
-        remoteVideo = document.createElement('video');
+        remoteVideo = createVideoElement();
         remoteDisplay.appendChild(remoteVideo);
       }
 
@@ -14566,7 +14652,7 @@ var createConnection = function createConnection(options) {
           if (cachedVideo) {
             remoteVideo = cachedVideo;
           } else {
-            remoteVideo = document.createElement('video');
+            remoteVideo = createVideoElement();
             display.appendChild(remoteVideo);
           }
 
@@ -14630,7 +14716,12 @@ var createConnection = function createConnection(options) {
 
         remoteVideo.onloadedmetadata = function (e) {
           if (remoteVideo) {
-            remoteVideo.play()["catch"](function (e) {
+            remoteVideo.play().then(function () {
+              // Automatically unmute video if needed #WCS-2425
+              if (unmutePlayOnStart) {
+                remoteVideo.muted = false;
+              }
+            })["catch"](function (e) {
               if (validBrowsers.includes(browserDetails.browser)) {
                 //WCS-1698. fixed autoplay in chromium based browsers
                 //WCS-2375. fixed autoplay in ios safari
@@ -15399,14 +15490,12 @@ var loadOrdinaryVideo = function loadOrdinaryVideo(display, stream, screenShare,
   var vEl = video;
 
   if (!vEl) {
-    vEl = document.createElement('video');
+    vEl = createVideoElement();
     display.appendChild(vEl);
   }
 
   vEl.id = uuid_v1() + LOCAL_CACHED_VIDEO;
-  vEl.srcObject = stream; //mute audio
-
-  vEl.muted = true;
+  vEl.srcObject = stream;
 
   vEl.onloadedmetadata = function (e) {
     //WCS-2751 Add screen capture using getDisplayMedia in Safari
@@ -15782,6 +15871,19 @@ function getCacheInstance(display) {
   }
 }
 
+function createVideoElement() {
+  var video = document.createElement('video'); // Prepare video tag to auto play and add specific Safari tweaks #WCS-2425
+
+  video.muted = true;
+
+  if (util.Browser.isSafariWebRTC()) {
+    video.setAttribute("playsinline", "");
+    video.setAttribute("webkit-playsinline", "");
+  }
+
+  return video;
+}
+
 function removeVideoElement(video) {
   if (video.srcObject) {
     //pause
@@ -16015,7 +16117,9 @@ var playFirstVideo = function playFirstVideo(display, isLocal, src) {
     if (!getCacheInstance(display)) {
       var video = document.createElement('video');
       video.setAttribute("playsinline", "");
-      video.setAttribute("webkit-playsinline", "");
+      video.setAttribute("webkit-playsinline", ""); //Mute video tag to prevent local audio playback in Safari #WCS-3430
+
+      video.muted = true;
       video.id = uuid_v1() + (isLocal ? LOCAL_CACHED_VIDEO : REMOTE_CACHED_VIDEO); //in WCS-1560 we removed video.play() call, because it triggers the “Unhandled Promise Rejection” exception in iOS Safari
       //in WCS-2160 we rolled back the changes made in WCS-1560 due to no audio on first playback in iOS Safari