Mirrors/Tone.js
2
0
Fork 0
mirror of https://github.com/Tonejs/Tone.js synced 2024-11-17 00:58:09 +00:00
Code Issues Projects Releases Packages Wiki Activity
Tone.js/doc/Tone.DryWet.html

1037 lines
15 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: DryWet</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">
<link type="text/css" rel="stylesheet" href="styles/site.flatly.css">
</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>
<ul class="dropdown-menu inline">
<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: DryWet</h1>
<section>
<header>
<h2>
<span class="ancestors"><a href="Tone.html">Tone</a>.</span>
DryWet
</h2>
</header>
<article>
<div class="container-overview">
<dt>
<h4 class="name" id="DryWet"><span class="type-signature"></span>new DryWet<span class="signature">(<span class="optional">initialDry</span>)</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>DRY/WET KNOB</p>
<p>equal power fading control values:
0 = 100% dry - 0% wet
1 = 0% dry - 100% wet</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>initialDry</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="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="DryWet.js.html">component/DryWet.js</a>, <a href="DryWet.js.html#sunlight-1-line-13">line 13</a>
</li></ul></dd>
</dl>
</dd>
</div>
<h3 class="subsection-title">Members</h3>
<dl>
<dt>
<h4 class="name" id="_invert"><span class="type-signature">&lt;private> </span>_invert<span class="type-signature"> :<a href="Tone.html">Tone</a></span></h4>
</dt>
<dd>
<div class="description">
<p>invert the incoming signal</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type"><a href="Tone.html">Tone</a></span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="DryWet.js.html">component/DryWet.js</a>, <a href="DryWet.js.html#sunlight-1-line-42">line 42</a>
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="dry"><span class="type-signature"></span>dry<span class="type-signature"> :GainNode</span></h4>
</dt>
<dd>
<div class="description">
<p>connect this input to the dry signal
the dry signal is also the default input</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">GainNode</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="DryWet.js.html">component/DryWet.js</a>, <a href="DryWet.js.html#sunlight-1-line-22">line 22</a>
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="wet"><span class="type-signature"></span>wet<span class="type-signature"> :GainNode</span></h4>
</dt>
<dd>
<div class="description">
<p>connect this input to the wet signal</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">GainNode</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="DryWet.js.html">component/DryWet.js</a>, <a href="DryWet.js.html#sunlight-1-line-29">line 29</a>
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="wetness"><span class="type-signature"></span>wetness<span class="type-signature"> :<a href="Tone.Signal.html">Tone.Signal</a></span></h4>
</dt>
<dd>
<div class="description">
<p>controls the amount of wet signal
which is mixed into the dry signal</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type"><a href="Tone.Signal.html">Tone.Signal</a></span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="DryWet.js.html">component/DryWet.js</a>, <a href="DryWet.js.html#sunlight-1-line-36">line 36</a>
</li></ul></dd>
</dl>
</dd>
</dl>
<h3 class="subsection-title">Methods</h3>
<dl>
<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>clean up</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="DryWet.js.html">component/DryWet.js</a>, <a href="DryWet.js.html#sunlight-1-line-87">line 87</a>
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="setDry"><span class="type-signature"></span>setDry<span class="signature">(val, <span class="optional">rampTime</span>)</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>Set the dry value</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>val</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>rampTime</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>
<a href="DryWet.js.html">component/DryWet.js</a>, <a href="DryWet.js.html#sunlight-1-line-66">line 66</a>
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="setWet"><span class="type-signature"></span>setWet<span class="signature">(val, <span class="optional">rampTime</span>)</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>Set the wet value</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>val</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>rampTime</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>
<a href="DryWet.js.html">component/DryWet.js</a>, <a href="DryWet.js.html#sunlight-1-line-76">line 76</a>
</li></ul></dd>
</dl>
</dd>
</dl>
</article>
</section>
</div>
<div class="clearfix"></div>
<footer>
<span class="copyright">
Tone No Tone Copyright © 2014.
</span>
<br />
<span class="jsdoc-message">
Documentation generated on Sat Jun 21 2014 22:54:28 GMT-0400 (EDT).
</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>
</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