docs: Rebuilt docs

Azusfin · Oct 31, 2021 · cbed59e · cbed59e
1 parent 4314922
commit cbed59e
Show file tree

Hide file tree

Showing 76 changed files with 354 additions and 225 deletions.
diff --git a/docs/assets/highlight.css b/docs/assets/highlight.css
@@ -15,6 +15,8 @@
     --dark-hl-6: #4FC1FF;
     --light-hl-7: #795E26;
     --dark-hl-7: #DCDCAA;
+    --light-hl-8: #098658;
+    --dark-hl-8: #B5CEA8;
     --light-code-background: #FFFFFF;
     --dark-code-background: #1E1E1E;
 }
@@ -28,6 +30,7 @@
     --hl-5: var(--light-hl-5);
     --hl-6: var(--light-hl-6);
     --hl-7: var(--light-hl-7);
+    --hl-8: var(--light-hl-8);
     --code-background: var(--light-code-background);
 } }
 
@@ -40,6 +43,7 @@
     --hl-5: var(--dark-hl-5);
     --hl-6: var(--dark-hl-6);
     --hl-7: var(--dark-hl-7);
+    --hl-8: var(--dark-hl-8);
     --code-background: var(--dark-code-background);
 } }
 
@@ -52,6 +56,7 @@ body.light {
     --hl-5: var(--light-hl-5);
     --hl-6: var(--light-hl-6);
     --hl-7: var(--light-hl-7);
+    --hl-8: var(--light-hl-8);
     --code-background: var(--light-code-background);
 }
 
@@ -64,6 +69,7 @@ body.dark {
     --hl-5: var(--dark-hl-5);
     --hl-6: var(--dark-hl-6);
     --hl-7: var(--dark-hl-7);
+    --hl-8: var(--dark-hl-8);
     --code-background: var(--dark-code-background);
 }
 
@@ -75,4 +81,5 @@ body.dark {
 .hl-5 { color: var(--hl-5); }
 .hl-6 { color: var(--hl-6); }
 .hl-7 { color: var(--hl-7); }
+.hl-8 { color: var(--hl-8); }
 pre, code { background: var(--code-background); }
diff --git a/docs/assets/search.js b/docs/assets/search.js
diff --git a/docs/classes/CoffeeLava.html b/docs/classes/CoffeeLava.html
diff --git a/docs/classes/CoffeeNode.html b/docs/classes/CoffeeNode.html
diff --git a/docs/classes/CoffeePlayer.html b/docs/classes/CoffeePlayer.html
diff --git a/docs/classes/CoffeeQueue.html b/docs/classes/CoffeeQueue.html
diff --git a/docs/classes/CoffeeTrack.html b/docs/classes/CoffeeTrack.html
diff --git a/docs/classes/UnresolvedTrack.html b/docs/classes/UnresolvedTrack.html
diff --git a/docs/classes/Utils.ChannelMixUtils.html b/docs/classes/Utils.ChannelMixUtils.html
diff --git a/docs/classes/Utils.DistortionUtils.html b/docs/classes/Utils.DistortionUtils.html
diff --git a/docs/classes/Utils.EqualizerUtils.html b/docs/classes/Utils.EqualizerUtils.html
@@ -0,0 +1,9 @@
+<!DOCTYPE html><html class="default no-js"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>EqualizerUtils | lavacoffee</title><meta name="description" content="Documentation for lavacoffee"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">lavacoffee</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">lavacoffee</a></li><li><a href="../modules/Utils.html">Utils</a></li><li><a href="Utils.EqualizerUtils.html">EqualizerUtils</a></li></ul><h1>Class EqualizerUtils</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><div class="lead">
+<p>Equalizer filter builder utility</p>
+</div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">EqualizerUtils</span></li></ul></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Constructors</h3><ul class="tsd-index-list"><li class="tsd-kind-constructor tsd-parent-kind-class"><a href="Utils.EqualizerUtils.html#constructor" class="tsd-kind-icon">constructor</a></li></ul></section><section class="tsd-index-section "><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-class"><a href="Utils.EqualizerUtils.html#enabled" class="tsd-kind-icon">enabled</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="Utils.EqualizerUtils.html#equalizers" class="tsd-kind-icon">equalizers</a></li></ul></section><section class="tsd-index-section "><h3>Methods</h3><ul class="tsd-index-list"><li class="tsd-kind-method tsd-parent-kind-class"><a href="Utils.EqualizerUtils.html#build" class="tsd-kind-icon">build</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="Utils.EqualizerUtils.html#clear" class="tsd-kind-icon">clear</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="Utils.EqualizerUtils.html#setBand" class="tsd-kind-icon">set<wbr/>Band</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Constructors</h2><section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class"><a id="constructor" class="tsd-anchor"></a><h3>constructor</h3><ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">new <wbr/>Equalizer<wbr/>Utils<span class="tsd-signature-symbol">(</span>equalizers<span class="tsd-signature-symbol">?: </span><a href="../interfaces/Utils.Equalizer.html" class="tsd-signature-type" data-tsd-kind="Interface">Equalizer</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Utils.EqualizerUtils.html" class="tsd-signature-type" data-tsd-kind="Class">EqualizerUtils</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/XzFirzal/lavacoffee/blob/4314922/src/utils/filterUtils.ts#L128">src/utils/filterUtils.ts:128</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> equalizers: <a href="../interfaces/Utils.Equalizer.html" class="tsd-signature-type" data-tsd-kind="Interface">Equalizer</a><span class="tsd-signature-symbol">[]</span></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="Utils.EqualizerUtils.html" class="tsd-signature-type" data-tsd-kind="Class">EqualizerUtils</a></h4></li></ul></section></section><section class="tsd-panel-group tsd-member-group "><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="enabled" class="tsd-anchor"></a><h3>enabled</h3><div class="tsd-signature tsd-kind-icon">enabled<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/XzFirzal/lavacoffee/blob/4314922/src/utils/filterUtils.ts#L125">src/utils/filterUtils.ts:125</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="equalizers" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> equalizers</h3><div class="tsd-signature tsd-kind-icon">equalizers<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Map</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">, </span><a href="../interfaces/Utils.Equalizer.html" class="tsd-signature-type" data-tsd-kind="Interface">Equalizer</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> = ...</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/XzFirzal/lavacoffee/blob/4314922/src/utils/filterUtils.ts#L126">src/utils/filterUtils.ts:126</a></li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group "><h2>Methods</h2><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="build" class="tsd-anchor"></a><h3>build</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">build<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/Utils.Equalizer.html" class="tsd-signature-type" data-tsd-kind="Interface">Equalizer</a><span class="tsd-signature-symbol">[]</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/XzFirzal/lavacoffee/blob/4314922/src/utils/filterUtils.ts#L167">src/utils/filterUtils.ts:167</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>Build the equalizers</p>
+</div></div><h4 class="tsd-returns-title">Returns <a href="../interfaces/Utils.Equalizer.html" class="tsd-signature-type" data-tsd-kind="Interface">Equalizer</a><span class="tsd-signature-symbol">[]</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="clear" class="tsd-anchor"></a><h3>clear</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">clear<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Utils.EqualizerUtils.html" class="tsd-signature-type" data-tsd-kind="Class">EqualizerUtils</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/XzFirzal/lavacoffee/blob/4314922/src/utils/filterUtils.ts#L160">src/utils/filterUtils.ts:160</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>Clear the equalizers filter</p>
+</div></div><h4 class="tsd-returns-title">Returns <a href="Utils.EqualizerUtils.html" class="tsd-signature-type" data-tsd-kind="Class">EqualizerUtils</a></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="setBand" class="tsd-anchor"></a><h3>set<wbr/>Band</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">set<wbr/>Band<span class="tsd-signature-symbol">(</span>band<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, gain<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Utils.EqualizerUtils.html" class="tsd-signature-type" data-tsd-kind="Class">EqualizerUtils</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/XzFirzal/lavacoffee/blob/4314922/src/utils/filterUtils.ts#L149">src/utils/filterUtils.ts:149</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>Set a band equalizer, band must be between 0 to 13</p>
+</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>band: <span class="tsd-signature-type">number</span></h5></li><li><h5>gain: <span class="tsd-signature-type">number</span></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="Utils.EqualizerUtils.html" class="tsd-signature-type" data-tsd-kind="Class">EqualizerUtils</a></h4></li></ul></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Exports</a></li><li class="current tsd-kind-namespace"><a href="../modules/Utils.html">Utils</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-class tsd-parent-kind-namespace"><a href="Utils.EqualizerUtils.html" class="tsd-kind-icon">Equalizer<wbr/>Utils</a><ul><li class="tsd-kind-constructor tsd-parent-kind-class"><a href="Utils.EqualizerUtils.html#constructor" class="tsd-kind-icon">constructor</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="Utils.EqualizerUtils.html#enabled" class="tsd-kind-icon">enabled</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="Utils.EqualizerUtils.html#equalizers" class="tsd-kind-icon">equalizers</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="Utils.EqualizerUtils.html#build" class="tsd-kind-icon">build</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="Utils.EqualizerUtils.html#clear" class="tsd-kind-icon">clear</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="Utils.EqualizerUtils.html#setBand" class="tsd-kind-icon">set<wbr/>Band</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li><li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li><li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="../assets/main.js"></script></body></html>