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

Release 0.6.34
Temasys · Aug 17, 2018 · f92546e · f92546e
2 parents e633beb + 8590b87
commit f92546e
Show file tree

Hide file tree

Showing 31 changed files with 137 additions and 129 deletions.
diff --git a/README.md b/README.md
@@ -50,7 +50,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 SkylinkJS Web SDK as WebRTC is still evolving and we adapt to changes very frequently.
 
-[Latest version: `0.6.33`](https://github.com/Temasys/SkylinkJS/releases/tag/0.6.33).
+[Latest version: `0.6.34`](https://github.com/Temasys/SkylinkJS/releases/tag/0.6.34).
 
 ##### Setting AdapterJS flags
 If you require to set Temasys AdapterJS flags (e.g. forcing Temasys WebRTC plugin), we recommend the following method:

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

diff --git a/doc/classes/Skylink.html b/doc/classes/Skylink.html
@@ -2,7 +2,7 @@
 <html lang="en">
 <head>
     <meta charset="utf-8">
-    <title>Temasys Documentation - SkylinkJS 0.6.33 - Web SDK</title>
+    <title>Temasys Documentation - SkylinkJS 0.6.34 - Web SDK</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.33</small>
+          <img src="../assets/img/logo.svg" /><small>Version: 0.6.34</small>
         </a>
       </div>
       <div id="navbar" class="navbar-collapse collapse">
@@ -3417,7 +3417,7 @@ <h3 class="code-item-name"><code>_addIceCandidate</code></h3>
 
 
       <small>
-        <i class="fa fa-chevron-right"></i>&nbsp;&nbsp;Defined in: <a href="../files/source_ice-candidate.js.html#l189"><code>source&#x2F;ice-candidate.js:189</code></a>
+        <i class="fa fa-chevron-right"></i>&nbsp;&nbsp;Defined in: <a href="../files/source_ice-candidate.js.html#l192"><code>source&#x2F;ice-candidate.js:192</code></a>
       </small>
 
 
@@ -3502,7 +3502,7 @@ <h3 class="code-item-name"><code>_addIceCandidateFromQueue</code></h3>
 
 
       <small>
-        <i class="fa fa-chevron-right"></i>&nbsp;&nbsp;Defined in: <a href="../files/source_ice-candidate.js.html#l152"><code>source&#x2F;ice-candidate.js:152</code></a>
+        <i class="fa fa-chevron-right"></i>&nbsp;&nbsp;Defined in: <a href="../files/source_ice-candidate.js.html#l155"><code>source&#x2F;ice-candidate.js:155</code></a>
       </small>
 
 
@@ -3588,7 +3588,7 @@ <h3 class="code-item-name"><code>_addIceCandidateToQueue</code></h3>
 
 
       <small>
-        <i class="fa fa-chevron-right"></i>&nbsp;&nbsp;Defined in: <a href="../files/source_ice-candidate.js.html#l128"><code>source&#x2F;ice-candidate.js:128</code></a>
+        <i class="fa fa-chevron-right"></i>&nbsp;&nbsp;Defined in: <a href="../files/source_ice-candidate.js.html#l131"><code>source&#x2F;ice-candidate.js:131</code></a>
       </small>
 
 
@@ -3674,7 +3674,7 @@ <h3 class="code-item-name"><code>_addLocalMediaStreams</code></h3>
 
 
       <small>
-        <i class="fa fa-chevron-right"></i>&nbsp;&nbsp;Defined in: <a href="../files/source_stream-media.js.html#l2061"><code>source&#x2F;stream-media.js:2061</code></a>
+        <i class="fa fa-chevron-right"></i>&nbsp;&nbsp;Defined in: <a href="../files/source_stream-media.js.html#l2060"><code>source&#x2F;stream-media.js:2060</code></a>
       </small>
 
 
@@ -7113,7 +7113,7 @@ <h3 class="code-item-name"><code>_handleEndedStreams</code></h3>
 
 
       <small>
-        <i class="fa fa-chevron-right"></i>&nbsp;&nbsp;Defined in: <a href="../files/source_stream-media.js.html#l2156"><code>source&#x2F;stream-media.js:2156</code></a>
+        <i class="fa fa-chevron-right"></i>&nbsp;&nbsp;Defined in: <a href="../files/source_stream-media.js.html#l2155"><code>source&#x2F;stream-media.js:2155</code></a>
       </small>
 
 
@@ -8316,7 +8316,7 @@ <h3 class="code-item-name"><code>_onRemoteStreamAdded</code></h3>
 
 
       <small>
-        <i class="fa fa-chevron-right"></i>&nbsp;&nbsp;Defined in: <a href="../files/source_stream-media.js.html#l2027"><code>source&#x2F;stream-media.js:2027</code></a>
+        <i class="fa fa-chevron-right"></i>&nbsp;&nbsp;Defined in: <a href="../files/source_stream-media.js.html#l2026"><code>source&#x2F;stream-media.js:2026</code></a>
       </small>
 
 
@@ -8401,7 +8401,7 @@ <h3 class="code-item-name"><code>_onStreamAccessError</code></h3>
 
 
       <small>
-        <i class="fa fa-chevron-right"></i>&nbsp;&nbsp;Defined in: <a href="../files/source_stream-media.js.html#l1986"><code>source&#x2F;stream-media.js:1986</code></a>
+        <i class="fa fa-chevron-right"></i>&nbsp;&nbsp;Defined in: <a href="../files/source_stream-media.js.html#l1985"><code>source&#x2F;stream-media.js:1985</code></a>
       </small>
 
 
@@ -8486,7 +8486,7 @@ <h3 class="code-item-name"><code>_onStreamAccessSuccess</code></h3>
 
 
       <small>
-        <i class="fa fa-chevron-right"></i>&nbsp;&nbsp;Defined in: <a href="../files/source_stream-media.js.html#l1840"><code>source&#x2F;stream-media.js:1840</code></a>
+        <i class="fa fa-chevron-right"></i>&nbsp;&nbsp;Defined in: <a href="../files/source_stream-media.js.html#l1839"><code>source&#x2F;stream-media.js:1839</code></a>
       </small>
 
 
@@ -23665,7 +23665,7 @@ <h3 class="code-item-name"><code>shareScreen</code></h3>
       <h4>Example:</h4>
       <pre class="example-content prettyprint">
         <p>  // Example 1: Share screen with audio
-  skylinkDemo.shareScreen(function (error, success) {
+  skylinkDemo.shareScreen(true, function (error, success) {
     if (error) return;
     attachMediaStream(document.getElementById(&quot;my-screen&quot;), success);
   });</p>

diff --git a/doc/data.json b/doc/data.json
@@ -2,7 +2,7 @@
     "project": {
         "name": "skylinkjs",
         "description": "Temasys Web SDK is an open-source client-side library for your web-browser that enables any website to easily leverage the capabilities of WebRTC and its direct data streaming powers between peers for audio/video conferencing or file transfer.",
-        "version": "0.6.33",
+        "version": "0.6.34",
         "url": "https://temasys.io/"
     },
     "files": {
@@ -3445,7 +3445,7 @@
         },
         {
             "file": "source/ice-candidate.js",
-            "line": 128,
+            "line": 131,
             "description": "Function that buffers the Peer connection ICE candidate when received\n  before remote session description is received and set.",
             "itemtype": "method",
             "name": "_addIceCandidateToQueue",
@@ -3456,7 +3456,7 @@
         },
         {
             "file": "source/ice-candidate.js",
-            "line": 152,
+            "line": 155,
             "description": "Function that adds all the Peer connection buffered ICE candidates received.\nThis should be called only after the remote session description is received and set.",
             "itemtype": "method",
             "name": "_addIceCandidateFromQueue",
@@ -3467,7 +3467,7 @@
         },
         {
             "file": "source/ice-candidate.js",
-            "line": 189,
+            "line": 192,
             "description": "Function that adds the ICE candidate to Peer connection.",
             "itemtype": "method",
             "name": "_addIceCandidate",
@@ -9592,7 +9592,7 @@
                 }
             ],
             "example": [
-                "\n  // Example 1: Share screen with audio\n  skylinkDemo.shareScreen(function (error, success) {\n    if (error) return;\n    attachMediaStream(document.getElementById(\"my-screen\"), success);\n  });\n\n  // Example 2: Share screen without audio\n  skylinkDemo.shareScreen(false, function (error, success) {\n    if (error) return;\n    attachMediaStream(document.getElementById(\"my-screen\"), success);\n  });\n\n  // Example 3: Share \"window\" media source\n  skylinkDemo.shareScreen(\"window\", function (error, success) {\n    if (error) return;\n    attachMediaStream(document.getElementById(\"my-screen\"), success);\n  });\n\n  // Example 4: Share tab and its audio media source\n  skylinkDemo.shareScreen(true, [\"tab\", \"audio\"], function (error, success) {\n    if (error) return;\n    attachMediaStream(document.getElementById(\"my-screen\"), success);\n  });\n\n  // Example 5: Share \"window\" and \"screen\" media source\n  skylinkDemo.shareScreen([\"window\", \"screen\"], function (error, success) {\n    if (error) return;\n    attachMediaStream(document.getElementById(\"my-screen\"), success);\n  });\n\n  // Example 6: Share \"window\" with specific media source for specific plugin build users.\n  skylinkDemo.shareScreen({ mediaSource: \"window\", sourceId: \"xxxxx\" }, function (error, success) {\n    if (error) return;\n    attachMediaStream(document.getElementById(\"my-screen\"), success);\n  });"
+                "\n  // Example 1: Share screen with audio\n  skylinkDemo.shareScreen(true, function (error, success) {\n    if (error) return;\n    attachMediaStream(document.getElementById(\"my-screen\"), success);\n  });\n\n  // Example 2: Share screen without audio\n  skylinkDemo.shareScreen(false, function (error, success) {\n    if (error) return;\n    attachMediaStream(document.getElementById(\"my-screen\"), success);\n  });\n\n  // Example 3: Share \"window\" media source\n  skylinkDemo.shareScreen(\"window\", function (error, success) {\n    if (error) return;\n    attachMediaStream(document.getElementById(\"my-screen\"), success);\n  });\n\n  // Example 4: Share tab and its audio media source\n  skylinkDemo.shareScreen(true, [\"tab\", \"audio\"], function (error, success) {\n    if (error) return;\n    attachMediaStream(document.getElementById(\"my-screen\"), success);\n  });\n\n  // Example 5: Share \"window\" and \"screen\" media source\n  skylinkDemo.shareScreen([\"window\", \"screen\"], function (error, success) {\n    if (error) return;\n    attachMediaStream(document.getElementById(\"my-screen\"), success);\n  });\n\n  // Example 6: Share \"window\" with specific media source for specific plugin build users.\n  skylinkDemo.shareScreen({ mediaSource: \"window\", sourceId: \"xxxxx\" }, function (error, success) {\n    if (error) return;\n    attachMediaStream(document.getElementById(\"my-screen\"), success);\n  });"
             ],
             "trigger": "<ol class=\"desc-seq\">\n  <li>Retrieves screensharing Stream. <ol><li>If retrieval was successful: <ol><li>If browser is Firefox: <ol>\n  <li>If there are missing audio or video tracks requested: <ol>\n  <li>If there is any previous <code>shareScreen()</code> Stream: <ol>\n  <li>Invokes <a href=\"#method_stopScreen\"><code>stopScreen()</code> method</a>.</li></ol></li>\n  <li><a href=\"#event_mediaAccessFallback\"><code>mediaAccessFallback</code> event</a>\n  triggers parameter payload <code>state</code> as <code>FALLBACKED</code>, <code>isScreensharing</code>\n  value as <code>true</code> and <code>isAudioFallback</code> value as <code>false</code>.</li></ol></li>\n  <li><a href=\"#event_mediaAccessSuccess\"><code>mediaAccessSuccess</code> event</a> triggers\n  parameter payload <code>isScreensharing</code> value as <code>true</code> and <code>isAudioFallback</code>\n  value as <code>false</code>.</li></ol></li><li>Else: <ol>\n  <li>If audio is requested: <small>Chrome, Safari and IE currently doesn't support retrieval of\n  audio track together with screensharing video track.</small> <ol><li>Retrieves audio Stream: <ol>\n  <li>If retrieval was successful: <ol><li>Attempts to attach screensharing Stream video track to audio Stream. <ol>\n  <li>If attachment was successful: <ol><li><a href=\"#event_mediaAccessSuccess\">\n  <code>mediaAccessSuccess</code> event</a> triggers parameter payload <code>isScreensharing</code>\n  value as <code>true</code> and <code>isAudioFallback</code> value as <code>false</code>.</li></ol></li><li>Else: <ol>\n  <li>If there is any previous <code>shareScreen()</code> Stream: <ol>\n  <li>Invokes <a href=\"#method_stopScreen\"><code>stopScreen()</code> method</a>.</li></ol></li>\n  <li><a href=\"#event_mediaAccessFallback\"><code>mediaAccessFallback</code> event</a> triggers parameter payload\n  <code>state</code> as <code>FALLBACKED</code>, <code>isScreensharing</code> value as <code>true</code> and\n  <code>isAudioFallback</code> value as <code>false</code>.</li>\n  <li><a href=\"#event_mediaAccessSuccess\"><code>mediaAccessSuccess</code> event</a> triggers\n  parameter payload <code>isScreensharing</code> value as <code>true</code> and <code>isAudioFallback</code>\n  value as <code>false</code>.</li></ol></li></ol></li></ol></li><li>Else: <ol>\n  <li>If there is any previous <code>shareScreen()</code> Stream: <ol>\n  <li>Invokes <a href=\"#method_stopScreen\"><code>stopScreen()</code> method</a>.</li></ol></li>\n  <li><a href=\"#event_mediaAccessFallback\"><code>mediaAccessFallback</code> event</a>\n  triggers parameter payload <code>state</code> as <code>FALLBACKED</code>, <code>isScreensharing</code>\n  value as <code>true</code> and <code>isAudioFallback</code> value as <code>false</code>.</li>\n  <li><a href=\"#event_mediaAccessSuccess\"><code>mediaAccessSuccess</code> event</a> triggers\n  parameter payload <code>isScreensharing</code> value as <code>true</code> and <code>isAudioFallback</code>\n  value as <code>false</code>.</li></ol></li></ol></li></ol></li><li>Else: <ol>\n  <li><a href=\"#event_mediaAccessSuccess\"><code>mediaAccessSuccess</code> event</a>\n  triggers parameter payload <code>isScreensharing</code> value as <code>true</code>\n  and <code>isAudioFallback</code> value as <code>false</code>.</li></ol></li></ol></li></ol></li><li>Else: <ol>\n  <li><a href=\"#event_mediaAccessError\"><code>mediaAccessError</code> event</a> triggers parameter payload\n  <code>isScreensharing</code> value as <code>true</code> and <code>isAudioFallback</code> value as\n  <code>false</code>.</li><li><b>ABORT</b> and return error.</li></ol></li></ol></li><li>If User is in Room: <ol>\n  <li><a href=\"#event_incomingStream\"><code>incomingStream</code> event</a> triggers parameter payload\n  <code>isSelf</code> value as <code>true</code> and <code>stream</code> as <code>shareScreen()</code> Stream.</li>\n  <li><a href=\"#event_peerUpdated\"><code>peerUpdated</code> event</a> triggers parameter payload\n  <code>isSelf</code> value as <code>true</code>.</li>\n  <li>Checks if MCU is enabled for App Key provided in <a href=\"#method_init\"><code>init()</code> method</a>. <ol>\n  <li>If MCU is enabled: <ol><li>Invoke <a href=\"#method_refreshConnection\"><code>refreshConnection()</code> method</a>.\n  <ol><li>If request has errors: <ol><li><b>ABORT</b> and return error.</li></ol></li></ol></li></ol></li><li>Else: <ol>\n  <li>If there are connected Peers in the Room: <ol><li>Invoke <a href=\"#method_refreshConnection\">\n  <code>refreshConnection()</code> method</a>. <ol><li>If request has errors: <ol><li><b>ABORT</b> and return error.</li>\n  </ol></li></ol></li></ol></li></ol></li></ol></li></ol></li></ol>",
             "since": "0.6.0",
@@ -9798,7 +9798,7 @@
         },
         {
             "file": "source/stream-media.js",
-            "line": 1840,
+            "line": 1839,
             "description": "Function that handles the native <code>navigator.getUserMedia()</code> API success callback result.",
             "itemtype": "method",
             "name": "_onStreamAccessSuccess",
@@ -9809,7 +9809,7 @@
         },
         {
             "file": "source/stream-media.js",
-            "line": 1986,
+            "line": 1985,
             "description": "Function that handles the native <code>navigator.getUserMedia()</code> API failure callback result.",
             "itemtype": "method",
             "name": "_onStreamAccessError",
@@ -9820,7 +9820,7 @@
         },
         {
             "file": "source/stream-media.js",
-            "line": 2027,
+            "line": 2026,
             "description": "Function that handles the <code>RTCPeerConnection.onaddstream</code> remote MediaStream received.",
             "itemtype": "method",
             "name": "_onRemoteStreamAdded",
@@ -9831,7 +9831,7 @@
         },
         {
             "file": "source/stream-media.js",
-            "line": 2061,
+            "line": 2060,
             "description": "Function that sets User's Stream to send to Peer connection.\nPriority for <code>shareScreen()</code> Stream over <code>getUserMedia()</code> Stream.",
             "itemtype": "method",
             "name": "_addLocalMediaStreams",
@@ -9842,7 +9842,7 @@
         },
         {
             "file": "source/stream-media.js",
-            "line": 2156,
+            "line": 2155,
             "description": "Function that handles ended streams.",
             "itemtype": "method",
             "name": "_handleEndedStreams",

diff --git a/doc/files/source_constants.js.html b/doc/files/source_constants.js.html
@@ -2,7 +2,7 @@
 <html lang="en">
 <head>
     <meta charset="utf-8">
-    <title>Temasys Documentation - SkylinkJS 0.6.33 - Web SDK</title>
+    <title>Temasys Documentation - SkylinkJS 0.6.34 - Web SDK</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.33</small>
+          <img src="../assets/img/logo.svg" /><small>Version: 0.6.34</small>
         </a>
       </div>
       <div id="navbar" class="navbar-collapse collapse">

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>Temasys Documentation - SkylinkJS 0.6.33 - Web SDK</title>
+    <title>Temasys Documentation - SkylinkJS 0.6.34 - Web SDK</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.33</small>
+          <img src="../assets/img/logo.svg" /><small>Version: 0.6.34</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>Temasys Documentation - SkylinkJS 0.6.33 - Web SDK</title>
+    <title>Temasys Documentation - SkylinkJS 0.6.34 - Web SDK</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.33</small>
+          <img src="../assets/img/logo.svg" /><small>Version: 0.6.34</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>Temasys Documentation - SkylinkJS 0.6.33 - Web SDK</title>
+    <title>Temasys Documentation - SkylinkJS 0.6.34 - Web SDK</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.33</small>
+          <img src="../assets/img/logo.svg" /><small>Version: 0.6.34</small>
         </a>
       </div>
       <div id="navbar" class="navbar-collapse collapse">