Mirrors/Tone.js
2
0
Fork 0
mirror of https://github.com/Tonejs/Tone.js synced 2024-12-30 21:48:45 +00:00
Code Issues Projects Releases Packages Wiki Activity
Tone.js/doc/Tone.Envelope.html

5166 lines
69 KiB
HTML
Raw Normal View History

First commit with the DocStrap template truely in effect ( in effect )
2014-06-22 02:56:51 +00:00
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>Tone.js Class: Envelope</title>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="styles/sunlight.default.css">
new docs theme.
2014-06-23 18:52:33 +00:00
<link type="text/css" rel="stylesheet" href="styles/site.spacelab.css">
First commit with the DocStrap template truely in effect ( in effect )
2014-06-22 02:56:51 +00:00
</head>
<body>
<div class="container-fluid">
<div class="navbar navbar-fixed-top navbar-inverse">
<div class="navbar-inner">
<a class="brand" href="index.html">Tone.js</a>
<ul class="nav">
<li class="dropdown">
<a href="classes.list.html" class="dropdown-toggle" data-toggle="dropdown">Classes<b
class="caret"></b></a>
Simple changes to the jsdocs3 template to make it ever so slightly less gross
2014-06-22 03:16:17 +00:00
<ul class="dropdown-menu ">
First commit with the DocStrap template truely in effect ( in effect )
2014-06-22 02:56:51 +00:00
<li>
<a href="Tone.html">Tone</a>
</li>
<li>
<a href="Tone.Add.html">Add</a>
</li>
<li>
<a href="Tone.AutoPanner.html">AutoPanner</a>
</li>
<li>
<a href="Tone.BitCrusher.html">BitCrusher</a>
</li>
<li>
<a href="Tone.DryWet.html">DryWet</a>
</li>
<li>
<a href="Tone.Effect.html">Effect</a>
</li>
<li>
<a href="Tone.Envelope.html">Envelope</a>
</li>
<li>
<a href="Tone.FeedbackDelay.html">FeedbackDelay</a>
</li>
<li>
<a href="Tone.FeedbackEffect.html">FeedbackEffect</a>
</li>
<li>
<a href="Tone.LFO.html">LFO</a>
</li>
<li>
<a href="Tone.Merge.html">Merge</a>
</li>
<li>
<a href="Tone.Meter.html">Meter</a>
</li>
<li>
<a href="Tone.Microphone.html">Microphone</a>
</li>
<li>
<a href="Tone.Multiply.html">Multiply</a>
</li>
<li>
<a href="Tone.Noise.html">Noise</a>
</li>
<li>
<a href="Tone.Oscillator.html">Oscillator</a>
</li>
<li>
<a href="Tone.Panner.html">Panner</a>
</li>
<li>
<a href="Tone.PingPongDelay.html">PingPongDelay</a>
</li>
<li>
<a href="Tone.Player.html">Player</a>
</li>
<li>
<a href="Tone.Recorder.html">Recorder</a>
</li>
<li>
<a href="Tone.Scale.html">Scale</a>
</li>
<li>
<a href="Tone.Signal.html">Signal</a>
</li>
<li>
<a href="Tone.Source.html">Source</a>
</li>
<li>
<a href="Tone.Split.html">Split</a>
</li>
<li>
<a href="Tone.Transport.html">Transport</a>
</li>
</ul>
</li>
</ul>
</div>
</div>
<div class="row-fluid">
<div class="span8">
<div id="main">
<h1 class="page-title">Class: Envelope</h1>
<section>
<header>
<h2>
<span class="ancestors"><a href="Tone.html">Tone</a>.</span>
Envelope
</h2>
</header>
<article>
<div class="container-overview">
<dt>
<h4 class="name" id="Envelope"><span class="type-signature"></span>new Envelope<span class="signature">(<span class="optional">attack</span>, <span class="optional">decay</span>, <span class="optional">sustain</span>, <span class="optional">release</span>, <span class="optional">minOutput</span>, <span class="optional">maxOutput</span>)</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>Envelope
ADR envelope generator attaches to an AudioParam or AudioNode</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Argument</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>attack</code></td>
<td class="type">
<span class="param-type">Tone.Time</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>decay</code></td>
<td class="type">
<span class="param-type">Tone.Time</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>sustain</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="description last"><p>a percentage (0-1) of the full amplitude</p></td>
</tr>
<tr>
<td class="name"><code>release</code></td>
<td class="type">
<span class="param-type">Tone.Time</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>minOutput</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="description last"><p>the lowest point of the envelope</p></td>
</tr>
<tr>
<td class="name"><code>maxOutput</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="description last"><p>the highest point of the envelope</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
newer docs
2014-06-23 19:28:03 +00:00
<a href="Tone.js.html">Tone.js</a>, <a href="Tone.js.html#sunlight-1-line-1141">line 1141</a>
First commit with the DocStrap template truely in effect ( in effect )
2014-06-22 02:56:51 +00:00
</li></ul></dd>
</dl>
</dd>
</div>
<h3 class="subsection-title">Extends</h3>
<ul>
<li><a href="Tone.html">Tone</a></li>
</ul>
<h3 class="subsection-title">Members</h3>
<dl>
<dt>
<h4 class="name" id="attack"><span class="type-signature"></span>attack<span class="type-signature"> :number</span></h4>
</dt>
<dd>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">number</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
newer docs
2014-06-23 19:28:03 +00:00
<a href="Tone.js.html">Tone.js</a>, <a href="Tone.js.html#sunlight-1-line-1146">line 1146</a>
First commit with the DocStrap template truely in effect ( in effect )
2014-06-22 02:56:51 +00:00
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="control"><span class="type-signature"></span>control<span class="type-signature"> :<a href="Tone.Signal.html">Tone.Signal</a></span></h4>
</dt>
<dd>
<h5>Type:</h5>
<ul>
<li>
working on docs
2014-06-23 18:20:16 +00:00
<span class="param-type"><a href="Tone.Signal.html">Tone.Signal</a></span>
</li>
</ul>
First commit with the DocStrap template truely in effect ( in effect )
2014-06-22 02:56:51 +00:00
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
newer docs
2014-06-23 19:28:03 +00:00
<a href="Tone.js.html">Tone.js</a>, <a href="Tone.js.html#sunlight-1-line-1160">line 1160</a>
First commit with the DocStrap template truely in effect ( in effect )
2014-06-22 02:56:51 +00:00
</li></ul></dd>
</dl>
</dd>
<dt>
working on docs
2014-06-23 18:20:16 +00:00
<h4 class="name" id="decay"><span class="type-signature"></span>decay<span class="type-signature"> :number</span></h4>
First commit with the DocStrap template truely in effect ( in effect )
2014-06-22 02:56:51 +00:00
</dt>
<dd>
working on docs
2014-06-23 18:20:16 +00:00
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">number</span>
</li>
</ul>
First commit with the DocStrap template truely in effect ( in effect )
2014-06-22 02:56:51 +00:00
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
newer docs
2014-06-23 19:28:03 +00:00
<a href="Tone.js.html">Tone.js</a>, <a href="Tone.js.html#sunlight-1-line-1148">line 1148</a>
First commit with the DocStrap template truely in effect ( in effect )
2014-06-22 02:56:51 +00:00
</li></ul></dd>
</dl>
</dd>
<dt>
working on docs
2014-06-23 18:20:16 +00:00
<h4 class="name" id="input"><span class="type-signature"></span>input<span class="type-signature"> :GainNode</span></h4>
First commit with the DocStrap template truely in effect ( in effect )
2014-06-22 02:56:51 +00:00
</dt>
<dd>
<div class="description">
working on docs
2014-06-23 18:20:16 +00:00
<p>default input of the ToneNode</p>
First commit with the DocStrap template truely in effect ( in effect )
2014-06-22 02:56:51 +00:00
</div>
working on docs
2014-06-23 18:20:16 +00:00
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">GainNode</span>
</li>
</ul>
First commit with the DocStrap template truely in effect ( in effect )
2014-06-22 02:56:51 +00:00
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
working on docs
2014-06-23 18:20:16 +00:00
<a href="Tone.html#input">Tone#input</a>
First commit with the DocStrap template truely in effect ( in effect )
2014-06-22 02:56:51 +00:00
</li></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
newer docs
2014-06-23 19:28:03 +00:00
<a href="Tone.js.html">Tone.js</a>, <a href="Tone.js.html#sunlight-1-line-110">line 110</a>
First commit with the DocStrap template truely in effect ( in effect )
2014-06-22 02:56:51 +00:00
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="max"><span class="type-signature"></span>max<span class="type-signature"> :number</span></h4>
</dt>
<dd>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">number</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
newer docs
2014-06-23 19:28:03 +00:00
<a href="Tone.js.html">Tone.js</a>, <a href="Tone.js.html#sunlight-1-line-1157">line 1157</a>
First commit with the DocStrap template truely in effect ( in effect )
2014-06-22 02:56:51 +00:00
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="min"><span class="type-signature"></span>min<span class="type-signature"> :number</span></h4>
</dt>
<dd>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">number</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
newer docs
2014-06-23 19:28:03 +00:00
<a href="Tone.js.html">Tone.js</a>, <a href="Tone.js.html#sunlight-1-line-1155">line 1155</a>
First commit with the DocStrap template truely in effect ( in effect )
2014-06-22 02:56:51 +00:00
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="output"><span class="type-signature"></span>output<span class="type-signature"> :GainNode</span></h4>
</dt>
<dd>
<div class="description">
<p>default output of the ToneNode</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">GainNode</span>
</li>
</ul>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="Tone.html#output">Tone#output</a>
</li></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
newer docs
2014-06-23 19:28:03 +00:00
<a href="Tone.js.html">Tone.js</a>, <a href="Tone.js.html#sunlight-1-line-116">line 116</a>
First commit with the DocStrap template truely in effect ( in effect )
2014-06-22 02:56:51 +00:00
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="release"><span class="type-signature"></span>release<span class="type-signature"> :number</span></h4>
</dt>
<dd>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">number</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
newer docs
2014-06-23 19:28:03 +00:00
<a href="Tone.js.html">Tone.js</a>, <a href="Tone.js.html#sunlight-1-line-1150">line 1150</a>
First commit with the DocStrap template truely in effect ( in effect )
2014-06-22 02:56:51 +00:00
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="sustain"><span class="type-signature"></span>sustain<span class="type-signature"> :number</span></h4>
</dt>
<dd>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">number</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
newer docs
2014-06-23 19:28:03 +00:00
<a href="Tone.js.html">Tone.js</a>, <a href="Tone.js.html#sunlight-1-line-1152">line 1152</a>
First commit with the DocStrap template truely in effect ( in effect )
2014-06-22 02:56:51 +00:00
</li></ul></dd>
</dl>
</dd>
</dl>
<h3 class="subsection-title">Methods</h3>
<dl>
<dt>
<h4 class="name" id="chain"><span class="type-signature"></span>chain<span class="signature">()</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>connect together all of the arguments in series</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Type</th>
<th>Argument</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="type">
<span class="param-type">AudioParam</span>
|
<span class="param-type"><a href="Tone.html">Tone</a></span>
</td>
<td class="attributes">
&lt;repeatable><br>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="Tone.html#chain">Tone#chain</a>
</li></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
newer docs
2014-06-23 19:28:03 +00:00
<a href="Tone.js.html">Tone.js</a>, <a href="Tone.js.html#sunlight-1-line-167">line 167</a>
First commit with the DocStrap template truely in effect ( in effect )
2014-06-22 02:56:51 +00:00
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="connect"><span class="type-signature"></span>connect<span class="signature">(param)</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>connect the envelope</p>
<p>if the envelope is connected to a param, the params
value will be set to 0 so that it doesn't interfere with the envelope</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>param</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
newer docs
2014-06-23 19:28:03 +00:00
<a href="Tone.js.html">Tone.js</a>, <a href="Tone.js.html#sunlight-1-line-1257">line 1257</a>
First commit with the DocStrap template truely in effect ( in effect )
2014-06-22 02:56:51 +00:00
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="dbToGain"><span class="type-signature"></span>dbToGain<span class="signature">(db)</span><span class="type-signature"> &rarr; {number}</span></h4>
</dt>
<dd>
<div class="description">
<p>convert db scale to gain scale (0-1)</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>db</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="Tone.html#dbToGain">Tone#dbToGain</a>
</li></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
newer docs
2014-06-23 19:28:03 +00:00
<a href="Tone.js.html">Tone.js</a>, <a href="Tone.js.html#sunlight-1-line-226">line 226</a>
First commit with the DocStrap template truely in effect ( in effect )
2014-06-22 02:56:51 +00:00
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">number</span>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="defaultArg"><span class="type-signature"></span>defaultArg<span class="signature">(given, fallback)</span><span class="type-signature"> &rarr; {*}</span></h4>
</dt>
<dd>
<div class="description">
<p>if a the given is undefined, use the fallback</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>given</code></td>
<td class="type">
<span class="param-type">*</span>
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>fallback</code></td>
<td class="type">
<span class="param-type">*</span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="Tone.html#defaultArg">Tone#defaultArg</a>
</li></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
newer docs
2014-06-23 19:28:03 +00:00
<a href="Tone.js.html">Tone.js</a>, <a href="Tone.js.html#sunlight-1-line-189">line 189</a>
First commit with the DocStrap template truely in effect ( in effect )
2014-06-22 02:56:51 +00:00
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">*</span>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="disconnect"><span class="type-signature"></span>disconnect<span class="signature">()</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>disconnect the output</p>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="Tone.html#disconnect">Tone#disconnect</a>
</li></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
newer docs
2014-06-23 19:28:03 +00:00
<a href="Tone.js.html">Tone.js</a>, <a href="Tone.js.html#sunlight-1-line-159">line 159</a>
First commit with the DocStrap template truely in effect ( in effect )
2014-06-22 02:56:51 +00:00
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="dispose"><span class="type-signature"></span>dispose<span class="signature">()</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>disconnect and dispose</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
newer docs
2014-06-23 19:28:03 +00:00
<a href="Tone.js.html">Tone.js</a>, <a href="Tone.js.html#sunlight-1-line-1268">line 1268</a>
First commit with the DocStrap template truely in effect ( in effect )
2014-06-22 02:56:51 +00:00
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="equalPowerScale"><span class="type-signature"></span>equalPowerScale<span class="signature">(percent)</span><span class="type-signature"> &rarr; {number}</span></h4>
</dt>
<dd>
<div class="description">
<p>equal power gain scale
good for cross-fading</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>percent</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"><p>(0-1)</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="Tone.html#equalPowerScale">Tone#equalPowerScale</a>
</li></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
newer docs
2014-06-23 19:28:03 +00:00
<a href="Tone.js.html">Tone.js</a>, <a href="Tone.js.html#sunlight-1-line-200">line 200</a>
First commit with the DocStrap template truely in effect ( in effect )
2014-06-22 02:56:51 +00:00
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>output gain (0-1)</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">number</span>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="expScale"><span class="type-signature"></span>expScale<span class="signature">(gain)</span><span class="type-signature"> &rarr; {number}</span></h4>
</dt>
<dd>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>gain</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"><p>(0-1)</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="Tone.html#expScale">Tone#expScale</a>
</li></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
newer docs
2014-06-23 19:28:03 +00:00
<a href="Tone.js.html">Tone.js</a>, <a href="Tone.js.html#sunlight-1-line-217">line 217</a>
First commit with the DocStrap template truely in effect ( in effect )
2014-06-22 02:56:51 +00:00
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>gain (decibel scale but betwee 0-1)</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">number</span>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="frequencyToSeconds"><span class="type-signature"></span>frequencyToSeconds<span class="signature">(freq)</span><span class="type-signature"> &rarr; {number}</span></h4>
</dt>
<dd>
<div class="description">
<p>convert a frequency into seconds
accepts both numbers and strings
i.e. 10hz or 10 both equal .1</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>freq</code></td>
<td class="type">
<span class="param-type">number</span>
|
<span class="param-type">string</span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="Tone.html#frequencyToSeconds">Tone#frequencyToSeconds</a>
</li></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
newer docs
2014-06-23 19:28:03 +00:00
<a href="Tone.js.html">Tone.js</a>, <a href="Tone.js.html#sunlight-1-line-345">line 345</a>
First commit with the DocStrap template truely in effect ( in effect )
2014-06-22 02:56:51 +00:00
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">number</span>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="gainToDb"><span class="type-signature"></span>gainToDb<span class="signature">(gain)</span><span class="type-signature"> &rarr; {number}</span></h4>
</dt>
<dd>
<div class="description">
<p>convert gain scale to decibels</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>gain</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"><p>(0-1)</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="Tone.html#gainToDb">Tone#gainToDb</a>
</li></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
newer docs
2014-06-23 19:28:03 +00:00
<a href="Tone.js.html">Tone.js</a>, <a href="Tone.js.html#sunlight-1-line-235">line 235</a>
First commit with the DocStrap template truely in effect ( in effect )
2014-06-22 02:56:51 +00:00
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">number</span>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="interpolate"><span class="type-signature"></span>interpolate<span class="signature">(input, outputMin, outputMax)</span><span class="type-signature"> &rarr; {number}</span></h4>
</dt>
<dd>
<div class="description">
<p>interpolate the input value (0-1) to be between outputMin and outputMax</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>input</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>outputMin</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>outputMax</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="Tone.html#interpolate">Tone#interpolate</a>
</li></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
newer docs
2014-06-23 19:28:03 +00:00
<a href="Tone.js.html">Tone.js</a>, <a href="Tone.js.html#sunlight-1-line-246">line 246</a>
First commit with the DocStrap template truely in effect ( in effect )
2014-06-22 02:56:51 +00:00
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">number</span>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="logScale"><span class="type-signature"></span>logScale<span class="signature">(gain)</span><span class="type-signature"> &rarr; {number}</span></h4>
</dt>
<dd>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>gain</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"><p>(0-1)</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="Tone.html#logScale">Tone#logScale</a>
</li></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
newer docs
2014-06-23 19:28:03 +00:00
<a href="Tone.js.html">Tone.js</a>, <a href="Tone.js.html#sunlight-1-line-209">line 209</a>
First commit with the DocStrap template truely in effect ( in effect )
2014-06-22 02:56:51 +00:00
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>gain (decibel scale but betwee 0-1)</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">number</span>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="noGC"><span class="type-signature"></span>noGC<span class="signature">()</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>makes a connection to ensure that the node will not be garbage collected
until 'dispose' is explicitly called</p>
<p> use carefully. circumvents JS and WebAudio's normal Garbage Collection behavior</p>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="Tone.html#noGC">Tone#noGC</a>
</li></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
newer docs
2014-06-23 19:28:03 +00:00
<a href="Tone.js.html">Tone.js</a>, <a href="Tone.js.html#sunlight-1-line-483">line 483</a>
First commit with the DocStrap template truely in effect ( in effect )
2014-06-22 02:56:51 +00:00
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="normalize"><span class="type-signature"></span>normalize<span class="signature">(input, inputMin, inputMax)</span><span class="type-signature"> &rarr; {number}</span></h4>
</dt>
<dd>
<div class="description">
<p>normalize the input to 0-1 from between inputMin to inputMax</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>input</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>inputMin</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>inputMax</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="Tone.html#normalize">Tone#normalize</a>
</li></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
newer docs
2014-06-23 19:28:03 +00:00
<a href="Tone.js.html">Tone.js</a>, <a href="Tone.js.html#sunlight-1-line-257">line 257</a>
First commit with the DocStrap template truely in effect ( in effect )
2014-06-22 02:56:51 +00:00
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">number</span>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="notationToSeconds"><span class="type-signature"></span>notationToSeconds<span class="signature">(notation, <span class="optional">bpm</span>, <span class="optional">timeSignature</span>)</span><span class="type-signature"> &rarr; {number}</span></h4>
</dt>
<dd>
<div class="description">
<p>convert notation format strings to seconds</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Argument</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>notation</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>bpm</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>timeSignature</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="Tone.html#notationToSeconds">Tone#notationToSeconds</a>
</li></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
newer docs
2014-06-23 19:28:03 +00:00
<a href="Tone.js.html">Tone.js</a>, <a href="Tone.js.html#sunlight-1-line-2004">line 2004</a>
First commit with the DocStrap template truely in effect ( in effect )
2014-06-22 02:56:51 +00:00
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">number</span>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="now"><span class="type-signature"></span>now<span class="signature">()</span><span class="type-signature"> &rarr; {number}</span></h4>
</dt>
<dd>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="Tone.html#now">Tone#now</a>
</li></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
newer docs
2014-06-23 19:28:03 +00:00
<a href="Tone.js.html">Tone.js</a>, <a href="Tone.js.html#sunlight-1-line-284">line 284</a>
First commit with the DocStrap template truely in effect ( in effect )
2014-06-22 02:56:51 +00:00
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>the currentTime from the AudioContext</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">number</span>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="receive"><span class="type-signature"></span>receive<span class="signature">(channelName)</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>recieve the input from the desired channelName to the input gain of 'this' node.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>channelName</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="Tone.html#receive">Tone#receive</a>
</li></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
newer docs
2014-06-23 19:28:03 +00:00
<a href="Tone.js.html">Tone.js</a>, <a href="Tone.js.html#sunlight-1-line-3147">line 3147</a>
First commit with the DocStrap template truely in effect ( in effect )
2014-06-22 02:56:51 +00:00
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="samplesToSeconds"><span class="type-signature"></span>samplesToSeconds<span class="signature">(samples)</span><span class="type-signature"> &rarr; {number}</span></h4>
</dt>
<dd>
<div class="description">
<p>convert a sample count to seconds</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>samples</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="Tone.html#samplesToSeconds">Tone#samplesToSeconds</a>
</li></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
newer docs
2014-06-23 19:28:03 +00:00
<a href="Tone.js.html">Tone.js</a>, <a href="Tone.js.html#sunlight-1-line-293">line 293</a>
First commit with the DocStrap template truely in effect ( in effect )
2014-06-22 02:56:51 +00:00
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">number</span>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="secondsToFrequency"><span class="type-signature"></span>secondsToFrequency<span class="signature">(seconds)</span><span class="type-signature"> &rarr; {number}</span></h4>
</dt>
<dd>
<div class="description">
<p>convert a number in seconds to a frequency</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>seconds</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="Tone.html#secondsToFrequency">Tone#secondsToFrequency</a>
</li></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
newer docs
2014-06-23 19:28:03 +00:00
<a href="Tone.js.html">Tone.js</a>, <a href="Tone.js.html#sunlight-1-line-354">line 354</a>
First commit with the DocStrap template truely in effect ( in effect )
2014-06-22 02:56:51 +00:00
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">number</span>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="send"><span class="type-signature"></span>send<span class="signature">(channelName, amount)</span><span class="type-signature"> &rarr; {GainNode}</span></h4>
</dt>
<dd>
<div class="description">
<p>send signal to a channel name</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>channelName</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>amount</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="Tone.html#send">Tone#send</a>
</li></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
newer docs
2014-06-23 19:28:03 +00:00
<a href="Tone.js.html">Tone.js</a>, <a href="Tone.js.html#sunlight-1-line-3132">line 3132</a>
First commit with the DocStrap template truely in effect ( in effect )
2014-06-22 02:56:51 +00:00
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">GainNode</span>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="toFrequency"><span class="type-signature"></span>toFrequency<span class="signature">(time)</span><span class="type-signature"> &rarr; {number}</span></h4>
</dt>
<dd>
<div class="description">
<p>convert a time to a frequency</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>time</code></td>
<td class="type">
<span class="param-type">Tone.Time</span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="Tone.html#toFrequency">Tone#toFrequency</a>
</li></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
newer docs
2014-06-23 19:28:03 +00:00
<a href="Tone.js.html">Tone.js</a>, <a href="Tone.js.html#sunlight-1-line-2091">line 2091</a>
First commit with the DocStrap template truely in effect ( in effect )
2014-06-22 02:56:51 +00:00
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>the time in hertz</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">number</span>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="toMaster"><span class="type-signature"></span>toMaster<span class="signature">()</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>connect 'this' to the master output</p>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="Tone.html#toMaster">Tone#toMaster</a>
</li></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
newer docs
2014-06-23 19:28:03 +00:00
<a href="Tone.js.html">Tone.js</a>, <a href="Tone.js.html#sunlight-1-line-454">line 454</a>
First commit with the DocStrap template truely in effect ( in effect )
2014-06-22 02:56:51 +00:00
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="toSamples"><span class="type-signature"></span>toSamples<span class="signature">(time)</span><span class="type-signature"> &rarr; {number}</span></h4>
</dt>
<dd>
<div class="description">
<p>convert a time into samples</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>time</code></td>
<td class="type">
<span class="param-type">Tone.time</span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="Tone.html#toSamples">Tone#toSamples</a>
</li></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
newer docs
2014-06-23 19:28:03 +00:00
<a href="Tone.js.html">Tone.js</a>, <a href="Tone.js.html#sunlight-1-line-303">line 303</a>
First commit with the DocStrap template truely in effect ( in effect )
2014-06-22 02:56:51 +00:00
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">number</span>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="toSeconds"><span class="type-signature"></span>toSeconds<span class="signature">(time, <span class="optional">now</span>)</span><span class="type-signature"> &rarr; {number}</span></h4>
</dt>
<dd>
<div class="description">
<p>convert Tone.Time to seconds</p>
<p> this is a simplified version which only handles numbers and
'now' relative numbers. If the Transport is included this
method is overridden to include many other features including
notationTime, Frequency, and transportTime</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Argument</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>time</code></td>
<td class="type">
<span class="param-type">Tone.Time</span>
</td>
<td class="attributes">
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>now</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="description last"><p>if passed in, this number will be
used for all 'now' relative timings</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="Tone.html#toSeconds">Tone#toSeconds</a>
</li></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
newer docs
2014-06-23 19:28:03 +00:00
<a href="Tone.js.html">Tone.js</a>, <a href="Tone.js.html#sunlight-1-line-321">line 321</a>
First commit with the DocStrap template truely in effect ( in effect )
2014-06-22 02:56:51 +00:00
</li></ul></dd>
</dl>
<h5>Returns:</h5>
new docs theme.
2014-06-23 18:52:33 +00:00
<div class="param-desc">
<p>seconds in the same timescale as the AudioContext</p>
</div>
First commit with the DocStrap template truely in effect ( in effect )
2014-06-22 02:56:51 +00:00
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">number</span>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="toSeconds"><span class="type-signature"></span>toSeconds<span class="signature">(time, <span class="optional">now</span>)</span><span class="type-signature"> &rarr; {number}</span></h4>
</dt>
<dd>
<div class="description">
<p>convert Tone.Time into seconds.</p>
<p> unlike the method which it overrides, this takes into account
transporttime and musical notation</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Argument</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>time</code></td>
<td class="type">
<span class="param-type">Tone.Time</span>
</td>
<td class="attributes">
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>now</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="description last"><p>if passed in, this number will be
used for all 'now' relative timings</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="Tone.html#toSeconds">Tone#toSeconds</a>
</li></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
newer docs
2014-06-23 19:28:03 +00:00
<a href="Tone.js.html">Tone.js</a>, <a href="Tone.js.html#sunlight-1-line-2113">line 2113</a>
First commit with the DocStrap template truely in effect ( in effect )
2014-06-22 02:56:51 +00:00
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">number</span>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="triggerAttack"><span class="type-signature"></span>triggerAttack<span class="signature">(<span class="optional">time</span>)</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>attack-&gt;decay-&gt;sustain linear ramp</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Argument</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>time</code></td>
<td class="type">
<span class="param-type">Tone.Time</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
newer docs
2014-06-23 19:28:03 +00:00
<a href="Tone.js.html">Tone.js</a>, <a href="Tone.js.html#sunlight-1-line-1172">line 1172</a>
WIP for moving to DocBlockr template
2014-06-22 02:02:41 +00:00
</li></ul></dd>
First commit with the DocStrap template truely in effect ( in effect )
2014-06-22 02:56:51 +00:00
</dl>
WIP for moving to DocBlockr template
2014-06-22 02:02:41 +00:00
</dd>
<dt>
First commit with the DocStrap template truely in effect ( in effect )
2014-06-22 02:56:51 +00:00
<h4 class="name" id="triggerExponentialAttack"><span class="type-signature"></span>triggerExponentialAttack<span class="signature">(<span class="optional">time</span>)</span><span class="type-signature"></span></h4>
WIP for moving to DocBlockr template
2014-06-22 02:02:41 +00:00
</dt>
<dd>
First commit with the DocStrap template truely in effect ( in effect )
2014-06-22 02:56:51 +00:00
WIP for moving to DocBlockr template
2014-06-22 02:02:41 +00:00
<div class="description">
First commit with the DocStrap template truely in effect ( in effect )
2014-06-22 02:56:51 +00:00
<p>attack-&gt;decay-&gt;sustain exponential attack and linear decay</p>
WIP for moving to DocBlockr template
2014-06-22 02:02:41 +00:00
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
First commit with the DocStrap template truely in effect ( in effect )
2014-06-22 02:56:51 +00:00
<th>Argument</th>
WIP for moving to DocBlockr template
2014-06-22 02:02:41 +00:00
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>time</code></td>
<td class="type">
<span class="param-type">Tone.Time</span>
</td>
First commit with the DocStrap template truely in effect ( in effect )
2014-06-22 02:56:51 +00:00
<td class="attributes">
&lt;optional><br>
</td>
WIP for moving to DocBlockr template
2014-06-22 02:02:41 +00:00
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
newer docs
2014-06-23 19:28:03 +00:00
<a href="Tone.js.html">Tone.js</a>, <a href="Tone.js.html#sunlight-1-line-1191">line 1191</a>
WIP for moving to DocBlockr template
2014-06-22 02:02:41 +00:00
</li></ul></dd>
</dl>
</dd>
<dt>
First commit with the DocStrap template truely in effect ( in effect )
2014-06-22 02:56:51 +00:00
<h4 class="name" id="triggerExponentialRelease"><span class="type-signature"></span>triggerExponentialRelease<span class="signature">(<span class="optional">time</span>)</span><span class="type-signature"></span></h4>
WIP for moving to DocBlockr template
2014-06-22 02:02:41 +00:00
</dt>
<dd>
<div class="description">
First commit with the DocStrap template truely in effect ( in effect )
2014-06-22 02:56:51 +00:00
<p>triggers the release of the envelope with an exponential ramp</p>
WIP for moving to DocBlockr template
2014-06-22 02:02:41 +00:00
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
Merge branch 'master' of github.com:TONEnoTONE/Tone.js
2014-06-22 02:15:54 +00:00
<th>Argument</th>
WIP for moving to DocBlockr template
2014-06-22 02:02:41 +00:00
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>time</code></td>
<td class="type">
<span class="param-type">Tone.Time</span>
Merge branch 'master' of github.com:TONEnoTONE/Tone.js
2014-06-22 02:15:54 +00:00
</td>
<td class="attributes">
&lt;optional><br>
</td>
WIP for moving to DocBlockr template
2014-06-22 02:02:41 +00:00
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
newer docs
2014-06-23 19:28:03 +00:00
<a href="Tone.js.html">Tone.js</a>, <a href="Tone.js.html#sunlight-1-line-1230">line 1230</a>
WIP for moving to DocBlockr template
2014-06-22 02:02:41 +00:00
</li></ul></dd>
</dl>
</dd>
<dt>
First commit with the DocStrap template truely in effect ( in effect )
2014-06-22 02:56:51 +00:00
<h4 class="name" id="triggerRelease"><span class="type-signature"></span>triggerRelease<span class="signature">(<span class="optional">time</span>)</span><span class="type-signature"></span></h4>
WIP for moving to DocBlockr template
2014-06-22 02:02:41 +00:00
</dt>
<dd>
<div class="description">
First commit with the DocStrap template truely in effect ( in effect )
2014-06-22 02:56:51 +00:00
<p>triggers the release of the envelope with a linear ramp</p>
WIP for moving to DocBlockr template
2014-06-22 02:02:41 +00:00
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
Merge branch 'master' of github.com:TONEnoTONE/Tone.js
2014-06-22 02:15:54 +00:00
<th>Argument</th>
WIP for moving to DocBlockr template
2014-06-22 02:02:41 +00:00
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
First commit with the DocStrap template truely in effect ( in effect )
2014-06-22 02:56:51 +00:00
<td class="name"><code>time</code></td>
WIP for moving to DocBlockr template
2014-06-22 02:02:41 +00:00
<td class="type">
<span class="param-type">Tone.Time</span>
Merge branch 'master' of github.com:TONEnoTONE/Tone.js
2014-06-22 02:15:54 +00:00
</td>
<td class="attributes">
&lt;optional><br>
</td>
WIP for moving to DocBlockr template
2014-06-22 02:02:41 +00:00
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
newer docs
2014-06-23 19:28:03 +00:00
<a href="Tone.js.html">Tone.js</a>, <a href="Tone.js.html#sunlight-1-line-1211">line 1211</a>
WIP for moving to DocBlockr template
2014-06-22 02:02:41 +00:00
</li></ul></dd>
</dl>
First commit with the DocStrap template truely in effect ( in effect )
2014-06-22 02:56:51 +00:00
</dd>
WIP for moving to DocBlockr template
2014-06-22 02:02:41 +00:00
First commit with the DocStrap template truely in effect ( in effect )
2014-06-22 02:56:51 +00:00
</dl>
WIP for moving to DocBlockr template
2014-06-22 02:02:41 +00:00
First commit with the DocStrap template truely in effect ( in effect )
2014-06-22 02:56:51 +00:00
WIP for moving to DocBlockr template
2014-06-22 02:02:41 +00:00
First commit with the DocStrap template truely in effect ( in effect )
2014-06-22 02:56:51 +00:00
</article>
WIP for moving to DocBlockr template
2014-06-22 02:02:41 +00:00
First commit with the DocStrap template truely in effect ( in effect )
2014-06-22 02:56:51 +00:00
</section>
WIP for moving to DocBlockr template
2014-06-22 02:02:41 +00:00
First commit with the DocStrap template truely in effect ( in effect )
2014-06-22 02:56:51 +00:00
</div>
<div class="clearfix"></div>
<footer>
<span class="copyright">
Tone No Tone Copyright © 2014.
</span>
<br />
<span class="jsdoc-message">
newer docs
2014-06-23 19:28:03 +00:00
Documentation generated on Mon Jun 23 2014 15:23:11 GMT-0400 (EDT).
First commit with the DocStrap template truely in effect ( in effect )
2014-06-22 02:56:51 +00:00
</span>
</footer>
</div>
<div class="span3">
<div id="toc"></div>
</div>
<br clear="both">
</div>
</div>
<script src="scripts/sunlight.js"></script>
<script src="scripts/sunlight.javascript.js"></script>
<script src="scripts/sunlight-plugin.doclinks.js"></script>
<script src="scripts/sunlight-plugin.linenumbers.js"></script>
<script src="scripts/sunlight-plugin.menu.js"></script>
<script src="scripts/jquery.min.js"></script>
<script src="scripts/jquery.scrollTo.js"></script>
<script src="scripts/jquery.localScroll.js"></script>
<script src="scripts/bootstrap-dropdown.js"></script>
<script src="scripts/toc.js"></script>
<script> Sunlight.highlightAll({lineNumbers:true, showMenu: true, enableDoclinks :true}); </script>
<script>
$( function () {
$( "#toc" ).toc( {
selectors : "h1,h2,h3,h4",
showAndHide : false,
scrollTo : 60
} );
$( "#toc>ul" ).addClass( "nav nav-pills nav-stacked" );
$( "#main span[id^='toc']" ).addClass( "toc-shim" );
} );
</script>
new docs
2014-06-23 17:38:55 +00:00
<script>
$( function () {
$('#main').localScroll({
offset: { top: 56 } //offset by the height of your header (give or take a few px, see what works for you)
});
$( "dt h4.name" ).each( function () {
var $this = $( this );
var icon = $( "<i/>" ).addClass( "icon-plus-sign" ).addClass( "pull-right" ).addClass( "icon-white" );
var dt = $this.parents( "dt" );
var children = dt.next( "dd" );
$this.append( icon ).css( {cursor : "pointer"} );
$this.addClass( "member-collapsed" ).addClass( "member" );
children.hide();
$this.toggle( function () {
icon.addClass( "icon-minus-sign" ).removeClass( "icon-plus-sign" ).removeClass( "icon-white" );
$this.addClass( "member-open" ).removeClass( "member-collapsed" );
children.slideDown();
}, function () {
icon.addClass( "icon-plus-sign" ).removeClass( "icon-minus-sign" ).addClass( "icon-white" );
$this.addClass( "member-collapsed" ).removeClass( "member-open" );
children.slideUp();
} );
} );
} );
</script>
First commit with the DocStrap template truely in effect ( in effect )
2014-06-22 02:56:51 +00:00
</body>
Added Grunt Buid system for building the lib as well as generating jsdocs.modified files in accordance with the grunt jsdoc specs
2014-06-18 21:39:05 +00:00
</html>
Reference in a new issue Copy permalink