Update gh-pages to output generated at fb128bb

fishjam-dev · Jul 24, 2023 · d30e866 · d30e866
1 parent 0f273e7
commit d30e866
Show file tree

Hide file tree

Showing 271 changed files with 25,550 additions and 66 deletions.
diff --git a/-jellyfish-client/com.jellyfishdev.jellyfishclient/-jellyfish-client-listener/index.html b/-jellyfish-client/com.jellyfishdev.jellyfishclient/-jellyfish-client-listener/index.html
diff --git a/...ish-client/com.jellyfishdev.jellyfishclient/-jellyfish-client-listener/on-join-error.html b/...ish-client/com.jellyfishdev.jellyfishclient/-jellyfish-client-listener/on-join-error.html
@@ -59,7 +59,7 @@
   <div class="cover ">
     <h1 class="cover"><span>on</span><wbr></wbr><span>Join</span><wbr></wbr><span><span>Error</span></span></h1>
   </div>
-  <div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":JellyfishClient:dokkaHtml/release"><div class="symbol monospace"><span class="token keyword">abstract </span><span class="token keyword"></span><span class="token keyword">fun </span><a href="on-join-error.html"><span class="token function">onJoinError</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">metadata<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html">Any</a></span></span><span class="token punctuation">)</span></div><p class="paragraph">Called when peer was not accepted</p><h4 class="">Parameters</h4><div class="table"><div class="table-row" data-filterable-current=":JellyfishClient:dokkaHtml/release" data-filterable-set=":JellyfishClient:dokkaHtml/release"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span><span>metadata</span></span></u></div></span></div><div><div class="title"><ul><li><p class="paragraph">Pass thru for client application to communicate further actions to frontend</p></li></ul></div></div></div></div></div></div></div>
+  <div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":JellyfishClient:dokkaHtml/release"><div class="symbol monospace"><span class="token keyword">abstract </span><span class="token keyword"></span><span class="token keyword">fun </span><a href="on-join-error.html"><span class="token function">onJoinError</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">metadata<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html">Any</a></span></span><span class="token punctuation">)</span></div><p class="paragraph">Emitted when there was an error while connecting to the jellyfish.</p></div></div>
 </div>
       <div class="footer">
         <span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>Copyright 2023, Software Mansion.</span><span

diff --git a/...fish-client-listener/on-join-success.html → ...-jellyfish-client-listener/on-joined.html b/...fish-client-listener/on-join-success.html → ...-jellyfish-client-listener/on-joined.html
@@ -2,7 +2,7 @@
 <html>
 <head>
     <meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
-    <title>onJoinSuccess</title>
+    <title>onJoined</title>
     <link href="../../../images/logo-icon.svg" rel="icon" type="image/svg">
     <script>var pathToRoot = "../../../";</script>
     <script>const storage = localStorage.getItem("dokka-dark-mode")
@@ -54,12 +54,12 @@
         <div id="sideMenu"></div>
     </div>
     <div id="main">
-<div class="main-content" data-page-type="member" id="content" pageIds="JellyfishClient::com.jellyfishdev.jellyfishclient/JellyfishClientListener/onJoinSuccess/#kotlin.String#kotlin.collections.List[org.membraneframework.rtc.models.Peer]/PointingToDeclaration//-931945247">
-  <div class="breadcrumbs"><a href="../../../index.html">JellyfishClient</a><span class="delimiter">/</span><a href="../index.html">com.jellyfishdev.jellyfishclient</a><span class="delimiter">/</span><a href="index.html">JellyfishClientListener</a><span class="delimiter">/</span><span class="current">onJoinSuccess</span></div>
+<div class="main-content" data-page-type="member" id="content" pageIds="JellyfishClient::com.jellyfishdev.jellyfishclient/JellyfishClientListener/onJoined/#kotlin.String#kotlin.collections.List[org.membraneframework.rtc.models.Endpoint]/PointingToDeclaration//-931945247">
+  <div class="breadcrumbs"><a href="../../../index.html">JellyfishClient</a><span class="delimiter">/</span><a href="../index.html">com.jellyfishdev.jellyfishclient</a><span class="delimiter">/</span><a href="index.html">JellyfishClientListener</a><span class="delimiter">/</span><span class="current">onJoined</span></div>
   <div class="cover ">
-    <h1 class="cover"><span>on</span><wbr></wbr><span>Join</span><wbr></wbr><span><span>Success</span></span></h1>
+    <h1 class="cover"><span>on</span><wbr></wbr><span><span>Joined</span></span></h1>
   </div>
-  <div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":JellyfishClient:dokkaHtml/release"><div class="symbol monospace"><span class="token keyword">abstract </span><span class="token keyword"></span><span class="token keyword">fun </span><a href="on-join-success.html"><span class="token function">onJoinSuccess</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">peerID<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token punctuation">, </span></span><span class="parameter ">peersInRoom<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html">List</a><span class="token operator">&lt;</span><span class="token keyword"></span><span data-unresolved-link="org.membraneframework.rtc.models/Peer///PointingToDeclaration/">Peer</span><span class="token operator">&gt;</span></span></span><span class="token punctuation">)</span></div><p class="paragraph">Called when peer was accepted.</p></div></div>
+  <div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":JellyfishClient:dokkaHtml/release"><div class="symbol monospace"><span class="token keyword">abstract </span><span class="token keyword"></span><span class="token keyword">fun </span><a href="on-joined.html"><span class="token function">onJoined</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">peerID<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token punctuation">, </span></span><span class="parameter ">peersInRoom<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html">List</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="../index.html#-1222537761%2FClasslikes%2F-931945247">Peer</a><span class="token operator">&gt;</span></span></span><span class="token punctuation">)</span></div><p class="paragraph">Emitted when local user is connected to jellyfish.</p></div></div>
 </div>
       <div class="footer">
         <span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>Copyright 2023, Software Mansion.</span><span

diff --git a/...sh-client/com.jellyfishdev.jellyfishclient/-jellyfish-client-listener/on-peer-joined.html b/...sh-client/com.jellyfishdev.jellyfishclient/-jellyfish-client-listener/on-peer-joined.html
@@ -54,12 +54,12 @@
         <div id="sideMenu"></div>
     </div>
     <div id="main">
-<div class="main-content" data-page-type="member" id="content" pageIds="JellyfishClient::com.jellyfishdev.jellyfishclient/JellyfishClientListener/onPeerJoined/#org.membraneframework.rtc.models.Peer/PointingToDeclaration//-931945247">
+<div class="main-content" data-page-type="member" id="content" pageIds="JellyfishClient::com.jellyfishdev.jellyfishclient/JellyfishClientListener/onPeerJoined/#org.membraneframework.rtc.models.Endpoint/PointingToDeclaration//-931945247">
   <div class="breadcrumbs"><a href="../../../index.html">JellyfishClient</a><span class="delimiter">/</span><a href="../index.html">com.jellyfishdev.jellyfishclient</a><span class="delimiter">/</span><a href="index.html">JellyfishClientListener</a><span class="delimiter">/</span><span class="current">onPeerJoined</span></div>
   <div class="cover ">
     <h1 class="cover"><span>on</span><wbr></wbr><span>Peer</span><wbr></wbr><span><span>Joined</span></span></h1>
   </div>
-  <div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":JellyfishClient:dokkaHtml/release"><div class="symbol monospace"><span class="token keyword">abstract </span><span class="token keyword"></span><span class="token keyword">fun </span><a href="on-peer-joined.html"><span class="token function">onPeerJoined</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">peer<span class="token operator">: </span><span data-unresolved-link="org.membraneframework.rtc.models/Peer///PointingToDeclaration/">Peer</span></span></span><span class="token punctuation">)</span></div><p class="paragraph">Called each time new peer joins the room.</p></div></div>
+  <div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":JellyfishClient:dokkaHtml/release"><div class="symbol monospace"><span class="token keyword">abstract </span><span class="token keyword"></span><span class="token keyword">fun </span><a href="on-peer-joined.html"><span class="token function">onPeerJoined</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">peer<span class="token operator">: </span><a href="../index.html#-1222537761%2FClasslikes%2F-931945247">Peer</a></span></span><span class="token punctuation">)</span></div><p class="paragraph">Called each time new peer joins the room.</p></div></div>
 </div>
       <div class="footer">
         <span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>Copyright 2023, Software Mansion.</span><span

diff --git a/...fish-client/com.jellyfishdev.jellyfishclient/-jellyfish-client-listener/on-peer-left.html b/...fish-client/com.jellyfishdev.jellyfishclient/-jellyfish-client-listener/on-peer-left.html
@@ -54,12 +54,12 @@
         <div id="sideMenu"></div>
     </div>
     <div id="main">
-<div class="main-content" data-page-type="member" id="content" pageIds="JellyfishClient::com.jellyfishdev.jellyfishclient/JellyfishClientListener/onPeerLeft/#org.membraneframework.rtc.models.Peer/PointingToDeclaration//-931945247">
+<div class="main-content" data-page-type="member" id="content" pageIds="JellyfishClient::com.jellyfishdev.jellyfishclient/JellyfishClientListener/onPeerLeft/#org.membraneframework.rtc.models.Endpoint/PointingToDeclaration//-931945247">
   <div class="breadcrumbs"><a href="../../../index.html">JellyfishClient</a><span class="delimiter">/</span><a href="../index.html">com.jellyfishdev.jellyfishclient</a><span class="delimiter">/</span><a href="index.html">JellyfishClientListener</a><span class="delimiter">/</span><span class="current">onPeerLeft</span></div>
   <div class="cover ">
     <h1 class="cover"><span>on</span><wbr></wbr><span>Peer</span><wbr></wbr><span><span>Left</span></span></h1>
   </div>
-  <div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":JellyfishClient:dokkaHtml/release"><div class="symbol monospace"><span class="token keyword">abstract </span><span class="token keyword"></span><span class="token keyword">fun </span><a href="on-peer-left.html"><span class="token function">onPeerLeft</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">peer<span class="token operator">: </span><span data-unresolved-link="org.membraneframework.rtc.models/Peer///PointingToDeclaration/">Peer</span></span></span><span class="token punctuation">)</span></div><p class="paragraph">Called each time peer leaves the room.</p></div></div>
+  <div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":JellyfishClient:dokkaHtml/release"><div class="symbol monospace"><span class="token keyword">abstract </span><span class="token keyword"></span><span class="token keyword">fun </span><a href="on-peer-left.html"><span class="token function">onPeerLeft</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">peer<span class="token operator">: </span><a href="../index.html#-1222537761%2FClasslikes%2F-931945247">Peer</a></span></span><span class="token punctuation">)</span></div><p class="paragraph">Called each time peer leaves the room.</p></div></div>
 </div>
       <div class="footer">
         <span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>Copyright 2023, Software Mansion.</span><span

diff --git a/...h-client/com.jellyfishdev.jellyfishclient/-jellyfish-client-listener/on-peer-updated.html b/...h-client/com.jellyfishdev.jellyfishclient/-jellyfish-client-listener/on-peer-updated.html
@@ -54,12 +54,12 @@
         <div id="sideMenu"></div>
     </div>
     <div id="main">
-<div class="main-content" data-page-type="member" id="content" pageIds="JellyfishClient::com.jellyfishdev.jellyfishclient/JellyfishClientListener/onPeerUpdated/#org.membraneframework.rtc.models.Peer/PointingToDeclaration//-931945247">
+<div class="main-content" data-page-type="member" id="content" pageIds="JellyfishClient::com.jellyfishdev.jellyfishclient/JellyfishClientListener/onPeerUpdated/#org.membraneframework.rtc.models.Endpoint/PointingToDeclaration//-931945247">
   <div class="breadcrumbs"><a href="../../../index.html">JellyfishClient</a><span class="delimiter">/</span><a href="../index.html">com.jellyfishdev.jellyfishclient</a><span class="delimiter">/</span><a href="index.html">JellyfishClientListener</a><span class="delimiter">/</span><span class="current">onPeerUpdated</span></div>
   <div class="cover ">
     <h1 class="cover"><span>on</span><wbr></wbr><span>Peer</span><wbr></wbr><span><span>Updated</span></span></h1>
   </div>
-  <div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":JellyfishClient:dokkaHtml/release"><div class="symbol monospace"><span class="token keyword">open </span><span class="token keyword"></span><span class="token keyword">fun </span><a href="on-peer-updated.html"><span class="token function">onPeerUpdated</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">peer<span class="token operator">: </span><span data-unresolved-link="org.membraneframework.rtc.models/Peer///PointingToDeclaration/">Peer</span></span></span><span class="token punctuation">)</span></div><p class="paragraph">Called each time peer has its metadata updated.</p></div></div>
+  <div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":JellyfishClient:dokkaHtml/release"><div class="symbol monospace"><span class="token keyword">abstract </span><span class="token keyword"></span><span class="token keyword">fun </span><a href="on-peer-updated.html"><span class="token function">onPeerUpdated</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">peer<span class="token operator">: </span><a href="../index.html#-1222537761%2FClasslikes%2F-931945247">Peer</a></span></span><span class="token punctuation">)</span></div><p class="paragraph">Called each time peer has its metadata updated.</p></div></div>
 </div>
       <div class="footer">
         <span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>Copyright 2023, Software Mansion.</span><span

diff --git a/-jellyfish-client/com.jellyfishdev.jellyfishclient/-jellyfish-client/create-audio-track.html b/-jellyfish-client/com.jellyfishdev.jellyfishclient/-jellyfish-client/create-audio-track.html
@@ -59,8 +59,7 @@
   <div class="cover ">
     <h1 class="cover"><span>create</span><wbr></wbr><span>Audio</span><wbr></wbr><span><span>Track</span></span></h1>
   </div>
-  <div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":JellyfishClient:dokkaHtml/release"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">fun </span><a href="create-audio-track.html"><span class="token function">createAudioTrack</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">metadata<span class="token operator">: </span><span data-unresolved-link="org.membraneframework.rtc.utils/Metadata///PointingToDeclaration/">Metadata</span></span></span><span class="token punctuation">)</span><span class="token operator">: </span><span data-unresolved-link="org.membraneframework.rtc.media/LocalAudioTrack///PointingToDeclaration/">LocalAudioTrack</span></div><p class="paragraph">Creates an audio track utilizing device's microphone.</p><p>
-The client assumes that the user has already granted microphone recording permissions.<span class="kdoc-tag"><h4 class="">Return</h4><p class="paragraph">an instance of the audio track</p></span><h4 class="">Parameters</h4><div class="table"><div class="table-row" data-filterable-current=":JellyfishClient:dokkaHtml/release" data-filterable-set=":JellyfishClient:dokkaHtml/release"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span><span>metadata</span></span></u></div></span></div><div><div class="title"><p class="paragraph">the metadata that will be sent to the <strong>Membrane RTC Engine</strong> for media negotiation</p></div></div></div></div></div></div></div>
+  <div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":JellyfishClient:dokkaHtml/release"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">fun </span><a href="create-audio-track.html"><span class="token function">createAudioTrack</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">metadata<span class="token operator">: </span><span data-unresolved-link="org.membraneframework.rtc.utils/Metadata///PointingToDeclaration/">Metadata</span></span></span><span class="token punctuation">)</span><span class="token operator">: </span><span data-unresolved-link="org.membraneframework.rtc.media/LocalAudioTrack///PointingToDeclaration/">LocalAudioTrack</span></div><p class="paragraph">Creates an audio track utilizing device's microphone.</p><p class="paragraph">The client assumes that the user has already granted microphone recording permissions.</p><span class="kdoc-tag"><h4 class="">Return</h4><p class="paragraph">an instance of the audio track</p></span><h4 class="">Parameters</h4><div class="table"><div class="table-row" data-filterable-current=":JellyfishClient:dokkaHtml/release" data-filterable-set=":JellyfishClient:dokkaHtml/release"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span><span>metadata</span></span></u></div></span></div><div><div class="title"><p class="paragraph">the metadata that will be sent to the <strong>Membrane RTC Engine</strong> for media negotiation</p></div></div></div></div></div></div></div>
 </div>
       <div class="footer">
         <span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>Copyright 2023, Software Mansion.</span><span