@webaudiomodules/api
Version:
WebAudioModules Plugin API
15 lines • 19 kB
HTML
<html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>WamGroup | WebAudioModules API</title><meta name="description" content="Documentation for WebAudioModules API"/><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">WebAudioModules API</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><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</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">WebAudioModules API</a></li><li><a href="WamGroup.html">WamGroup</a></li></ul><h1>Interface WamGroup </h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">WamGroup</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>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-interface"><a href="WamGroup.html#groupId" class="tsd-kind-icon">group<wbr/>Id</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-interface"><a href="WamGroup.html#addWam" class="tsd-kind-icon">add<wbr/>Wam</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="WamGroup.html#connectEvents" class="tsd-kind-icon">connect<wbr/>Events</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="WamGroup.html#disconnectEvents" class="tsd-kind-icon">disconnect<wbr/>Events</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="WamGroup.html#emitEvents" class="tsd-kind-icon">emit<wbr/>Events</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="WamGroup.html#removeWam" class="tsd-kind-icon">remove<wbr/>Wam</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="WamGroup.html#validate" class="tsd-kind-icon">validate</a></li></ul></section></div></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-interface"><a id="groupId" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagReadonly">Readonly</span> group<wbr/>Id<a href="#groupId" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/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"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></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"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">group<wbr/>Id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/webaudiomodules/api/blob/ab388b0/src/types.d.ts#L292">src/types.d.ts:292</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>The group's unique identifier.</p>
</div></div></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-interface"><a id="addWam" class="tsd-anchor"></a><h3 class="tsd-anchor-link">add<wbr/>Wam<a href="#addWam" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/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"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></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"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">add<wbr/>Wam<span class="tsd-signature-symbol">(</span>wam<span class="tsd-signature-symbol">: </span><a href="../modules.html#WamProcessor" class="tsd-signature-type" data-tsd-kind="Variable">WamProcessor</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/webaudiomodules/api/blob/ab388b0/src/types.d.ts#L297">src/types.d.ts:297</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Add the WAM to the group.</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>wam: <a href="../modules.html#WamProcessor" class="tsd-signature-type" data-tsd-kind="Variable">WamProcessor</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a id="connectEvents" class="tsd-anchor"></a><h3 class="tsd-anchor-link">connect<wbr/>Events<a href="#connectEvents" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/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"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></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"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">connect<wbr/>Events<span class="tsd-signature-symbol">(</span>fromId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, toId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, output<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><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/webaudiomodules/api/blob/ab388b0/src/types.d.ts#L301">src/types.d.ts:301</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Connect events between <code>WamProcessor</code>s, the output number is 0 by default. 'from' and 'to' must both be members of this group.</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>fromId: <span class="tsd-signature-type">string</span></h5></li><li><h5>toId: <span class="tsd-signature-type">string</span></h5></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> output: <span class="tsd-signature-type">number</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a id="disconnectEvents" class="tsd-anchor"></a><h3 class="tsd-anchor-link">disconnect<wbr/>Events<a href="#disconnectEvents" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/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"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></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"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">disconnect<wbr/>Events<span class="tsd-signature-symbol">(</span>fromId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, toId<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, output<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><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/webaudiomodules/api/blob/ab388b0/src/types.d.ts#L303">src/types.d.ts:303</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Disonnect events between <code>WamProcessor</code>s, the output number is 0 by default, if <code>toId</code> is omitted, will disconnect every connections. 'from' and 'to' must both be members of this group.</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>fromId: <span class="tsd-signature-type">string</span></h5></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> toId: <span class="tsd-signature-type">string</span></h5></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> output: <span class="tsd-signature-type">number</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a id="emitEvents" class="tsd-anchor"></a><h3 class="tsd-anchor-link">emit<wbr/>Events<a href="#emitEvents" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/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"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></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"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">emit<wbr/>Events<span class="tsd-signature-symbol">(</span>from<span class="tsd-signature-symbol">: </span><a href="../modules.html#WamProcessor" class="tsd-signature-type" data-tsd-kind="Variable">WamProcessor</a>, <span class="tsd-signature-symbol">...</span>events<span class="tsd-signature-symbol">: </span><a href="../modules.html#WamEvent" class="tsd-signature-type" data-tsd-kind="Type alias">WamEvent</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/webaudiomodules/api/blob/ab388b0/src/types.d.ts#L305">src/types.d.ts:305</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Pass events from <code>WamProcessor</code> to other <code>WamProcessor</code>s connected downstream within this group.</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>from: <a href="../modules.html#WamProcessor" class="tsd-signature-type" data-tsd-kind="Variable">WamProcessor</a></h5></li><li><h5><span class="tsd-flag ts-flagRest">Rest</span> <span class="tsd-signature-symbol">...</span>events: <a href="../modules.html#WamEvent" class="tsd-signature-type" data-tsd-kind="Type alias">WamEvent</a><span class="tsd-signature-symbol">[]</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a id="removeWam" class="tsd-anchor"></a><h3 class="tsd-anchor-link">remove<wbr/>Wam<a href="#removeWam" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/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"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></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"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">remove<wbr/>Wam<span class="tsd-signature-symbol">(</span>wam<span class="tsd-signature-symbol">: </span><a href="../modules.html#WamProcessor" class="tsd-signature-type" data-tsd-kind="Variable">WamProcessor</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/webaudiomodules/api/blob/ab388b0/src/types.d.ts#L299">src/types.d.ts:299</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Remove the WAM from the group.</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>wam: <a href="../modules.html#WamProcessor" class="tsd-signature-type" data-tsd-kind="Variable">WamProcessor</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a id="validate" class="tsd-anchor"></a><h3 class="tsd-anchor-link">validate<a href="#validate" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/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"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></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"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">validate<span class="tsd-signature-symbol">(</span>groupKey<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/webaudiomodules/api/blob/ab388b0/src/types.d.ts#L295">src/types.d.ts:295</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Used to control access to the group instance via <code>WamEnv</code>.</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>groupKey: <span class="tsd-signature-type">string</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></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></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-interface"><a href="WamGroup.html" class="tsd-kind-icon">Wam<wbr/>Group</a><ul><li class="tsd-kind-property tsd-parent-kind-interface"><a href="WamGroup.html#groupId" class="tsd-kind-icon">group<wbr/>Id</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="WamGroup.html#addWam" class="tsd-kind-icon">add<wbr/>Wam</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="WamGroup.html#connectEvents" class="tsd-kind-icon">connect<wbr/>Events</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="WamGroup.html#disconnectEvents" class="tsd-kind-icon">disconnect<wbr/>Events</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="WamGroup.html#emitEvents" class="tsd-kind-icon">emit<wbr/>Events</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="WamGroup.html#removeWam" class="tsd-kind-icon">remove<wbr/>Wam</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="WamGroup.html#validate" class="tsd-kind-icon">validate</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-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></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>