deploy: 9826982

adrenak · Jan 12, 2025 · a2a0a1f · a2a0a1f
1 parent 26f12a4
commit a2a0a1f
Show file tree

Hide file tree

Showing 12 changed files with 378 additions and 525 deletions.
diff --git a/api/Adrenak.UniVoice.ClientSession-1.html b/api/Adrenak.UniVoice.ClientSession-1.html
@@ -83,7 +83,10 @@
 
   <h1 id="Adrenak_UniVoice_ClientSession_1" data-uid="Adrenak.UniVoice.ClientSession`1" class="text-break">Class ClientSession&lt;T&gt;
   </h1>
-  <div class="markdown level0 summary"></div>
+  <div class="markdown level0 summary"><p>Handles a client session. 
+Requires an implementation of <a class="xref" href="Adrenak.UniVoice.IAudioClient-1.html">IAudioClient&lt;T&gt;</a>, <a class="xref" href="Adrenak.UniVoice.IAudioInput.html">IAudioInput</a> and <a class="xref" href="Adrenak.UniVoice.IAudioOutputFactory.html">IAudioOutputFactory</a> each.
+Allows adding input and output filters and handles their execution.</p>
+</div>
   <div class="markdown level0 conceptual"></div>
   <div class="inheritance">
     <h5>Inheritance</h5>
@@ -181,7 +184,8 @@ <h5 class="propertyValue">Property Value</h5>
 
   <a id="Adrenak_UniVoice_ClientSession_1_Input_" data-uid="Adrenak.UniVoice.ClientSession`1.Input*"></a>
   <h4 id="Adrenak_UniVoice_ClientSession_1_Input" data-uid="Adrenak.UniVoice.ClientSession`1.Input">Input</h4>
-  <div class="markdown level1 summary"></div>
+  <div class="markdown level1 summary"><p>The <a class="xref" href="Adrenak.UniVoice.IAudioInput.html">IAudioInput</a> that&apos;s used for sourcing outgoing audio</p>
+</div>
   <div class="markdown level1 conceptual"></div>
   <h5 class="decalaration">Declaration</h5>
   <div class="codewrapper">
@@ -206,7 +210,9 @@ <h5 class="propertyValue">Property Value</h5>
 
   <a id="Adrenak_UniVoice_ClientSession_1_InputFilters_" data-uid="Adrenak.UniVoice.ClientSession`1.InputFilters*"></a>
   <h4 id="Adrenak_UniVoice_ClientSession_1_InputFilters" data-uid="Adrenak.UniVoice.ClientSession`1.InputFilters">InputFilters</h4>
-  <div class="markdown level1 summary"></div>
+  <div class="markdown level1 summary"><p>The input <a class="xref" href="Adrenak.UniVoice.IAudioFilter.html">IAudioFilter</a> that will be applied to the outgoing audio for all the peers.
+Note that filters are executed in the order they are present in this list</p>
+</div>
   <div class="markdown level1 conceptual"></div>
   <h5 class="decalaration">Declaration</h5>
   <div class="codewrapper">
@@ -231,7 +237,8 @@ <h5 class="propertyValue">Property Value</h5>
 
   <a id="Adrenak_UniVoice_ClientSession_1_OutputFactory_" data-uid="Adrenak.UniVoice.ClientSession`1.OutputFactory*"></a>
   <h4 id="Adrenak_UniVoice_ClientSession_1_OutputFactory" data-uid="Adrenak.UniVoice.ClientSession`1.OutputFactory">OutputFactory</h4>
-  <div class="markdown level1 summary"></div>
+  <div class="markdown level1 summary"><p>The <a class="xref" href="Adrenak.UniVoice.IAudioOutputFactory.html">IAudioOutputFactory</a> that creates the <a class="xref" href="Adrenak.UniVoice.IAudioOutput.html">IAudioOutput</a> of peers</p>
+</div>
   <div class="markdown level1 conceptual"></div>
   <h5 class="decalaration">Declaration</h5>
   <div class="codewrapper">
@@ -256,7 +263,9 @@ <h5 class="propertyValue">Property Value</h5>
 
   <a id="Adrenak_UniVoice_ClientSession_1_OutputFilters_" data-uid="Adrenak.UniVoice.ClientSession`1.OutputFilters*"></a>
   <h4 id="Adrenak_UniVoice_ClientSession_1_OutputFilters" data-uid="Adrenak.UniVoice.ClientSession`1.OutputFilters">OutputFilters</h4>
-  <div class="markdown level1 summary"></div>
+  <div class="markdown level1 summary"><p>The output <a class="xref" href="Adrenak.UniVoice.IAudioFilter.html">IAudioFilter</a> that will be applied to the incoming audio for all the peers.
+Note that filters are executed in the order they are present in this list.</p>
+</div>
   <div class="markdown level1 conceptual"></div>
   <h5 class="decalaration">Declaration</h5>
   <div class="codewrapper">
@@ -281,7 +290,8 @@ <h5 class="propertyValue">Property Value</h5>
 
   <a id="Adrenak_UniVoice_ClientSession_1_PeerOutputs_" data-uid="Adrenak.UniVoice.ClientSession`1.PeerOutputs*"></a>
   <h4 id="Adrenak_UniVoice_ClientSession_1_PeerOutputs" data-uid="Adrenak.UniVoice.ClientSession`1.PeerOutputs">PeerOutputs</h4>
-  <div class="markdown level1 summary"></div>
+  <div class="markdown level1 summary"><p>The <a class="xref" href="Adrenak.UniVoice.IAudioOutput.html">IAudioOutput</a> instances of each peer in the session</p>
+</div>
   <div class="markdown level1 conceptual"></div>
   <h5 class="decalaration">Declaration</h5>
   <div class="codewrapper">

diff --git a/api/Adrenak.UniVoice.Extensions.html b/api/Adrenak.UniVoice.Extensions.html
diff --git a/api/Adrenak.UniVoice.GaussianAudioBlur.html → ...k.UniVoice.Filters.GaussianAudioBlur.html b/api/Adrenak.UniVoice.GaussianAudioBlur.html → ...k.UniVoice.Filters.GaussianAudioBlur.html
@@ -78,10 +78,10 @@
         </div>
         <div class="article row grid-right">
           <div class="col-md-10">
-            <article class="content wrap" id="_content" data-uid="Adrenak.UniVoice.GaussianAudioBlur">
+            <article class="content wrap" id="_content" data-uid="Adrenak.UniVoice.Filters.GaussianAudioBlur">
 
 
-  <h1 id="Adrenak_UniVoice_GaussianAudioBlur" data-uid="Adrenak.UniVoice.GaussianAudioBlur" class="text-break">Class GaussianAudioBlur
+  <h1 id="Adrenak_UniVoice_Filters_GaussianAudioBlur" data-uid="Adrenak.UniVoice.Filters.GaussianAudioBlur" class="text-break">Class GaussianAudioBlur
   </h1>
   <div class="markdown level0 summary"><p>A filter that applies Gaussian blur over audio data to smoothen it.
 This is somewhat effective in removing noise from the audio.</p>
@@ -96,18 +96,18 @@ <h5>Inheritance</h5>
     <h5>Implements</h5>
     <div><a class="xref" href="Adrenak.UniVoice.IAudioFilter.html">IAudioFilter</a></div>
   </div>
-  <h6><strong>Namespace</strong>: <a class="xref" href="Adrenak.UniVoice.html">Adrenak.UniVoice</a></h6>
+  <h6><strong>Namespace</strong>: <a class="xref" href="Adrenak.UniVoice.Filters.html">Adrenak.UniVoice.Filters</a></h6>
   <h6><strong>Assembly</strong>: cs.temp.dll.dll</h6>
-  <h5 id="Adrenak_UniVoice_GaussianAudioBlur_syntax">Syntax</h5>
+  <h5 id="Adrenak_UniVoice_Filters_GaussianAudioBlur_syntax">Syntax</h5>
   <div class="codewrapper">
     <pre><code class="lang-csharp hljs">public class GaussianAudioBlur : IAudioFilter</code></pre>
   </div>
   <h3 id="constructors">Constructors
   </h3>
 
 
-  <a id="Adrenak_UniVoice_GaussianAudioBlur__ctor_" data-uid="Adrenak.UniVoice.GaussianAudioBlur.#ctor*"></a>
-  <h4 id="Adrenak_UniVoice_GaussianAudioBlur__ctor_System_Single_System_Int32_" data-uid="Adrenak.UniVoice.GaussianAudioBlur.#ctor(System.Single,System.Int32)">GaussianAudioBlur(Single, Int32)</h4>
+  <a id="Adrenak_UniVoice_Filters_GaussianAudioBlur__ctor_" data-uid="Adrenak.UniVoice.Filters.GaussianAudioBlur.#ctor*"></a>
+  <h4 id="Adrenak_UniVoice_Filters_GaussianAudioBlur__ctor_System_Single_System_Int32_" data-uid="Adrenak.UniVoice.Filters.GaussianAudioBlur.#ctor(System.Single,System.Int32)">GaussianAudioBlur(Single, Int32)</h4>
   <div class="markdown level1 summary"></div>
   <div class="markdown level1 conceptual"></div>
   <h5 class="decalaration">Declaration</h5>
@@ -140,8 +140,8 @@ <h3 id="methods">Methods
   </h3>
 
 
-  <a id="Adrenak_UniVoice_GaussianAudioBlur_Run_" data-uid="Adrenak.UniVoice.GaussianAudioBlur.Run*"></a>
-  <h4 id="Adrenak_UniVoice_GaussianAudioBlur_Run_Adrenak_UniVoice_AudioFrame_" data-uid="Adrenak.UniVoice.GaussianAudioBlur.Run(Adrenak.UniVoice.AudioFrame)">Run(AudioFrame)</h4>
+  <a id="Adrenak_UniVoice_Filters_GaussianAudioBlur_Run_" data-uid="Adrenak.UniVoice.Filters.GaussianAudioBlur.Run*"></a>
+  <h4 id="Adrenak_UniVoice_Filters_GaussianAudioBlur_Run_Adrenak_UniVoice_AudioFrame_" data-uid="Adrenak.UniVoice.Filters.GaussianAudioBlur.Run(Adrenak.UniVoice.AudioFrame)">Run(AudioFrame)</h4>
   <div class="markdown level1 summary"></div>
   <div class="markdown level1 conceptual"></div>
   <h5 class="decalaration">Declaration</h5>