@flashphoner/sfusdk 1.0.40 → 1.0.47

package/docTemplate/README.md

@@ -1,4 +1,4 @@
-SFU SDK - 1.0.40
+SFU SDK - 1.0.47
 
 [Download builds](https://docs.flashphoner.com/display/SS1E/Release+notes)
 

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@flashphoner/sfusdk",
   "description": "Official Flashphoner WebCallServer SFU SDK package",
-  "version": "1.0.40",
+  "version": "1.0.47",
   "scripts": {
     "test": "jest --runInBand"
   },
@@ -17,13 +17,15 @@
     "webrtc-adapter": "^7.2.6"
   },
   "devDependencies": {
+    "@mapbox/node-pre-gyp": "^1.0.8",
     "grunt": "^1.0.1",
     "grunt-browserify": "^5.0.0",
     "grunt-contrib-clean": "^1.0.0",
     "grunt-contrib-copy": "^1.0.0",
     "grunt-jsdoc": "^2.4.0",
     "grunt-run": "^0.8.1",
-    "jest": "^27.4.7"
+    "jest": "^27.4.7",
+    "wrtc": "^0.4.7"
   },
   "keywords": [
     "Flashphoner",
@@ -33,6 +35,7 @@
   "author": "Flashphoner",
   "license": "MIT",
   "jest" : {
-    "testEnvironment": "jsdom"
+    "testEnvironment": "jsdom",
+    "testRunner": "jest-jasmine2"
   }
 }

package/src/examples/player/player.js

@@ -100,6 +100,9 @@ const connect = function(state) {
     roomConfig.url = $("#url").val();
     roomConfig.roomName = $("#roomName").val();
     roomConfig.nickname = $("#" + state.inputId()).val();
+    // clean state display items
+    setStatus(state.statusId(), "");
+    setStatus(state.errInfoId(), "");
     // connect to server and create a room if not
     const session = sfu.createRoom(roomConfig);
     session.on(constants.SFU_EVENT.CONNECTED, function(room) {

package/src/examples/two-way-streaming/two-way-streaming.js

@@ -56,16 +56,37 @@ const CurrentState = function(prefix) {
         pc: null,
         session: null,
         room: null,
+        timer: null,
         set: function(pc, session, room) {
             state.pc = pc;
             state.session = session;
             state.room = room;
         },
         clear: function() {
+            state.stopWaiting();
             state.room = null;
             state.session = null;
             state.pc = null;
         },
+        waitFor: function(div, timeout) {
+            state.stopWaiting();
+            state.timer = setTimeout(function () {
+                if (div.innerHTML !== "") {
+                    // Enable stop button
+                    $("#" + state.buttonId()).prop('disabled', false);
+                }
+                else if (state.isConnected()) {
+                    setStatus(state.errInfoId(), "No media capturing started in " + timeout + " ms, stopping", "red");
+                    onStopClick(state);
+                }
+            }, timeout);        
+        },
+        stopWaiting: function() {
+            if (state.timer) {
+                clearTimeout(state.timer);
+                state.timer = null;                
+            }
+        },
         buttonId: function() {
             return state.prefix + "Btn";
         },
@@ -86,6 +107,12 @@ const CurrentState = function(prefix) {
         },
         is: function(value) {
             return (prefix === value);
+        },
+        isActive: function() {
+            return (state.room && state.pc);
+        },
+        isConnected: function() {
+            return (state.session && state.session.state() == constants.SFU_STATE.CONNECTED);
         }
     };
     return state;
@@ -165,14 +192,12 @@ const onConnected = function(state) {
     // Add errors displaying
     state.room.on(constants.SFU_ROOM_EVENT.FAILED, function(e) {
         setStatus(state.errInfoId(), e, "red");
+        stopStreaming(state);
     }).on(constants.SFU_ROOM_EVENT.OPERATION_FAILED, function (e) {
         setStatus(state.errInfoId(), e.operation + " failed: " + e.error, "red");
+        stopStreaming(state);
     });
-    if (state.is(PUBLISH)) {
-        publishStreams(state);
-    } else if (state.is(PLAY)) {
-        playStreams(state);
-    }
+    startStreaming(state);
 }
 
 const onDisconnected = function(state) {
@@ -204,65 +229,67 @@ const onStartClick = function(state) {
 
 const onStopClick = function(state) {
     $("#" + state.buttonId()).prop('disabled', true);
+    stopStreaming(state);
+    if (state.isConnected()) {
+        state.session.disconnect();
+    }
+}
+
+const startStreaming = function(state) {
     if (state.is(PUBLISH)) {
-        unPublishStreams(state);
+        publishStreams(state);
     } else if (state.is(PLAY)) {
-        stopStreams(state);
-    }    
-    state.session.disconnect();
+        playStreams(state);
+    }
 }
 
-const publishStreams = async function(state) {
-    let timerId;
-    //create local display item to show local streams
-    localDisplay = initLocalDisplay(document.getElementById("localVideo"));
-    try {
-        //get configured local video streams
-        let streams = await getVideoStreams(mainConfig);
-        let audioStreams = await getAudioStreams(mainConfig);
-        //combine local video streams with audio streams
-        streams.push.apply(streams, audioStreams);
-        let config = {};
-        //add our local streams to the room (to PeerConnection)
-        streams.forEach(function (s) {
-            //add local stream to local display
-            localDisplay.add(s.stream.id, $("#" + state.inputId()).val(), s.stream);
-            //add each track to PeerConnection
-            s.stream.getTracks().forEach((track) => {
-                if (s.source === "screen") {
-                    config[track.id] = s.source;
-                }
-                addTrackToPeerConnection(state.pc, s.stream, track, s.encodings);
-                subscribeTrackToEndedEvent(state.room, track, state.pc);
-            });
-        });
-        state.room.join(config);
-        // TODO: Use room state or promises to detect if publishing started to enable stop button
-        timerId = waitFor(document.getElementById("localVideo"), 3000, state);
-    } catch(e) {
-        console.error("Failed to capture streams: " + e);
-        setStatus(state.errInfoId(), e.name, "red");
-        if (timerId) {
-            clearTimeout(timerId);
-            timerId = null;
-        }    
-        onStopClick(state);
+const stopStreaming = function(state) {
+    state.stopWaiting();
+    if (state.is(PUBLISH)) {
+        unPublishStreams(state);
+    } else if (state.is(PLAY)) {
+        stopStreams(state);
     }
 }
 
-// A workaround to check if publishing or playback is started
-const waitFor = function (div, timeout, state) {
-    let timerId = setTimeout(function () {
-        if (div.innerHTML !== "") {
-            // Enable stop button
-            $("#" + state.buttonId()).prop('disabled', false);
-        }
-        else {
-            setStatus(state.errInfoId(), "Something went wrong, stopping", "red");
-            onStopClick(state);
+const publishStreams = async function(state) {
+    if (state.isConnected()) {
+        //create local display item to show local streams
+        localDisplay = initLocalDisplay(document.getElementById("localVideo"));
+        try {
+            //get configured local video streams
+            let streams = await getVideoStreams(mainConfig);
+            let audioStreams = await getAudioStreams(mainConfig);
+            if (state.isConnected() && state.isActive()) {
+                //combine local video streams with audio streams
+                streams.push.apply(streams, audioStreams);
+                let config = {};
+                //add our local streams to the room (to PeerConnection)
+                streams.forEach(function (s) {
+                    //add local stream to local display
+                    localDisplay.add(s.stream.id, $("#" + state.inputId()).val(), s.stream);
+                    //add each track to PeerConnection
+                    s.stream.getTracks().forEach((track) => {
+                        if (s.source === "screen") {
+                            config[track.id] = s.source;
+                        }
+                        addTrackToPeerConnection(state.pc, s.stream, track, s.encodings);
+                        subscribeTrackToEndedEvent(state.room, track, state.pc);
+                    });
+                });
+                state.room.join(config);
+                // TODO: Use room state or promises to detect if publishing started to enable stop button
+                state.waitFor(document.getElementById("localVideo"), 3000);
+            }
+        } catch(e) {
+            console.error("Failed to capture streams: " + e);
+            setStatus(state.errInfoId(), e.name, "red");
+            state.stopWaiting();
+            if (state.isConnected()) { 
+                onStopClick(state);
+            }
         }
-    }, timeout);
-    return timerId;
+    }
 }
 
 const unPublishStreams = function(state) {
@@ -272,9 +299,11 @@ const unPublishStreams = function(state) {
 }
 
 const playStreams = function(state) {
-    //create remote display item to show remote streams
-    remoteDisplay = initRemoteDisplay(document.getElementById("remoteVideo"), state.room, state.pc);
-    state.room.join();
+    if (state.isConnected() && state.isActive()) {
+        //create remote display item to show remote streams
+        remoteDisplay = initRemoteDisplay(document.getElementById("remoteVideo"), state.room, state.pc);
+        state.room.join();
+    }
     $("#" + state.buttonId()).prop('disabled', false);
 }
 

package/src/sdk/constants.js

@@ -63,6 +63,10 @@ const constants = Object.freeze({
         CHAT_DELETED: "CHAT_DELETED",
         CHAT_UPDATED: "CHAT_UPDATED",
         MESSAGE_STATE: "MESSAGE_STATE",
+        CONTACT_UPDATE: "CONTACT_UPDATE",
+        CONTACT_REMOVED: "CONTACT_REMOVED",
+        CONTACT_INVITE: "CONTACT_INVITE",
+        PUBLIC_CHANNELS: "PUBLIC_CHANNELS",
 
         /**
          * @typedef {Object} UserCalendar
@@ -291,6 +295,7 @@ const constants = Object.freeze({
          * @memberof FlashphonerSFU.SFU_ROOM_EVENT
          */
         WAITING_LIST: "SFU_WAITING_LIST",
+        WAITING_ROOM_UPDATE: "SFU_WAITING_ROOM_UPDATE",
         /**
          * Fires when mute/unmute state of one of the Room's participating tracks changes
          * Event object {@link FlashphonerSFU.Room.TracksInfo}
@@ -388,7 +393,12 @@ const constants = Object.freeze({
          * Room failed, something went wrong during room operations
          * @memberOf FlashphonerSFU.SFU_ROOM_STATE
          */
-        FAILED: "FAILED"
+        FAILED: "FAILED",
+        /**
+         * Room disposed, leaveRoom or destroyRoom was called
+         * @memberOf FlashphonerSFU.SFU_ROOM_STATE
+         */
+        DISPOSED: "DISPOSED"
     }),
     /**
      * Internal api constants such as server side methods
@@ -409,16 +419,26 @@ const constants = Object.freeze({
         USER_LIST: "SFU_USER_LIST",
         USER_CALENDAR: "SFU_USER_CALENDAR",
         USER_CHATS: "SFU_USER_CHATS",
+        PUBLIC_CHANNELS: "SFU_PUBLIC_CHANNELS",
         CHAT_LOADED: "SFU_CHAT_LOADED",
         NEW_CHAT: "SFU_NEW_CHAT",
         CHAT_DELETED: "SFU_CHAT_DELETED",
         CHAT_UPDATED: "SFU_UPDATE_CHAT",
+        CONTACT_UPDATED: "SFU_CONTACT_UPDATE",
+        CONTACT_INVITE: "SFU_CONTACT_INVITE",
+        CONTACT_REMOVED: "SFU_CONTACT_REMOVED",
         GET_USER_LIST: "getUserList",
         GET_USER_CALENDAR: "getUserCalendar",
         ADD_CALENDAR_EVENT: "addCalendarEvent",
         REMOVE_CALENDAR_EVENT: "removeCalendarEvent",
         MUTE_TRACK: "muteTrack",
+        SEND_MESSAGE: "sendMessage",
         SEND_CONTROL_MESSAGE: "sendControlMessage",
+        MARK_MESSAGE_READ: "markMessageRead",
+        MARK_MESSAGE_UNREAD: "markMessageUnread",
+        INVITE_CONTACT: "inviteContact",
+        REMOVE_CONTACT: "removeContact",
+        CONFIRM_CONTACT: "confirmContact",
         ASSIGN_ROLE: "assignRole",
         SUBSCRIBE_TO_WAITING_PARTICIPANT: "subscribeToWaitingParticipant",
         UNSUBSCRIBE_FROM_WAITING_PARTICIPANT: "unsubscribeFromWaitingParticipant",
@@ -426,12 +446,18 @@ const constants = Object.freeze({
         CONFIGURE_WAITING_ROOM: "configureWaitingRoom",
         TRACK_CONTENT_HEADER: "a=content:",
         GET_USER_CHATS: "getUserChats",
+        GET_PUBLIC_CHANNELS: "getPublicChannels",
         LOAD_CHAT: "loadChat",
         CREATE_CHAT: "createChat",
         DELETE_CHAT: "deleteChat",
         RENAME_CHAT: "renameChat",
         ADD_MEMBER_TO_CHAT: "addMemberToChat",
-        REMOVE_MEMBER_FROM_CHAT: "removeMemberFromChat"
+        REMOVE_MEMBER_FROM_CHAT: "removeMemberFromChat",
+        UPDATE_CHANNEL_SEND_POLICY: "updateChannelSendPolicy",
+        ADD_CHANNEL_SEND_PERMISSION_LIST_MEMBER: "addChannelSendPermissionListMember",
+        REMOVE_CHANNEL_SEND_PERMISSION_LIST_MEMBER: "removeChannelSendPermissionListMember",
+        ADD_CHAT_TO_FAVOURITES: "addChatToFavourites",
+        REMOVE_CHAT_FROM_FAVOURITES: "removeChatFromFavourites"
     }),
     /**
      * @namespace FlashphonerSFUExtended.SFU_OPERATIONS

package/src/sdk/logger.js

@@ -0,0 +1,16 @@
+let prefix = () => {};
+const setPrefix = (func) => {
+    if (typeof func !== "function") {
+        throw new Error("Prefix must be a function");
+    }
+    prefix = func;
+};
+const log = (...args) => {
+    console.log(prefix(), ...args);
+};
+
+module.exports = {
+    setPrefix: setPrefix,
+    log: log,
+    info: log
+};