Skip to content

Commit

Permalink
Merged in master (pull request #452)
Browse files Browse the repository at this point in the history
Master
  • Loading branch information
dinawee committed Mar 24, 2022
2 parents 237b33e + 57e4f5c commit 07a0b94
Show file tree
Hide file tree
Showing 234 changed files with 1,215 additions and 1,286 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# SKYLINK WEB SDK 2.4.1
# SKYLINK WEB SDK 2.4.2
> Temasys SkylinkJS 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.
You'll need a Temasys Account, and an App key to use this. [Register here to get your App key](https://console.temasys.io).
Expand Down Expand Up @@ -34,7 +34,7 @@ You'll need a Temasys Account, and an App key to use this. [Register here to get
- 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.
- It is advised to not attach any event handlers to the WebRTC APIs as doing so may override the handlers set in SkylinkJS and result in unexpected behaviour.

[Latest version: 2.4.1](https://github.com/Temasys/SkylinkJS/releases/tag/2.4.1)
[Latest version: 2.4.2](https://github.com/Temasys/SkylinkJS/releases/tag/2.4.2)


## How to build your own Temasys SkylinkJS Web SDK
Expand Down
72 changes: 30 additions & 42 deletions docs/Skylink.html
Original file line number Diff line number Diff line change
Expand Up @@ -478,7 +478,7 @@ <h5>Parameters:</h5>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="public_index.js.html">public/index.js</a>, <a href="public_index.js.html#line1474">line 1474</a>
<a href="public_index.js.html">public/index.js</a>, <a href="public_index.js.html#line1462">line 1462</a>
</li>
</ul>
</dd>
Expand Down Expand Up @@ -691,7 +691,7 @@ <h5>Parameters:</h5>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="public_index.js.html">public/index.js</a>, <a href="public_index.js.html#line1312">line 1312</a>
<a href="public_index.js.html">public/index.js</a>, <a href="public_index.js.html#line1300">line 1300</a>
</li>
</ul>
</dd>
Expand Down Expand Up @@ -791,7 +791,7 @@ <h4 class="name" id="generateUUID">
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="public_index.js.html">public/index.js</a>, <a href="public_index.js.html#line1274">line 1274</a>
<a href="public_index.js.html">public/index.js</a>, <a href="public_index.js.html#line1262">line 1262</a>
</li>
</ul>
</dd>
Expand Down Expand Up @@ -1185,7 +1185,7 @@ <h5>Parameters:</h5>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="public_index.js.html">public/index.js</a>, <a href="public_index.js.html#line1299">line 1299</a>
<a href="public_index.js.html">public/index.js</a>, <a href="public_index.js.html#line1287">line 1287</a>
</li>
</ul>
</dd>
Expand Down Expand Up @@ -1340,7 +1340,7 @@ <h5>Parameters:</h5>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="public_index.js.html">public/index.js</a>, <a href="public_index.js.html#line1370">line 1370</a>
<a href="public_index.js.html">public/index.js</a>, <a href="public_index.js.html#line1358">line 1358</a>
</li>
</ul>
</dd>
Expand Down Expand Up @@ -2511,7 +2511,7 @@ <h5>Parameters:</h5>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="public_index.js.html">public/index.js</a>, <a href="public_index.js.html#line1000">line 1000</a>
<a href="public_index.js.html">public/index.js</a>, <a href="public_index.js.html#line988">line 988</a>
</li>
</ul>
</dd>
Expand Down Expand Up @@ -2627,7 +2627,7 @@ <h4 class="name" id="getSdkVersion">
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="public_index.js.html">public/index.js</a>, <a href="public_index.js.html#line1381">line 1381</a>
<a href="public_index.js.html">public/index.js</a>, <a href="public_index.js.html#line1369">line 1369</a>
</li>
</ul>
</dd>
Expand Down Expand Up @@ -2811,7 +2811,7 @@ <h5>Parameters:</h5>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="public_index.js.html">public/index.js</a>, <a href="public_index.js.html#line1339">line 1339</a>
<a href="public_index.js.html">public/index.js</a>, <a href="public_index.js.html#line1327">line 1327</a>
</li>
</ul>
</dd>
Expand Down Expand Up @@ -3217,7 +3217,7 @@ <h5>Parameters:</h5>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="public_index.js.html">public/index.js</a>, <a href="public_index.js.html#line1259">line 1259</a>
<a href="public_index.js.html">public/index.js</a>, <a href="public_index.js.html#line1247">line 1247</a>
</li>
</ul>
</dd>
Expand Down Expand Up @@ -3324,7 +3324,7 @@ <h4 class="name" id="getStreamSources">
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="public_index.js.html">public/index.js</a>, <a href="public_index.js.html#line1158">line 1158</a>
<a href="public_index.js.html">public/index.js</a>, <a href="public_index.js.html#line1146">line 1146</a>
</li>
</ul>
</dd>
Expand Down Expand Up @@ -3807,7 +3807,7 @@ <h5>Parameters:</h5>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="public_index.js.html">public/index.js</a>, <a href="public_index.js.html#line697">line 697</a>
<a href="public_index.js.html">public/index.js</a>, <a href="public_index.js.html#line685">line 685</a>
</li>
</ul>
</dd>
Expand Down Expand Up @@ -4304,7 +4304,7 @@ <h5>Parameters:</h5>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="public_index.js.html">public/index.js</a>, <a href="public_index.js.html#line828">line 828</a>
<a href="public_index.js.html">public/index.js</a>, <a href="public_index.js.html#line816">line 816</a>
</li>
</ul>
</dd>
Expand Down Expand Up @@ -4520,7 +4520,7 @@ <h5>Parameters:</h5>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="public_index.js.html">public/index.js</a>, <a href="public_index.js.html#line812">line 812</a>
<a href="public_index.js.html">public/index.js</a>, <a href="public_index.js.html#line800">line 800</a>
</li>
</ul>
</dd>
Expand Down Expand Up @@ -4710,7 +4710,7 @@ <h5>Parameters:</h5>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="public_index.js.html">public/index.js</a>, <a href="public_index.js.html#line935">line 935</a>
<a href="public_index.js.html">public/index.js</a>, <a href="public_index.js.html#line923">line 923</a>
</li>
</ul>
</dd>
Expand Down Expand Up @@ -5115,7 +5115,7 @@ <h6>Properties</h6>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="public_index.js.html">public/index.js</a>, <a href="public_index.js.html#line1046">line 1046</a>
<a href="public_index.js.html">public/index.js</a>, <a href="public_index.js.html#line1034">line 1034</a>
</li>
</ul>
</dd>
Expand Down Expand Up @@ -5212,18 +5212,6 @@ <h4 class="name" id="refreshConnection">

<div class="description">
<p>Method that refreshes peer connections to update with the current streaming.</p>
<blockquote class="info">
Note that Edge browser does not support renegotiation.
For MCU enabled peer connections with <code>options.mcuUseRenegoRestart</code> set to <code>false</code>
in the <a href="global.html#initOptions"><code>initOptions</code></a>, the restart method may differ, you
may learn more about how to workaround it in this article
<code>here</code>.
For restarts with peers connecting from Android, iOS or C++ SDKs, restarts might not work as written in this article
<code>here</code>.
Note that this functionality should be used when peer connection stream freezes during a connection.
For a better user experience for only MCU enabled peer connections, the method is throttled when invoked many
times in less than the milliseconds interval configured in <a href="global.html#initOptions"><code>initOptions</code></a>.
</blockquote>
</div>


Expand Down Expand Up @@ -5568,7 +5556,7 @@ <h6>Properties</h6>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="public_index.js.html">public/index.js</a>, <a href="public_index.js.html#line607">line 607</a>
<a href="public_index.js.html">public/index.js</a>, <a href="public_index.js.html#line595">line 595</a>
</li>
</ul>
</dd>
Expand Down Expand Up @@ -6055,7 +6043,7 @@ <h5>Parameters:</h5>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="public_index.js.html">public/index.js</a>, <a href="public_index.js.html#line1458">line 1458</a>
<a href="public_index.js.html">public/index.js</a>, <a href="public_index.js.html#line1446">line 1446</a>
</li>
</ul>
</dd>
Expand Down Expand Up @@ -6387,7 +6375,7 @@ <h5>Parameters:</h5>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="public_index.js.html">public/index.js</a>, <a href="public_index.js.html#line1437">line 1437</a>
<a href="public_index.js.html">public/index.js</a>, <a href="public_index.js.html#line1425">line 1425</a>
</li>
</ul>
</dd>
Expand Down Expand Up @@ -7303,7 +7291,7 @@ <h5>Parameters:</h5>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="public_index.js.html">public/index.js</a>, <a href="public_index.js.html#line1229">line 1229</a>
<a href="public_index.js.html">public/index.js</a>, <a href="public_index.js.html#line1217">line 1217</a>
</li>
</ul>
</dd>
Expand Down Expand Up @@ -7587,7 +7575,7 @@ <h5>Parameters:</h5>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="public_index.js.html">public/index.js</a>, <a href="public_index.js.html#line1286">line 1286</a>
<a href="public_index.js.html">public/index.js</a>, <a href="public_index.js.html#line1274">line 1274</a>
</li>
</ul>
</dd>
Expand Down Expand Up @@ -7776,7 +7764,7 @@ <h5>Parameters:</h5>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="public_index.js.html">public/index.js</a>, <a href="public_index.js.html#line1357">line 1357</a>
<a href="public_index.js.html">public/index.js</a>, <a href="public_index.js.html#line1345">line 1345</a>
</li>
</ul>
</dd>
Expand Down Expand Up @@ -7960,7 +7948,7 @@ <h5>Parameters:</h5>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="public_index.js.html">public/index.js</a>, <a href="public_index.js.html#line1325">line 1325</a>
<a href="public_index.js.html">public/index.js</a>, <a href="public_index.js.html#line1313">line 1313</a>
</li>
</ul>
</dd>
Expand Down Expand Up @@ -8357,7 +8345,7 @@ <h5>Parameters:</h5>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="public_index.js.html">public/index.js</a>, <a href="public_index.js.html#line621">line 621</a>
<a href="public_index.js.html">public/index.js</a>, <a href="public_index.js.html#line609">line 609</a>
</li>
</ul>
</dd>
Expand Down Expand Up @@ -8517,7 +8505,7 @@ <h5>Parameters:</h5>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="public_index.js.html">public/index.js</a>, <a href="public_index.js.html#line857">line 857</a>
<a href="public_index.js.html">public/index.js</a>, <a href="public_index.js.html#line845">line 845</a>
</li>
</ul>
</dd>
Expand Down Expand Up @@ -8770,7 +8758,7 @@ <h5>Parameters:</h5>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="public_index.js.html">public/index.js</a>, <a href="public_index.js.html#line1079">line 1079</a>
<a href="public_index.js.html">public/index.js</a>, <a href="public_index.js.html#line1067">line 1067</a>
</li>
</ul>
</dd>
Expand Down Expand Up @@ -8968,7 +8956,7 @@ <h5>Parameters:</h5>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="public_index.js.html">public/index.js</a>, <a href="public_index.js.html#line898">line 898</a>
<a href="public_index.js.html">public/index.js</a>, <a href="public_index.js.html#line886">line 886</a>
</li>
</ul>
</dd>
Expand Down Expand Up @@ -9191,7 +9179,7 @@ <h5>Parameters:</h5>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="public_index.js.html">public/index.js</a>, <a href="public_index.js.html#line1110">line 1110</a>
<a href="public_index.js.html">public/index.js</a>, <a href="public_index.js.html#line1098">line 1098</a>
</li>
</ul>
</dd>
Expand Down Expand Up @@ -9377,7 +9365,7 @@ <h5>Parameters:</h5>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="public_index.js.html">public/index.js</a>, <a href="public_index.js.html#line756">line 756</a>
<a href="public_index.js.html">public/index.js</a>, <a href="public_index.js.html#line744">line 744</a>
</li>
</ul>
</dd>
Expand Down Expand Up @@ -9598,7 +9586,7 @@ <h5>Parameters:</h5>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="public_index.js.html">public/index.js</a>, <a href="public_index.js.html#line780">line 780</a>
<a href="public_index.js.html">public/index.js</a>, <a href="public_index.js.html#line768">line 768</a>
</li>
</ul>
</dd>
Expand Down Expand Up @@ -9785,7 +9773,7 @@ <h5>Parameters:</h5>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="public_index.js.html">public/index.js</a>, <a href="public_index.js.html#line952">line 952</a>
<a href="public_index.js.html">public/index.js</a>, <a href="public_index.js.html#line940">line 940</a>
</li>
</ul>
</dd>
Expand Down

0 comments on commit 07a0b94

Please sign in to comment.