@webaudiomodules/api
Version:
WebAudioModules Plugin API
27 lines • 26.1 kB
HTML
<html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>AbstractWamParameterInfo | 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="AbstractWamParameterInfo.html">AbstractWamParameterInfo</a></li></ul><h1>Interface AbstractWamParameterInfo </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="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Required</span><span class="tsd-signature-symbol"><</span><a href="WamParameterConfiguration.html" class="tsd-signature-type" data-tsd-kind="Interface">WamParameterConfiguration</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><ul class="tsd-hierarchy"><li><span class="target">AbstractWamParameterInfo</span></li></ul></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 tsd-is-inherited"><a href="AbstractWamParameterInfo.html#choices" class="tsd-kind-icon">choices</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="AbstractWamParameterInfo.html#defaultValue" class="tsd-kind-icon">default<wbr/>Value</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="AbstractWamParameterInfo.html#discreteStep" class="tsd-kind-icon">discrete<wbr/>Step</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="AbstractWamParameterInfo.html#exponent" class="tsd-kind-icon">exponent</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="AbstractWamParameterInfo.html#id" class="tsd-kind-icon">id</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="AbstractWamParameterInfo.html#label" class="tsd-kind-icon">label</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="AbstractWamParameterInfo.html#maxValue" class="tsd-kind-icon">max<wbr/>Value</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="AbstractWamParameterInfo.html#minValue" class="tsd-kind-icon">min<wbr/>Value</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="AbstractWamParameterInfo.html#type" class="tsd-kind-icon">type</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="AbstractWamParameterInfo.html#units" class="tsd-kind-icon">units</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="AbstractWamParameterInfo.html#denormalize" class="tsd-kind-icon">denormalize</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="AbstractWamParameterInfo.html#normalize" class="tsd-kind-icon">normalize</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="AbstractWamParameterInfo.html#valueString" class="tsd-kind-icon">value<wbr/>String</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 tsd-is-inherited"><a id="choices" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagReadonly">Readonly</span> choices<a href="#choices" 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">choices<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources"><p>Inherited from Readonly.choices</p><ul><li>Defined in <a href="https://github.com/webaudiomodules/api/blob/ab388b0/src/types.d.ts#L173">src/types.d.ts:173</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>A list of human-readable choices corresponding to each valid value in the parameter's range, if applicable.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="defaultValue" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagReadonly">Readonly</span> default<wbr/>Value<a href="#defaultValue" 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">default<wbr/>Value<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from Readonly.defaultValue</p><ul><li>Defined in <a href="https://github.com/webaudiomodules/api/blob/ab388b0/src/types.d.ts#L163">src/types.d.ts:163</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>The parameter's default value. Must be within range <code>[minValue, maxValue]</code>.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="discreteStep" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagReadonly">Readonly</span> discrete<wbr/>Step<a href="#discreteStep" 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">discrete<wbr/>Step<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from Readonly.discreteStep</p><ul><li>Defined in <a href="https://github.com/webaudiomodules/api/blob/ab388b0/src/types.d.ts#L169">src/types.d.ts:169</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>The distance between adjacent valid integer values, if applicable.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="exponent" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagReadonly">Readonly</span> exponent<a href="#exponent" 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">exponent<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from Readonly.exponent</p><ul><li>Defined in <a href="https://github.com/webaudiomodules/api/blob/ab388b0/src/types.d.ts#L171">src/types.d.ts:171</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>The nonlinear (exponential) skew of the parameter's range, if applicable.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="id" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagReadonly">Readonly</span> id<a href="#id" 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">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#L180">src/types.d.ts:180</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>The parameter's unique identifier.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="label" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagReadonly">Readonly</span> label<a href="#label" 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">label<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from Readonly.label</p><ul><li>Defined in <a href="https://github.com/webaudiomodules/api/blob/ab388b0/src/types.d.ts#L159">src/types.d.ts:159</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>The parameter's human-readable name.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="maxValue" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagReadonly">Readonly</span> max<wbr/>Value<a href="#maxValue" 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">max<wbr/>Value<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from Readonly.maxValue</p><ul><li>Defined in <a href="https://github.com/webaudiomodules/api/blob/ab388b0/src/types.d.ts#L167">src/types.d.ts:167</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>The maximum valid value of the parameter's range.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="minValue" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagReadonly">Readonly</span> min<wbr/>Value<a href="#minValue" 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">min<wbr/>Value<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from Readonly.minValue</p><ul><li>Defined in <a href="https://github.com/webaudiomodules/api/blob/ab388b0/src/types.d.ts#L165">src/types.d.ts:165</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>The minimum valid value of the parameter's range.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="type" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagReadonly">Readonly</span> type<a href="#type" 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">type<span class="tsd-signature-symbol">:</span> <a href="../modules.html#WamParameterType" class="tsd-signature-type" data-tsd-kind="Type alias">WamParameterType</a></div><aside class="tsd-sources"><p>Inherited from Readonly.type</p><ul><li>Defined in <a href="https://github.com/webaudiomodules/api/blob/ab388b0/src/types.d.ts#L161">src/types.d.ts:161</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>The parameter's data type.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="units" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagReadonly">Readonly</span> units<a href="#units" 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">units<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from Readonly.units</p><ul><li>Defined in <a href="https://github.com/webaudiomodules/api/blob/ab388b0/src/types.d.ts#L175">src/types.d.ts:175</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>A human-readable string representing the units of the parameter's range, if applicable.</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="denormalize" class="tsd-anchor"></a><h3 class="tsd-anchor-link">denormalize<a href="#denormalize" 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">denormalize<span class="tsd-signature-symbol">(</span>valueNorm<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">number</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#L184">src/types.d.ts:184</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Convert a value from normalized range <code>[0, 1]</code> to the parameter's denormalized range <code>[minValue, maxValue]</code>.</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>valueNorm: <span class="tsd-signature-type">number</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a id="normalize" class="tsd-anchor"></a><h3 class="tsd-anchor-link">normalize<a href="#normalize" 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">normalize<span class="tsd-signature-symbol">(</span>value<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">number</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#L182">src/types.d.ts:182</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Convert a value from the parameter's denormalized range <code>[minValue, maxValue]</code> to normalized range <code>[0, 1]</code>.</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>value: <span class="tsd-signature-type">number</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a id="valueString" class="tsd-anchor"></a><h3 class="tsd-anchor-link">value<wbr/>String<a href="#valueString" 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">value<wbr/>String<span class="tsd-signature-symbol">(</span>value<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">string</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#L186">src/types.d.ts:186</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Get a human-readable string representing the given value, including units if applicable.</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>value: <span class="tsd-signature-type">number</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</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="AbstractWamParameterInfo.html" class="tsd-kind-icon">Abstract<wbr/>Wam<wbr/>Parameter<wbr/>Info</a><ul><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="AbstractWamParameterInfo.html#choices" class="tsd-kind-icon">choices</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="AbstractWamParameterInfo.html#defaultValue" class="tsd-kind-icon">default<wbr/>Value</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="AbstractWamParameterInfo.html#discreteStep" class="tsd-kind-icon">discrete<wbr/>Step</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="AbstractWamParameterInfo.html#exponent" class="tsd-kind-icon">exponent</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="AbstractWamParameterInfo.html#id" class="tsd-kind-icon">id</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="AbstractWamParameterInfo.html#label" class="tsd-kind-icon">label</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="AbstractWamParameterInfo.html#maxValue" class="tsd-kind-icon">max<wbr/>Value</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="AbstractWamParameterInfo.html#minValue" class="tsd-kind-icon">min<wbr/>Value</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="AbstractWamParameterInfo.html#type" class="tsd-kind-icon">type</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="AbstractWamParameterInfo.html#units" class="tsd-kind-icon">units</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="AbstractWamParameterInfo.html#denormalize" class="tsd-kind-icon">denormalize</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="AbstractWamParameterInfo.html#normalize" class="tsd-kind-icon">normalize</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="AbstractWamParameterInfo.html#valueString" class="tsd-kind-icon">value<wbr/>String</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>