readme/doc

Author: farfromrefug

docs/assets/search.js

@@ -22,7 +22,7 @@ <h4>Hierarchy</h4>
 <ul class="tsd-hierarchy">
 <li><span class="target">AudioFocusManager</span></li></ul></li></ul></section><aside class="tsd-sources">
 <ul>
-<li>Defined in packages/audio/index.d.ts:335</li></ul></aside>
+<li>Defined in packages/audio/index.d.ts:358</li></ul></aside>
 <section class="tsd-panel-group tsd-index-group">
 <section class="tsd-panel tsd-index-panel">
 <details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
@@ -51,7 +51,7 @@ <h5><code class="tsd-tag ts-flagOptional">Optional</code> options: <a href="../i
 <h4 class="tsd-returns-title">Returns <a href="AudioFocusManager.html" class="tsd-signature-type" data-tsd-kind="Class">AudioFocusManager</a></h4><aside class="tsd-sources">
 <p>Overrides Observable.constructor</p>
 <ul>
-<li>Defined in packages/audio/index.d.ts:336</li></ul></aside></li></ul></section></section>
+<li>Defined in packages/audio/index.d.ts:359</li></ul></aside></li></ul></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="on" class="tsd-anchor"></a>
@@ -82,7 +82,7 @@ <h5><code class="tsd-tag ts-flagOptional">Optional</code> thisArg: <span class="
 <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4><aside class="tsd-sources">
 <p>Overrides Observable.on</p>
 <ul>
-<li>Defined in packages/audio/index.d.ts:337</li></ul></aside></li></ul></section></section></div>
+<li>Defined in packages/audio/index.d.ts:360</li></ul></aside></li></ul></section></section></div>
 <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
 <div class="tsd-navigation settings">
 <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">

docs/classes/AudioFocusManager.html

@@ -16,7 +16,7 @@
 <li><a href="AudioFocusDurationHint.html">AudioFocusDurationHint</a></li></ul>
 <h1>Enumeration AudioFocusDurationHint</h1></div><aside class="tsd-sources">
 <ul>
-<li>Defined in packages/audio/index.d.ts:292</li></ul></aside>
+<li>Defined in packages/audio/index.d.ts:315</li></ul></aside>
 <section class="tsd-panel-group tsd-index-group">
 <section class="tsd-panel tsd-index-panel">
 <details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
@@ -41,7 +41,7 @@ <h3 class="tsd-anchor-link"><span>AUDIOFOCUS_<wbr/>GAIN</span><a href="#AUDIOFOC
 expect another audio stream to resume.</p>
 </div><aside class="tsd-sources">
 <ul>
-<li>Defined in packages/audio/index.d.ts:300</li></ul></aside></section>
+<li>Defined in packages/audio/index.d.ts:323</li></ul></aside></section>
 <section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="AUDIOFOCUS_GAIN_TRANSIENT" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><span>AUDIOFOCUS_<wbr/>GAIN_<wbr/>TRANSIENT</span><a href="#AUDIOFOCUS_GAIN_TRANSIENT" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
 <div class="tsd-signature">AUDIOFOCUS_<wbr/>GAIN_<wbr/>TRANSIENT<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
@@ -51,7 +51,7 @@ <h3 class="tsd-anchor-link"><span>AUDIOFOCUS_<wbr/>GAIN_<wbr/>TRANSIENT</span><a
 longer requires audio focus.</p>
 </div><aside class="tsd-sources">
 <ul>
-<li>Defined in packages/audio/index.d.ts:307</li></ul></aside></section>
+<li>Defined in packages/audio/index.d.ts:330</li></ul></aside></section>
 <section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="AUDIOFOCUS_GAIN_TRANSIENT_EXCLUSIVE" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><span>AUDIOFOCUS_<wbr/>GAIN_<wbr/>TRANSIENT_<wbr/>EXCLUSIVE</span><a href="#AUDIOFOCUS_GAIN_TRANSIENT_EXCLUSIVE" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
 <div class="tsd-signature">AUDIOFOCUS_<wbr/>GAIN_<wbr/>TRANSIENT_<wbr/>EXCLUSIVE<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
@@ -62,7 +62,7 @@ <h3 class="tsd-anchor-link"><span>AUDIOFOCUS_<wbr/>GAIN_<wbr/>TRANSIENT_<wbr/>EX
 played by the system during that time.</p>
 </div><aside class="tsd-sources">
 <ul>
-<li>Defined in packages/audio/index.d.ts:323</li></ul></aside></section>
+<li>Defined in packages/audio/index.d.ts:346</li></ul></aside></section>
 <section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="AUDIOFOCUS_GAIN_TRANSIENT_MAY_DUCK" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><span>AUDIOFOCUS_<wbr/>GAIN_<wbr/>TRANSIENT_<wbr/>MAY_<wbr/>DUCK</span><a href="#AUDIOFOCUS_GAIN_TRANSIENT_MAY_DUCK" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
 <div class="tsd-signature">AUDIOFOCUS_<wbr/>GAIN_<wbr/>TRANSIENT_<wbr/>MAY_<wbr/>DUCK<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
@@ -73,7 +73,7 @@ <h3 class="tsd-anchor-link"><span>AUDIOFOCUS_<wbr/>GAIN_<wbr/>TRANSIENT_<wbr/>MA
 “ducked”.</p>
 </div><aside class="tsd-sources">
 <ul>
-<li>Defined in packages/audio/index.d.ts:315</li></ul></aside></section></section></div>
+<li>Defined in packages/audio/index.d.ts:338</li></ul></aside></section></section></div>
 <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
 <div class="tsd-navigation settings">
 <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">

docs/classes/TNSPlayer.html

@@ -22,7 +22,7 @@ <h4>Hierarchy</h4>
 <ul class="tsd-hierarchy">
 <li><span class="target">AudioFocusChangeEventData</span></li></ul></li></ul></section><aside class="tsd-sources">
 <ul>
-<li>Defined in packages/audio/index.d.ts:331</li></ul></aside>
+<li>Defined in packages/audio/index.d.ts:354</li></ul></aside>
 <section class="tsd-panel-group tsd-index-group">
 <section class="tsd-panel tsd-index-panel">
 <details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
@@ -38,7 +38,7 @@ <h2>Properties</h2>
 <h3 class="tsd-anchor-link"><span>focus<wbr/>Change</span><a href="#focusChange" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none" id="icon-anchor-a"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5" id="icon-anchor-b"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5" id="icon-anchor-c"></path></svg></a></h3>
 <div class="tsd-signature">focus<wbr/>Change<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources">
 <ul>
-<li>Defined in packages/audio/index.d.ts:332</li></ul></aside></section></section></div>
+<li>Defined in packages/audio/index.d.ts:355</li></ul></aside></section></section></div>
 <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
 <div class="tsd-navigation settings">
 <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">

docs/classes/TNSRecorder.html

@@ -20,7 +20,7 @@ <h4>Hierarchy</h4>
 <ul class="tsd-hierarchy">
 <li><span class="target">AudioFocusManagerOptions</span></li></ul></section><aside class="tsd-sources">
 <ul>
-<li>Defined in packages/audio/index.d.ts:326</li></ul></aside>
+<li>Defined in packages/audio/index.d.ts:349</li></ul></aside>
 <section class="tsd-panel-group tsd-index-group">
 <section class="tsd-panel tsd-index-panel">
 <details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
@@ -38,17 +38,17 @@ <h2>Properties</h2>
 <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>content<wbr/>Type</span><a href="#contentType" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none" id="icon-anchor-a"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5" id="icon-anchor-b"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5" id="icon-anchor-c"></path></svg></a></h3>
 <div class="tsd-signature">content<wbr/>Type<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources">
 <ul>
-<li>Defined in packages/audio/index.d.ts:329</li></ul></aside></section>
+<li>Defined in packages/audio/index.d.ts:352</li></ul></aside></section>
 <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="durationHint" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>duration<wbr/>Hint</span><a href="#durationHint" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
 <div class="tsd-signature">duration<wbr/>Hint<span class="tsd-signature-symbol">?:</span> <a href="../enums/AudioFocusDurationHint.html" class="tsd-signature-type" data-tsd-kind="Enumeration">AudioFocusDurationHint</a></div><aside class="tsd-sources">
 <ul>
-<li>Defined in packages/audio/index.d.ts:327</li></ul></aside></section>
+<li>Defined in packages/audio/index.d.ts:350</li></ul></aside></section>
 <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="usage" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>usage</span><a href="#usage" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
 <div class="tsd-signature">usage<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources">
 <ul>
-<li>Defined in packages/audio/index.d.ts:328</li></ul></aside></section></section></div>
+<li>Defined in packages/audio/index.d.ts:351</li></ul></aside></section></section></div>
 <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
 <div class="tsd-navigation settings">
 <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">