Merge pull request #247 from jitsi/dc-selected-endpoint

Moves caching of selected endpoint out of data channel.

JitsiConference.js

@@ -597,6 +597,7 @@ JitsiConference.prototype.unlock = function () {
 /**
  * Elects the participant with the given id to be the selected participant in
  * order to receive higher video quality (if simulcast is enabled).
+ * Or cache it if channel is not created and send it once channel is available.
  * @param participantId the identifier of the participant
  * @throws NetworkError or InvalidStateError or Error if the operation fails.
  */

modules/RTC/DataChannels.js

@@ -51,7 +51,6 @@ function DataChannels(peerConnection, emitter) {
 DataChannels.prototype.onDataChannel = function (event) {
     var dataChannel = event.channel;
     var self = this;
-    var selectedEndpoint = null;
 
     dataChannel.onopen = function () {
         logger.info("Data channel opened by the Videobridge!", dataChannel);
@@ -63,19 +62,6 @@ DataChannels.prototype.onDataChannel = function (event) {
         //dataChannel.send(new ArrayBuffer(12));
 
         self.eventEmitter.emit(RTCEvents.DATA_CHANNEL_OPEN);
-
-        // when the data channel becomes available, tell the bridge about video
-        // selections so that it can do adaptive simulcast,
-        // we want the notification to trigger even if userJid is undefined,
-        // or null.
-        // XXX why do we not do the same for pinned endpoints?
-        try {
-            self.sendSelectedEndpointMessage(self.selectedEndpoint);
-        } catch (error) {
-            GlobalOnErrorHandler.callErrorHandler(error);
-            logger.error("Cannot sendSelectedEndpointMessage ",
-                self.selectedEndpoint, ". Error: ", error);
-        }
     };
 
     dataChannel.onerror = function (error) {
@@ -195,7 +181,6 @@ DataChannels.prototype.closeAllChannels = function () {
  * or Error with "No opened data channels found!" message.
  */
 DataChannels.prototype.sendSelectedEndpointMessage = function (endpointId) {
-    this.selectedEndpoint = endpointId;
     this._onXXXEndpointChanged("selected", endpointId);
 };
 

modules/RTC/RTC.js

@@ -84,9 +84,31 @@ RTC.obtainAudioAndVideoPermissions = function (options) {
 };
 
 RTC.prototype.onIncommingCall = function(event) {
-    if(this.options.config.openSctp)
+    if(this.options.config.openSctp) {
         this.dataChannels = new DataChannels(event.peerconnection,
             this.eventEmitter);
+        this._dataChannelOpenListener = () => {
+            // when the data channel becomes available, tell the bridge
+            // about video selections so that it can do adaptive simulcast,
+            // we want the notification to trigger even if userJid
+            // is undefined, or null.
+            // XXX why do we not do the same for pinned endpoints?
+            try {
+                this.dataChannels.sendSelectedEndpointMessage(
+                    this.selectedEndpoint);
+            } catch (error) {
+                GlobalOnErrorHandler.callErrorHandler(error);
+                logger.error("Cannot sendSelectedEndpointMessage ",
+                    this.selectedEndpoint, ". Error: ", error);
+            }
+
+            this.removeListener(RTCEvents.DATA_CHANNEL_OPEN,
+                this._dataChannelOpenListener);
+            this._dataChannelOpenListener = null;
+        };
+        this.addListener(RTCEvents.DATA_CHANNEL_OPEN,
+            this._dataChannelOpenListener);
+    }
 };
 
 /**
@@ -104,18 +126,19 @@ RTC.prototype.onCallEnded = function() {
 };
 
 /**
- * Elects the participant with the given id to be the pinned participant in
+ * Elects the participant with the given id to be the selected participant in
  * order to always receive video for this participant (even when last n is
  * enabled).
+ * If there is no data channel we store it and send it through the channel once
+ * it is created.
  * @param id {string} the user id.
  * @throws NetworkError or InvalidStateError or Error if the operation fails.
 */
 RTC.prototype.selectEndpoint = function (id) {
-    if(this.dataChannels) {
+    // cache the value if channel is missing, till we open it
+    this.selectedEndpoint = id;
+    if(this.dataChannels)
         this.dataChannels.sendSelectedEndpointMessage(id);
-    } else {
-        throw new Error("Data channels support is disabled!");
-    }
 };
 
 /**
@@ -129,6 +152,8 @@ RTC.prototype.pinEndpoint = function (id) {
     if(this.dataChannels) {
         this.dataChannels.sendPinnedEndpointMessage(id);
     } else {
+        // FIXME: cache value while there is no data channel created
+        // and send the cached state once channel is created
         throw new Error("Data channels support is disabled!");
     }
 };
@@ -527,7 +552,8 @@ RTC.prototype.handleRemoteTrackVideoTypeChanged = function (value, from) {
  * @param to {string} the id of the endpoint that should receive the message.
  * If "" the message will be sent to all participants.
  * @param payload {object} the payload of the message.
- * @throws NetworkError or InvalidStateError or Error if the operation fails.
+ * @throws NetworkError or InvalidStateError or Error if the operation fails
+ * or there is no data channel created
  */
 RTC.prototype.sendDataChannelMessage = function (to, payload) {
     if(this.dataChannels) {