Merge pull request #290 from Temasys/0.6.x/development

Release 0.6.24
Temasys · Jul 24, 2017 · 7a1480f · 7a1480f
2 parents e794227 + 8eeda30
commit 7a1480f
Show file tree

Hide file tree

Showing 30 changed files with 406 additions and 267 deletions.
diff --git a/README.md b/README.md
@@ -51,7 +51,7 @@ You can raise tickets on [our support portal](http://support.temasys.io) or on [
 ##### Current versions and stability
 We recommend that you always use the latest versions of the Temasys Web SDK as WebRTC is still evolving and we adapt to changes very frequently.
 
-[Latest version: `0.6.23`](https://github.com/Temasys/SkylinkJS/releases/tag/0.6.23).
+[Latest version: `0.6.24`](https://github.com/Temasys/SkylinkJS/releases/tag/0.6.24).
 
 #### Noted Issues and Solutions
 ##### Installing `0.6.3` - `0.6.10` versions in NPM

diff --git a/bower.json b/bower.json
@@ -1,7 +1,7 @@
 {
   "name": "skylinkjs",
   "description": "WebRTC real-time video conversation library",
-  "version": "0.6.23",
+  "version": "0.6.24",
   "homepage": "https://temasys.io",
   "author": {
     "name": "Temasys Communications Pte. Ltd.",

diff --git a/doc/classes/Skylink.html b/doc/classes/Skylink.html
diff --git a/doc/data.json b/doc/data.json
diff --git a/doc/files/source_data-channel.js.html b/doc/files/source_data-channel.js.html
@@ -2,7 +2,7 @@
 <html lang="en">
 <head>
     <meta charset="utf-8">
-    <title>SkylinkJS 0.6.23</title>
+    <title>SkylinkJS 0.6.24</title>
     <meta name="viewport" content="width=device-width, initial-scale=1">
     <!-- font and icon -->
     <link rel="shortcut icon" type="image/ico" href="../assets/favicon.ico">
@@ -33,7 +33,7 @@
           <span class="icon-bar"></span>
         </button>
         <a href="" class="navbar-brand">
-          <img src="../assets/img/logo.svg" /><small>Version: 0.6.23</small>
+          <img src="../assets/img/logo.svg" /><small>Version: 0.6.24</small>
         </a>
       </div>
       <div id="navbar" class="navbar-collapse collapse">

diff --git a/doc/files/source_data-process.js.html b/doc/files/source_data-process.js.html
@@ -2,7 +2,7 @@
 <html lang="en">
 <head>
     <meta charset="utf-8">
-    <title>SkylinkJS 0.6.23</title>
+    <title>SkylinkJS 0.6.24</title>
     <meta name="viewport" content="width=device-width, initial-scale=1">
     <!-- font and icon -->
     <link rel="shortcut icon" type="image/ico" href="../assets/favicon.ico">
@@ -33,7 +33,7 @@
           <span class="icon-bar"></span>
         </button>
         <a href="" class="navbar-brand">
-          <img src="../assets/img/logo.svg" /><small>Version: 0.6.23</small>
+          <img src="../assets/img/logo.svg" /><small>Version: 0.6.24</small>
         </a>
       </div>
       <div id="navbar" class="navbar-collapse collapse">

diff --git a/doc/files/source_data-transfer.js.html b/doc/files/source_data-transfer.js.html
@@ -2,7 +2,7 @@
 <html lang="en">
 <head>
     <meta charset="utf-8">
-    <title>SkylinkJS 0.6.23</title>
+    <title>SkylinkJS 0.6.24</title>
     <meta name="viewport" content="width=device-width, initial-scale=1">
     <!-- font and icon -->
     <link rel="shortcut icon" type="image/ico" href="../assets/favicon.ico">
@@ -33,7 +33,7 @@
           <span class="icon-bar"></span>
         </button>
         <a href="" class="navbar-brand">
-          <img src="../assets/img/logo.svg" /><small>Version: 0.6.23</small>
+          <img src="../assets/img/logo.svg" /><small>Version: 0.6.24</small>
         </a>
       </div>
       <div id="navbar" class="navbar-collapse collapse">

diff --git a/doc/files/source_ice-candidate.js.html b/doc/files/source_ice-candidate.js.html
@@ -2,7 +2,7 @@
 <html lang="en">
 <head>
     <meta charset="utf-8">
-    <title>SkylinkJS 0.6.23</title>
+    <title>SkylinkJS 0.6.24</title>
     <meta name="viewport" content="width=device-width, initial-scale=1">
     <!-- font and icon -->
     <link rel="shortcut icon" type="image/ico" href="../assets/favicon.ico">
@@ -33,7 +33,7 @@
           <span class="icon-bar"></span>
         </button>
         <a href="" class="navbar-brand">
-          <img src="../assets/img/logo.svg" /><small>Version: 0.6.23</small>
+          <img src="../assets/img/logo.svg" /><small>Version: 0.6.24</small>
         </a>
       </div>
       <div id="navbar" class="navbar-collapse collapse">

diff --git a/doc/files/source_ice-connection.js.html b/doc/files/source_ice-connection.js.html
@@ -2,7 +2,7 @@
 <html lang="en">
 <head>
     <meta charset="utf-8">
-    <title>SkylinkJS 0.6.23</title>
+    <title>SkylinkJS 0.6.24</title>
     <meta name="viewport" content="width=device-width, initial-scale=1">
     <!-- font and icon -->
     <link rel="shortcut icon" type="image/ico" href="../assets/favicon.ico">
@@ -33,7 +33,7 @@
           <span class="icon-bar"></span>
         </button>
         <a href="" class="navbar-brand">
-          <img src="../assets/img/logo.svg" /><small>Version: 0.6.23</small>
+          <img src="../assets/img/logo.svg" /><small>Version: 0.6.24</small>
         </a>
       </div>
       <div id="navbar" class="navbar-collapse collapse">

diff --git a/doc/files/source_peer-connection.js.html b/doc/files/source_peer-connection.js.html
@@ -2,7 +2,7 @@
 <html lang="en">
 <head>
     <meta charset="utf-8">
-    <title>SkylinkJS 0.6.23</title>
+    <title>SkylinkJS 0.6.24</title>
     <meta name="viewport" content="width=device-width, initial-scale=1">
     <!-- font and icon -->
     <link rel="shortcut icon" type="image/ico" href="../assets/favicon.ico">
@@ -33,7 +33,7 @@
           <span class="icon-bar"></span>
         </button>
         <a href="" class="navbar-brand">
-          <img src="../assets/img/logo.svg" /><small>Version: 0.6.23</small>
+          <img src="../assets/img/logo.svg" /><small>Version: 0.6.24</small>
         </a>
       </div>
       <div id="navbar" class="navbar-collapse collapse">

diff --git a/doc/files/source_peer-data.js.html b/doc/files/source_peer-data.js.html
@@ -2,7 +2,7 @@
 <html lang="en">
 <head>
     <meta charset="utf-8">
-    <title>SkylinkJS 0.6.23</title>
+    <title>SkylinkJS 0.6.24</title>
     <meta name="viewport" content="width=device-width, initial-scale=1">
     <!-- font and icon -->
     <link rel="shortcut icon" type="image/ico" href="../assets/favicon.ico">
@@ -33,7 +33,7 @@
           <span class="icon-bar"></span>
         </button>
         <a href="" class="navbar-brand">
-          <img src="../assets/img/logo.svg" /><small>Version: 0.6.23</small>
+          <img src="../assets/img/logo.svg" /><small>Version: 0.6.24</small>
         </a>
       </div>
       <div id="navbar" class="navbar-collapse collapse">

diff --git a/doc/files/source_peer-handshake.js.html b/doc/files/source_peer-handshake.js.html
@@ -2,7 +2,7 @@
 <html lang="en">
 <head>
     <meta charset="utf-8">
-    <title>SkylinkJS 0.6.23</title>
+    <title>SkylinkJS 0.6.24</title>
     <meta name="viewport" content="width=device-width, initial-scale=1">
     <!-- font and icon -->
     <link rel="shortcut icon" type="image/ico" href="../assets/favicon.ico">
@@ -33,7 +33,7 @@
           <span class="icon-bar"></span>
         </button>
         <a href="" class="navbar-brand">
-          <img src="../assets/img/logo.svg" /><small>Version: 0.6.23</small>
+          <img src="../assets/img/logo.svg" /><small>Version: 0.6.24</small>
         </a>
       </div>
       <div id="navbar" class="navbar-collapse collapse">

diff --git a/doc/files/source_peer-privileged.js.html b/doc/files/source_peer-privileged.js.html
@@ -2,7 +2,7 @@
 <html lang="en">
 <head>
     <meta charset="utf-8">
-    <title>SkylinkJS 0.6.23</title>
+    <title>SkylinkJS 0.6.24</title>
     <meta name="viewport" content="width=device-width, initial-scale=1">
     <!-- font and icon -->
     <link rel="shortcut icon" type="image/ico" href="../assets/favicon.ico">
@@ -33,7 +33,7 @@
           <span class="icon-bar"></span>
         </button>
         <a href="" class="navbar-brand">
-          <img src="../assets/img/logo.svg" /><small>Version: 0.6.23</small>
+          <img src="../assets/img/logo.svg" /><small>Version: 0.6.24</small>
         </a>
       </div>
       <div id="navbar" class="navbar-collapse collapse">

diff --git a/doc/files/source_room-connection.js.html b/doc/files/source_room-connection.js.html
@@ -2,7 +2,7 @@
 <html lang="en">
 <head>
     <meta charset="utf-8">
-    <title>SkylinkJS 0.6.23</title>
+    <title>SkylinkJS 0.6.24</title>
     <meta name="viewport" content="width=device-width, initial-scale=1">
     <!-- font and icon -->
     <link rel="shortcut icon" type="image/ico" href="../assets/favicon.ico">
@@ -33,7 +33,7 @@
           <span class="icon-bar"></span>
         </button>
         <a href="" class="navbar-brand">
-          <img src="../assets/img/logo.svg" /><small>Version: 0.6.23</small>
+          <img src="../assets/img/logo.svg" /><small>Version: 0.6.24</small>
         </a>
       </div>
       <div id="navbar" class="navbar-collapse collapse">
@@ -290,7 +290,18 @@ <h1 class="file-heading">File: source/room-connection.js</h1>
  *   &lt;code&gt;options.sdpSettings.direction.video.send&lt;/code&gt; value to &lt;code&gt;true&lt;/code&gt; and
  *   &lt;code&gt;options.sdpSettings.direction.audio.send&lt;/code&gt; value to &lt;code&gt;true&lt;/code&gt;.&lt;br&gt;
  *   Note that this feature is currently is beta, and for any enquiries on enabling and its support for MCU enabled
- *   Peer connections, please  contact &lt;a href=&quot;http://support.temasys.io&quot;&gt;our support portal&lt;/a&gt;.&lt;/blockquote&gt;&lt;/blockquote&gt;
+ *   Peer connections, please  contact &lt;a href=&quot;http://support.temasys.io&quot;&gt;our support portal&lt;/a&gt;.&lt;br&gt;&lt;br&gt;
+ *   How does the publish only functionality work? Imagine several Skylink instances like A1, B1, C1 and A1
+ *   opening a new instance A2 with publish only enabled with configured A1 as parent.&lt;br&gt;&lt;br&gt;
+ *   &lt;table class=&quot;table&quot;&gt;&lt;thead&gt;
+ *   &lt;tr&gt;&lt;th&gt;&lt;/th&gt;&lt;th colspan=&quot;2&quot;&gt;MCU enabled room&lt;/th&gt;&lt;th colspan=&quot;2&quot;&gt;MCU disabled room&lt;/th&gt;&lt;/tr&gt;
+ *   &lt;tr&gt;&lt;th&gt;&lt;/th&gt;&lt;th&gt;Presence&lt;/th&gt;&lt;th&gt;Stream&lt;/th&gt;&lt;th&gt;Presence&lt;/th&gt;&lt;th&gt;Stream&lt;/th&gt;&lt;/tr&gt;&lt;/thead&gt;&lt;tbody&gt;
+ *   &lt;tr&gt;&lt;th&gt;A1&lt;/th&gt;&lt;td&gt;B1, C1&lt;/td&gt;&lt;td&gt;B1, C1&lt;/td&gt;&lt;td&gt;B1, C1&lt;/td&gt;&lt;td&gt;B1, C1&lt;/td&gt;&lt;/tr&gt;
+ *   &lt;tr&gt;&lt;th&gt;B1&lt;/th&gt;&lt;td&gt;A1, C1, A2&lt;/td&gt;&lt;td&gt;A1, C1, A2&lt;/td&gt;&lt;td&gt;A1, C1, A2&lt;/td&gt;&lt;td&gt;A1, C1, A2&lt;/td&gt;&lt;/tr&gt;
+ *   &lt;tr&gt;&lt;th&gt;C1&lt;/th&gt;&lt;td&gt;B1, C1, A2&lt;/td&gt;&lt;td&gt;B1, C1, A2&lt;/td&gt;&lt;td&gt;B1, C1, A2&lt;/td&gt;&lt;td&gt;B1, C1, A2&lt;/td&gt;&lt;/tr&gt;
+ *   &lt;tr&gt;&lt;th&gt;A2&lt;/th&gt;&lt;td&gt;&lt;/td&gt;&lt;td&gt;&lt;/td&gt;&lt;td&gt;B1, C1&lt;/td&gt;&lt;td&gt;&lt;/td&gt;&lt;/tr&gt;&lt;/tbody&gt;&lt;/table&gt;
+ *   Parent and child will not receive each other presence and stream because they are related to each other in the same client page,
+ *   hence no uploading or downloading is required. If A2 did not configure A1 as the parent, A1 will receive A2.&lt;/blockquote&gt;
  *   The config if Peer would publish only.
  * @param {String} [options.publishOnly.parentId] &lt;blockquote class=&quot;info&quot;&gt;&lt;b&gt;Deprecation Warning!&lt;/b&gt;
  *   This property has been deprecated. Use &lt;code&gt;options.parentId&lt;/code&gt; instead.

diff --git a/doc/files/source_room-init.js.html b/doc/files/source_room-init.js.html
@@ -2,7 +2,7 @@
 <html lang="en">
 <head>
     <meta charset="utf-8">
-    <title>SkylinkJS 0.6.23</title>
+    <title>SkylinkJS 0.6.24</title>
     <meta name="viewport" content="width=device-width, initial-scale=1">
     <!-- font and icon -->
     <link rel="shortcut icon" type="image/ico" href="../assets/favicon.ico">
@@ -33,7 +33,7 @@
           <span class="icon-bar"></span>
         </button>
         <a href="" class="navbar-brand">
-          <img src="../assets/img/logo.svg" /><small>Version: 0.6.23</small>
+          <img src="../assets/img/logo.svg" /><small>Version: 0.6.24</small>
         </a>
       </div>
       <div id="navbar" class="navbar-collapse collapse">
@@ -355,7 +355,12 @@ <h1 class="file-heading">File: source/room-init.js</h1>
  *   Note that this is mainly used for debugging purposes and that it is an experimental flag, so
  *   it may cause disruptions in connections or connectivity issues when toggled. &lt;/blockquote&gt;
  *   The flag if video REMB feedback packets should be disabled in sending session descriptions.
- * @param {JSON} [options.credentials] The credentials used for authenticating App Key with
+ * @param {JSON} [options.credentials] &lt;blockquote class=&quot;info&quot;&gt;
+ *   Note that we strongly recommend developers to return the &lt;code&gt;options.credentials.duration&lt;/code&gt;,
+ *   &lt;code&gt;options.credentials.startDateTime&lt;/code&gt; and &lt;code&gt;options.defaultRoom&lt;/code&gt; and generate the
+ *   &lt;code&gt;options.credentials.credentials&lt;/code&gt; from a web server as secret shouldn&#x27;t be exposed on client web app as
+ *   it poses a security risk itself.&lt;/blockquote&gt;
+ *   The credentials used for authenticating App Key with
  *   credentials to retrieve the Room session token used for connection in &lt;a href=&quot;#method_joinRoom&quot;&gt;
  *   &lt;code&gt;joinRoom()&lt;/code&gt; method&lt;/a&gt;.
  *   &lt;small&gt;Note that switching of Rooms is not allowed when using credentials based authentication, unless
@@ -519,8 +524,9 @@ <h1 class="file-heading">File: source/room-init.js</h1>
  * @param {JSON} [options.codecParams.audio.opus] &lt;blockquote class=&quot;info&quot;&gt;
  *   Note that this is only applicable to OPUS audio codecs with a sampling rate of &lt;code&gt;48000&lt;/code&gt; Hz (hertz).
  *   &lt;/blockquote&gt; The OPUS audio codec parameters to configure.
- * @param {Boolean} [options.codecParams.audio.opus.stereo] The flag if OPUS audio codec stereo band
- *   should be configured for sending encoded audio data.
+ * @param {Boolean} [options.codecParams.audio.opus.stereo] The flag if OPUS audio codec is able to decode or receive stereo packets.
+ *   &lt;small&gt;When not provided, the default browser configuration is used.&lt;/small&gt;
+ * @param {Boolean} [options.codecParams.audio.opus.sprop-stereo] The flag if OPUS audio codec is sending stereo packets.
  *   &lt;small&gt;When not provided, the default browser configuration is used.&lt;/small&gt;
  * @param {Boolean} [options.codecParams.audio.opus.usedtx] &lt;blockquote class=&quot;info&quot;&gt;
  *   Note that this feature might not work depending on the browser support and implementation.&lt;/blockquote&gt;
@@ -620,7 +626,7 @@ <h1 class="file-heading">File: source/room-init.js</h1>
  *       startDateTime = (new Date()).toISOString(),
  *       duration      = 1, // Allows only User session to stay for 1 hour
  *       appKeySecret  = &quot;xxxxxxx&quot;,
- *       hash          = CryptoJS.HmacSHA1(defaultRoom + &quot;_&quot; + duration + &quot;_&quot; + startDateTime, appKeySecret);
+ *       hash          = CryptoJS.HmacSHA1(defaultRoom + &quot;\_&quot; + duration + &quot;\_&quot; + startDateTime, appKeySecret);
  *       credentials   = encodeURIComponent(hash.toString(CryptoJS.enc.Base64));
  *
  *   skylinkDemo({
@@ -919,6 +925,8 @@ <h1 class="file-heading">File: source/room-init.js</h1>
           codecParams.audio.opus = {
             stereo: typeof options.codecParams.audio.opus.stereo === &#x27;boolean&#x27; ?
               options.codecParams.audio.opus.stereo : null,
+            &#x27;sprop-stereo&#x27;: typeof options.codecParams.audio.opus[&#x27;sprop-stereo&#x27;] === &#x27;boolean&#x27; ?
+              options.codecParams.audio.opus[&#x27;sprop-stereo&#x27;] : null,
             usedtx: typeof options.codecParams.audio.opus.usedtx === &#x27;boolean&#x27; ?
               options.codecParams.audio.opus.usedtx : null,
             useinbandfec: typeof options.codecParams.audio.opus.useinbandfec === &#x27;boolean&#x27; ?

diff --git a/doc/files/source_skylink-events.js.html b/doc/files/source_skylink-events.js.html
@@ -2,7 +2,7 @@
 <html lang="en">
 <head>
     <meta charset="utf-8">
-    <title>SkylinkJS 0.6.23</title>
+    <title>SkylinkJS 0.6.24</title>
     <meta name="viewport" content="width=device-width, initial-scale=1">
     <!-- font and icon -->
     <link rel="shortcut icon" type="image/ico" href="../assets/favicon.ico">
@@ -33,7 +33,7 @@
           <span class="icon-bar"></span>
         </button>
         <a href="" class="navbar-brand">
-          <img src="../assets/img/logo.svg" /><small>Version: 0.6.23</small>
+          <img src="../assets/img/logo.svg" /><small>Version: 0.6.24</small>
         </a>
       </div>
       <div id="navbar" class="navbar-collapse collapse">

diff --git a/doc/files/source_socket-channel.js.html b/doc/files/source_socket-channel.js.html
@@ -2,7 +2,7 @@
 <html lang="en">
 <head>
     <meta charset="utf-8">
-    <title>SkylinkJS 0.6.23</title>
+    <title>SkylinkJS 0.6.24</title>
     <meta name="viewport" content="width=device-width, initial-scale=1">
     <!-- font and icon -->
     <link rel="shortcut icon" type="image/ico" href="../assets/favicon.ico">
@@ -33,7 +33,7 @@
           <span class="icon-bar"></span>
         </button>
         <a href="" class="navbar-brand">
-          <img src="../assets/img/logo.svg" /><small>Version: 0.6.23</small>
+          <img src="../assets/img/logo.svg" /><small>Version: 0.6.24</small>
         </a>
       </div>
       <div id="navbar" class="navbar-collapse collapse">

diff --git a/doc/files/source_socket-message.js.html b/doc/files/source_socket-message.js.html
@@ -2,7 +2,7 @@
 <html lang="en">
 <head>
     <meta charset="utf-8">
-    <title>SkylinkJS 0.6.23</title>
+    <title>SkylinkJS 0.6.24</title>
     <meta name="viewport" content="width=device-width, initial-scale=1">
     <!-- font and icon -->
     <link rel="shortcut icon" type="image/ico" href="../assets/favicon.ico">
@@ -33,7 +33,7 @@
           <span class="icon-bar"></span>
         </button>
         <a href="" class="navbar-brand">
-          <img src="../assets/img/logo.svg" /><small>Version: 0.6.23</small>
+          <img src="../assets/img/logo.svg" /><small>Version: 0.6.24</small>
         </a>
       </div>
       <div id="navbar" class="navbar-collapse collapse">