2014-06-18 21:39:05 +00:00
<!DOCTYPE html>
< html lang = "en" >
< head >
< meta charset = "utf-8" >
< title > JSDoc: Class: Scale< / title >
< script src = "scripts/prettify/prettify.js" > < / script >
< script src = "scripts/prettify/lang-css.js" > < / script >
<!-- [if lt IE 9]>
< script src = "//html5shiv.googlecode.com/svn/trunk/html5.js" > < / script >
<![endif]-->
< link type = "text/css" rel = "stylesheet" href = "styles/prettify-tomorrow.css" >
< link type = "text/css" rel = "stylesheet" href = "styles/jsdoc-default.css" >
< / head >
< body >
< div id = "main" >
< h1 class = "page-title" > Class: Scale< / h1 >
< section >
< header >
< h2 >
2014-06-19 17:38:21 +00:00
< span class = "ancestors" > < a href = "Tone.html" > Tone< / a > .< / span >
2014-06-18 21:39:05 +00:00
Scale
< / h2 >
< / header >
< article >
< div class = "container-overview" >
< dt >
< h4 class = "name" id = "Scale" > < span class = "type-signature" > < / span > new Scale< span class = "signature" > (inputMin, inputMax, < span class = "optional" > outputMin< / span > , < span class = "optional" > outputMax< / span > )< / span > < span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
performs a linear scaling on an input signal
scales from the input range of inputMin to inputMax
to the output range of outputMin to outputMax
if only two arguments are provided, the inputMin and inputMax are set to -1 and 1
< / div >
< h5 > Parameters:< / h5 >
< table class = "params" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th > Argument< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > inputMin< / 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 > inputMax< / 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 > outputMin< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
< td class = "attributes" >
< optional>< br >
< / 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 = "attributes" >
< 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 >
2014-06-20 05:45:05 +00:00
< a href = "Tone.js.html" > Tone.js< / a > , < a href = "Tone.js.html#line782" > line 782< / a >
2014-06-18 21:39:05 +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 = "_inputMax" > < span class = "type-signature" > < private> < / span > _inputMax< 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 >
2014-06-20 05:45:05 +00:00
< a href = "Tone.js.html" > Tone.js< / a > , < a href = "Tone.js.html#line798" > line 798< / a >
2014-06-18 21:39:05 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "_inputMin" > < span class = "type-signature" > < private> < / span > _inputMin< 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 >
2014-06-20 05:45:05 +00:00
< a href = "Tone.js.html" > Tone.js< / a > , < a href = "Tone.js.html#line795" > line 795< / a >
2014-06-18 21:39:05 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "_outputMax" > < span class = "type-signature" > < private> < / span > _outputMax< 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 >
2014-06-20 05:45:05 +00:00
< a href = "Tone.js.html" > Tone.js< / a > , < a href = "Tone.js.html#line804" > line 804< / a >
2014-06-18 21:39:05 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "_outputMin" > < span class = "type-signature" > < private> < / span > _outputMin< 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 >
2014-06-20 05:45:05 +00:00
< a href = "Tone.js.html" > Tone.js< / a > , < a href = "Tone.js.html#line801" > line 801< / a >
2014-06-18 21:39:05 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "_plusInput" > < span class = "type-signature" > < private> < / span > _plusInput< span class = "type-signature" > :< a href = "Tone.Add.html" > Tone.Add< / a > < / span > < / h4 >
< / dt >
< dd >
< h5 > Type:< / h5 >
< ul >
< li >
< span class = "param-type" > < a href = "Tone.Add.html" > Tone.Add< / a > < / span >
< / li >
< / ul >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-06-20 05:45:05 +00:00
< a href = "Tone.js.html" > Tone.js< / a > , < a href = "Tone.js.html#line809" > line 809< / a >
2014-06-18 21:39:05 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "_plusOutput" > < span class = "type-signature" > < private> < / span > _plusOutput< span class = "type-signature" > :< a href = "Tone.Add.html" > Tone.Add< / a > < / span > < / h4 >
< / dt >
< dd >
< h5 > Type:< / h5 >
< ul >
< li >
< span class = "param-type" > < a href = "Tone.Add.html" > Tone.Add< / a > < / span >
< / li >
< / ul >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-06-20 05:45:05 +00:00
< a href = "Tone.js.html" > Tone.js< / a > , < a href = "Tone.js.html#line815" > line 815< / a >
2014-06-18 21:39:05 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "_scale" > < span class = "type-signature" > < private> < / span > _scale< span class = "type-signature" > :< a href = "Tone.Multiply.html" > Tone.Multiply< / a > < / span > < / h4 >
< / dt >
< dd >
< h5 > Type:< / h5 >
< ul >
< li >
< span class = "param-type" > < a href = "Tone.Multiply.html" > Tone.Multiply< / a > < / span >
< / li >
< / ul >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-06-20 05:45:05 +00:00
< a href = "Tone.js.html" > Tone.js< / a > , < a href = "Tone.js.html#line812" > line 812< / a >
2014-06-18 21:39:05 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
2014-06-19 17:38:21 +00:00
< h4 class = "name" id = "bufferSize" > < span class = "type-signature" > < / span > bufferSize< span class = "type-signature" > :number< / span > < / h4 >
2014-06-18 21:39:05 +00:00
< / dt >
< dd >
< div class = "description" >
2014-06-19 17:38:21 +00:00
the default buffer size
2014-06-18 21:39:05 +00:00
< / div >
2014-06-19 17:38:21 +00:00
< h5 > Type:< / h5 >
< ul >
< li >
< span class = "param-type" > number< / span >
< / li >
< / ul >
2014-06-18 21:39:05 +00:00
< dl class = "details" >
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
2014-06-19 17:38:21 +00:00
< a href = "Tone.html#bufferSize" > Tone#bufferSize< / a >
2014-06-18 21:39:05 +00:00
< / li > < / dd >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-06-19 17:38:21 +00:00
< a href = "Tone.js.html" > Tone.js< / a > , < a href = "Tone.js.html#line131" > line 131< / a >
2014-06-18 21:39:05 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
2014-06-19 17:38:21 +00:00
< h4 class = "name" id = "context" > < span class = "type-signature" > < / span > context< span class = "type-signature" > :AudioContext< / span > < / h4 >
2014-06-18 21:39:05 +00:00
< / dt >
< dd >
< div class = "description" >
2014-06-19 17:38:21 +00:00
A static pointer to the audio context
2014-06-18 21:39:05 +00:00
< / div >
2014-06-19 17:38:21 +00:00
< h5 > Type:< / h5 >
< ul >
< li >
< span class = "param-type" > AudioContext< / span >
< / li >
< / ul >
2014-06-18 21:39:05 +00:00
< dl class = "details" >
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
2014-06-19 17:38:21 +00:00
< a href = "Tone.html#context" > Tone#context< / a >
2014-06-18 21:39:05 +00:00
< / li > < / dd >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-06-19 17:38:21 +00:00
< a href = "Tone.js.html" > Tone.js< / a > , < a href = "Tone.js.html#line125" > line 125< / a >
2014-06-18 21:39:05 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
2014-06-19 17:38:21 +00:00
< h4 class = "name" id = "input" > < span class = "type-signature" > < / span > input< span class = "type-signature" > :GainNode< / span > < / h4 >
2014-06-18 21:39:05 +00:00
< / dt >
< dd >
< div class = "description" >
2014-06-19 17:38:21 +00:00
default input of the ToneNode
2014-06-18 21:39:05 +00:00
< / div >
2014-06-19 17:38:21 +00:00
< h5 > Type:< / h5 >
< ul >
< li >
< span class = "param-type" > GainNode< / span >
< / li >
< / ul >
2014-06-18 21:39:05 +00:00
< dl class = "details" >
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
2014-06-19 17:38:21 +00:00
< a href = "Tone.html#input" > Tone#input< / a >
2014-06-18 21:39:05 +00:00
< / li > < / dd >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-06-19 17:38:21 +00:00
< a href = "Tone.js.html" > Tone.js< / a > , < a href = "Tone.js.html#line102" > line 102< / a >
2014-06-18 21:39:05 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
2014-06-19 17:38:21 +00:00
< h4 class = "name" id = "isFrequency" > < span class = "type-signature" > < / span > isFrequency< span class = "type-signature" > < / span > < / h4 >
2014-06-18 21:39:05 +00:00
< / dt >
< dd >
< div class = "description" >
2014-06-19 17:38:21 +00:00
true if the input is in the format number+hz
i.e.: 10hz
2014-06-18 21:39:05 +00:00
< / div >
2014-06-19 17:38:21 +00:00
< dl class = "details" >
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
< a href = "Tone.html#isFrequency" > Tone#isFrequency< / a >
< / li > < / dd >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-06-20 05:45:05 +00:00
< a href = "Tone.js.html" > Tone.js< / a > , < a href = "Tone.js.html#line1925" > line 1925< / a >
2014-06-19 17:38:21 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
2014-06-18 21:39:05 +00:00
2014-06-19 17:38:21 +00:00
< dt >
< h4 class = "name" id = "isNotation" > < span class = "type-signature" > < / span > isNotation< span class = "type-signature" > < / span > < / h4 >
2014-06-18 21:39:05 +00:00
2014-06-19 17:38:21 +00:00
< / dt >
< dd >
2014-06-18 21:39:05 +00:00
2014-06-19 17:38:21 +00:00
< div class = "description" >
tests if a string is musical notation
i.e.:
4n = quarter note
2m = two measures
8t = eighth-note triplet
< / div >
2014-06-18 21:39:05 +00:00
2014-06-19 17:38:21 +00:00
2014-06-18 21:39:05 +00:00
< dl class = "details" >
2014-06-19 17:38:21 +00:00
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
< a href = "Tone.html#isNotation" > Tone#isNotation< / a >
< / li > < / dd >
2014-06-18 21:39:05 +00:00
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-06-20 05:45:05 +00:00
< a href = "Tone.js.html" > Tone.js< / a > , < a href = "Tone.js.html#line1897" > line 1897< / a >
2014-06-18 21:39:05 +00:00
< / li > < / ul > < / dd >
< / dl >
2014-06-19 17:38:21 +00:00
< / dd >
< dt >
< h4 class = "name" id = "isTransportTime" > < span class = "type-signature" > < / span > isTransportTime< span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
tests if a string is transportTime
i.e. :
1:2:0 = 1 measure + two quarter notes + 0 sixteenth notes
< / div >
2014-06-18 21:39:05 +00:00
2014-06-19 17:38:21 +00:00
< dl class = "details" >
2014-06-18 21:39:05 +00:00
2014-06-19 17:38:21 +00:00
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
< a href = "Tone.html#isTransportTime" > Tone#isTransportTime< / a >
< / li > < / dd >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-06-20 05:45:05 +00:00
< a href = "Tone.js.html" > Tone.js< / a > , < a href = "Tone.js.html#line1911" > line 1911< / a >
2014-06-19 17:38:21 +00:00
< / li > < / ul > < / dd >
2014-06-18 21:39:05 +00:00
2014-06-19 17:38:21 +00:00
< / dl >
2014-06-18 21:39:05 +00:00
< / dd >
< dt >
2014-06-19 17:38:21 +00:00
< h4 class = "name" id = "output" > < span class = "type-signature" > < / span > output< span class = "type-signature" > :GainNode< / span > < / h4 >
2014-06-18 21:39:05 +00:00
< / dt >
< dd >
< div class = "description" >
2014-06-19 17:38:21 +00:00
default output of the ToneNode
2014-06-18 21:39:05 +00:00
< / div >
2014-06-19 17:38:21 +00:00
< h5 > Type:< / h5 >
< ul >
< li >
< span class = "param-type" > GainNode< / span >
< / li >
< / ul >
2014-06-18 21:39:05 +00:00
2014-06-19 17:38:21 +00:00
2014-06-18 21:39:05 +00:00
2014-06-19 17:38:21 +00:00
< dl class = "details" >
2014-06-18 21:39:05 +00:00
2014-06-19 17:38:21 +00:00
2014-06-18 21:39:05 +00:00
2014-06-19 17:38:21 +00:00
< 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 >
< a href = "Tone.js.html" > Tone.js< / a > , < a href = "Tone.js.html#line108" > line 108< / a >
< / li > < / ul > < / dd >
< / dl >
2014-06-18 21:39:05 +00:00
2014-06-19 17:38:21 +00:00
< / dd >
2014-06-18 21:39:05 +00:00
2014-06-19 17:38:21 +00:00
< dt >
< h4 class = "name" id = "waveShaperResolution" > < span class = "type-signature" > < / span > waveShaperResolution< span class = "type-signature" > :number< / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
the default resolution for WaveShaperNodes
< / div >
< h5 > Type:< / h5 >
< ul >
< li >
< span class = "param-type" > number< / 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#waveShaperResolution" > Tone#waveShaperResolution< / a >
< / li > < / dd >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
< a href = "Tone.js.html" > Tone.js< / a > , < a href = "Tone.js.html#line137" > line 137< / a >
< / li > < / ul > < / dd >
< / dl >
< / dd >
< / dl >
< h3 class = "subsection-title" > Methods< / h3 >
< dl >
< dt >
< h4 class = "name" id = "_setScalingParameters" > < span class = "type-signature" > < private> < / span > _setScalingParameters< span class = "signature" > ()< / span > < span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
set the scaling parameters
< / div >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-06-20 05:45:05 +00:00
< a href = "Tone.js.html" > Tone.js< / a > , < a href = "Tone.js.html#line831" > line 831< / a >
2014-06-19 17:38:21 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< 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" >
connect together all of the arguments in series
< / div >
< h5 > Parameters:< / h5 >
< table class = "params" >
< 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 >
2014-06-18 21:39:05 +00:00
< td class = "attributes" >
2014-06-19 17:38:21 +00:00
< repeatable>< br >
2014-06-18 21:39:05 +00:00
< / td >
< td class = "description last" > < / td >
< / tr >
2014-06-19 17:38:21 +00:00
< / 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 >
< a href = "Tone.js.html" > Tone.js< / a > , < a href = "Tone.js.html#line162" > line 162< / a >
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "connect" > < span class = "type-signature" > < / span > connect< span class = "signature" > (unit)< / span > < span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
connect the output of a ToneNode to an AudioParam, AudioNode, or ToneNode
< / div >
< h5 > Parameters:< / h5 >
< table class = "params" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > unit< / code > < / td >
< td class = "type" >
< span class = "param-type" > < a href = "Tone.html" > Tone< / a > < / span >
|
< span class = "param-type" > AudioParam< / span >
|
< span class = "param-type" > < a href = "AudioNode.html" > AudioNode< / a > < / 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#connect" > Tone#connect< / a >
< / li > < / dd >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
< a href = "Tone.js.html" > Tone.js< / a > , < a href = "Tone.js.html#line147" > line 147< / a >
< / 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" > → {number}< / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
convert db scale to gain scale (0-1)
< / div >
< h5 > Parameters:< / h5 >
< table class = "params" >
< 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 >
< a href = "Tone.js.html" > Tone.js< / a > , < a href = "Tone.js.html#line226" > line 226< / a >
< / 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" > → {*}< / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
if a the given is undefined, use the fallback
< / div >
< h5 > Parameters:< / h5 >
< table class = "params" >
< 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 >
< a href = "Tone.js.html" > Tone.js< / a > , < a href = "Tone.js.html#line189" > line 189< / a >
< / 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" >
disconnect the output
< / 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 >
< a href = "Tone.js.html" > Tone.js< / a > , < a href = "Tone.js.html#line154" > line 154< / a >
< / 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" >
2014-06-20 05:45:05 +00:00
clean up
2014-06-19 17:38:21 +00:00
< / div >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-06-20 05:45:05 +00:00
< a href = "Tone.js.html" > Tone.js< / a > , < a href = "Tone.js.html#line877" > line 877< / a >
2014-06-19 17:38:21 +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" > → {number}< / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
equal power gain scale
good for cross-fading
< / div >
< h5 > Parameters:< / h5 >
< table class = "params" >
< 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" > (0-1)< / 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 >
< a href = "Tone.js.html" > Tone.js< / a > , < a href = "Tone.js.html#line200" > line 200< / a >
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< div class = "param-desc" >
output gain (0-1)
< / 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" > → {number}< / span > < / h4 >
< / dt >
< dd >
< h5 > Parameters:< / h5 >
< table class = "params" >
< 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" > (0-1)< / 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 >
< a href = "Tone.js.html" > Tone.js< / a > , < a href = "Tone.js.html#line217" > line 217< / a >
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< div class = "param-desc" >
gain (decibel scale but betwee 0-1)
< / 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" > → {number}< / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
convert a frequency into seconds
accepts both numbers and strings
i.e. 10hz or 10 both equal .1
< / div >
< h5 > Parameters:< / h5 >
< table class = "params" >
< 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 >
2014-06-20 05:45:05 +00:00
< a href = "Tone.js.html" > Tone.js< / a > , < a href = "Tone.js.html#line343" > line 343< / a >
2014-06-19 17:38:21 +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" > → {number}< / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
convert gain scale to decibels
< / div >
< h5 > Parameters:< / h5 >
< table class = "params" >
< 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" > (0-1)< / 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 >
< a href = "Tone.js.html" > Tone.js< / a > , < a href = "Tone.js.html#line235" > line 235< / a >
< / 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" > → {number}< / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
interpolate the input value (0-1) to be between outputMin and outputMax
< / div >
< h5 > Parameters:< / h5 >
< table class = "params" >
< 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 >
< a href = "Tone.js.html" > Tone.js< / a > , < a href = "Tone.js.html#line246" > line 246< / a >
< / 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" > → {number}< / span > < / h4 >
< / dt >
< dd >
< h5 > Parameters:< / h5 >
< table class = "params" >
< 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" > (0-1)< / 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 >
< a href = "Tone.js.html" > Tone.js< / a > , < a href = "Tone.js.html#line209" > line 209< / a >
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< div class = "param-desc" >
gain (decibel scale but betwee 0-1)
< / 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" >
makes a connection to ensure that the node will not be garbage collected
until 'dispose' is explicitly called
use carefully. circumvents JS and WebAudio's normal Garbage Collection behavior
< / 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 >
2014-06-20 05:45:05 +00:00
< a href = "Tone.js.html" > Tone.js< / a > , < a href = "Tone.js.html#line1216" > line 1216< / a >
2014-06-19 17:38:21 +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" > → {number}< / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
normalize the input to 0-1 from between inputMin to inputMax
< / div >
< h5 > Parameters:< / h5 >
< table class = "params" >
< 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 >
< a href = "Tone.js.html" > Tone.js< / a > , < a href = "Tone.js.html#line257" > line 257< / a >
< / 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" > → {number}< / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
convert notation format strings to seconds
< / div >
< h5 > Parameters:< / h5 >
< table class = "params" >
< 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" >
< 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" >
< 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 >
2014-06-20 05:45:05 +00:00
< a href = "Tone.js.html" > Tone.js< / a > , < a href = "Tone.js.html#line1940" > line 1940< / a >
2014-06-19 17:38:21 +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" > → {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 >
2014-06-20 05:45:05 +00:00
< a href = "Tone.js.html" > Tone.js< / a > , < a href = "Tone.js.html#line284" > line 284< / a >
2014-06-19 17:38:21 +00:00
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< div class = "param-desc" >
the currentTime from the AudioContext
< / 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" >
recieve the input from the desired channelName to the input gain of 'this' node.
< / div >
< h5 > Parameters:< / h5 >
< table class = "params" >
< 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 >
2014-06-20 05:45:05 +00:00
< a href = "Tone.js.html" > Tone.js< / a > , < a href = "Tone.js.html#line2826" > line 2826< / a >
2014-06-19 17:38:21 +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" > → {number}< / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
convert a sample count to seconds
< / div >
< h5 > Parameters:< / h5 >
< table class = "params" >
< 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 >
2014-06-20 05:45:05 +00:00
< a href = "Tone.js.html" > Tone.js< / a > , < a href = "Tone.js.html#line293" > line 293< / a >
2014-06-19 17:38:21 +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" > → {number}< / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
convert a number in seconds to a frequency
< / div >
< h5 > Parameters:< / h5 >
< table class = "params" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
2014-06-18 21:39:05 +00:00
< tr >
2014-06-19 17:38:21 +00:00
< td class = "name" > < code > seconds< / code > < / td >
2014-06-18 21:39:05 +00:00
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
2014-06-19 17:38:21 +00:00
< 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 >
2014-06-20 05:45:05 +00:00
< a href = "Tone.js.html" > Tone.js< / a > , < a href = "Tone.js.html#line352" > line 352< / a >
2014-06-19 17:38:21 +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" > → {GainNode}< / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
send signal to a channel name
< / div >
< h5 > Parameters:< / h5 >
< table class = "params" >
< 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" >
2014-06-18 21:39:05 +00:00
2014-06-19 17:38:21 +00:00
< span class = "param-type" > string< / span >
< / td >
2014-06-18 21:39:05 +00:00
< td class = "description last" > < / td >
< / tr >
< tr >
2014-06-19 17:38:21 +00:00
< td class = "name" > < code > amount< / code > < / td >
2014-06-18 21:39:05 +00:00
< 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 >
2014-06-19 17:38:21 +00:00
< a href = "Tone.html#send" > Tone#send< / a >
2014-06-18 21:39:05 +00:00
< / li > < / dd >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-06-20 05:45:05 +00:00
< a href = "Tone.js.html" > Tone.js< / a > , < a href = "Tone.js.html#line2811" > line 2811< / a >
2014-06-18 21:39:05 +00:00
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< dl >
< dt >
Type
< / dt >
< dd >
2014-06-19 17:38:21 +00:00
< span class = "param-type" > GainNode< / span >
2014-06-18 21:39:05 +00:00
< / dd >
< / dl >
< / dd >
< dt >
2014-06-19 17:38:21 +00:00
< h4 class = "name" id = "setInputMax" > < span class = "type-signature" > < / span > setInputMax< span class = "signature" > (val)< / span > < span class = "type-signature" > < / span > < / h4 >
2014-06-18 21:39:05 +00:00
< / dt >
< dd >
< div class = "description" >
2014-06-19 17:38:21 +00:00
set the input max value
2014-06-18 21:39:05 +00:00
< / div >
< h5 > Parameters:< / h5 >
< table class = "params" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
2014-06-19 17:38:21 +00:00
< td class = "name" > < code > val< / code > < / td >
2014-06-18 21:39:05 +00:00
< td class = "type" >
2014-06-19 17:38:21 +00:00
< span class = "param-type" > number< / span >
2014-06-18 21:39:05 +00:00
< / 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 >
2014-06-20 05:45:05 +00:00
< a href = "Tone.js.html" > Tone.js< / a > , < a href = "Tone.js.html#line851" > line 851< / a >
2014-06-18 21:39:05 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
2014-06-19 17:38:21 +00:00
< h4 class = "name" id = "setInputMin" > < span class = "type-signature" > < / span > setInputMin< span class = "signature" > (val)< / span > < span class = "type-signature" > < / span > < / h4 >
2014-06-18 21:39:05 +00:00
< / dt >
< dd >
< div class = "description" >
2014-06-19 17:38:21 +00:00
set the input min value
2014-06-18 21:39:05 +00:00
< / div >
< h5 > Parameters:< / h5 >
< table class = "params" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
2014-06-19 17:38:21 +00:00
< td class = "name" > < code > val< / code > < / td >
2014-06-18 21:39:05 +00:00
< 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 >
2014-06-20 05:45:05 +00:00
< a href = "Tone.js.html" > Tone.js< / a > , < a href = "Tone.js.html#line842" > line 842< / a >
2014-06-18 21:39:05 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
2014-06-19 17:38:21 +00:00
< h4 class = "name" id = "setOutputMax" > < span class = "type-signature" > < / span > setOutputMax< span class = "signature" > (val)< / span > < span class = "type-signature" > < / span > < / h4 >
2014-06-18 21:39:05 +00:00
< / dt >
< dd >
< div class = "description" >
2014-06-19 17:38:21 +00:00
set the output max value
2014-06-18 21:39:05 +00:00
< / div >
< h5 > Parameters:< / h5 >
< table class = "params" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / 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 = "description last" > < / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-06-20 05:45:05 +00:00
< a href = "Tone.js.html" > Tone.js< / a > , < a href = "Tone.js.html#line869" > line 869< / a >
2014-06-18 21:39:05 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
2014-06-19 17:38:21 +00:00
< h4 class = "name" id = "setOutputMin" > < span class = "type-signature" > < / span > setOutputMin< span class = "signature" > (val)< / span > < span class = "type-signature" > < / span > < / h4 >
2014-06-18 21:39:05 +00:00
< / dt >
< dd >
< div class = "description" >
2014-06-19 17:38:21 +00:00
set the output min value
2014-06-18 21:39:05 +00:00
< / div >
< h5 > Parameters:< / h5 >
< table class = "params" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / 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 = "description last" > < / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-06-20 05:45:05 +00:00
< a href = "Tone.js.html" > Tone.js< / a > , < a href = "Tone.js.html#line860" > line 860< / a >
2014-06-18 21:39:05 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
2014-06-19 17:38:21 +00:00
< h4 class = "name" id = "toFrequency" > < span class = "type-signature" > < / span > toFrequency< span class = "signature" > (time)< / span > < span class = "type-signature" > → {number}< / span > < / h4 >
2014-06-18 21:39:05 +00:00
< / dt >
< dd >
< div class = "description" >
2014-06-19 17:38:21 +00:00
convert a time to a frequency
2014-06-18 21:39:05 +00:00
< / div >
< h5 > Parameters:< / h5 >
< table class = "params" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
2014-06-19 17:38:21 +00:00
< td class = "name" > < code > time< / code > < / td >
2014-06-18 21:39:05 +00:00
< td class = "type" >
2014-06-19 17:38:21 +00:00
< span class = "param-type" > Tone.Time< / span >
2014-06-18 21:39:05 +00:00
< / td >
< td class = "description last" > < / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
2014-06-19 17:38:21 +00:00
< 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 >
2014-06-20 05:45:05 +00:00
< a href = "Tone.js.html" > Tone.js< / a > , < a href = "Tone.js.html#line2021" > line 2021< / a >
2014-06-19 17:38:21 +00:00
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< div class = "param-desc" >
the time in hertz
< / 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" >
connect 'this' to the master output
< / 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 >
2014-06-18 21:39:05 +00:00
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-06-20 05:45:05 +00:00
< a href = "Tone.js.html" > Tone.js< / a > , < a href = "Tone.js.html#line1187" > line 1187< / a >
2014-06-18 21:39:05 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
2014-06-19 17:38:21 +00:00
< h4 class = "name" id = "toSamples" > < span class = "type-signature" > < / span > toSamples< span class = "signature" > (time)< / span > < span class = "type-signature" > → {number}< / span > < / h4 >
2014-06-18 21:39:05 +00:00
< / dt >
< dd >
< div class = "description" >
2014-06-19 17:38:21 +00:00
convert a time into samples
2014-06-18 21:39:05 +00:00
< / div >
< h5 > Parameters:< / h5 >
< table class = "params" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
2014-06-19 17:38:21 +00:00
< td class = "name" > < code > time< / code > < / td >
2014-06-18 21:39:05 +00:00
< td class = "type" >
2014-06-19 17:38:21 +00:00
< span class = "param-type" > Tone.time< / span >
2014-06-18 21:39:05 +00:00
< / td >
< td class = "description last" > < / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
2014-06-19 17:38:21 +00:00
< 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 >
2014-06-18 21:39:05 +00:00
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-06-20 05:45:05 +00:00
< a href = "Tone.js.html" > Tone.js< / a > , < a href = "Tone.js.html#line303" > line 303< / a >
2014-06-18 21:39:05 +00:00
< / li > < / ul > < / dd >
< / dl >
2014-06-19 17:38:21 +00:00
< h5 > Returns:< / h5 >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > number< / span >
< / dd >
< / dl >
2014-06-18 21:39:05 +00:00
< / dd >
< dt >
2014-06-19 17:38:21 +00:00
< h4 class = "name" id = "toSeconds" > < span class = "type-signature" > < / span > toSeconds< span class = "signature" > (time)< / span > < span class = "type-signature" > → {number}< / span > < / h4 >
2014-06-18 21:39:05 +00:00
< / dt >
< dd >
< div class = "description" >
2014-06-19 17:38:21 +00:00
convert Tone.Time to seconds
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
2014-06-18 21:39:05 +00:00
< / div >
< h5 > Parameters:< / h5 >
< table class = "params" >
< 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 >
2014-06-19 17:38:21 +00:00
< a href = "Tone.html#toSeconds" > Tone#toSeconds< / a >
2014-06-18 21:39:05 +00:00
< / li > < / dd >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-06-20 05:45:05 +00:00
< a href = "Tone.js.html" > Tone.js< / a > , < a href = "Tone.js.html#line319" > line 319< / a >
2014-06-18 21:39:05 +00:00
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > number< / span >
< / dd >
< / dl >
< / dd >
< dt >
2014-06-19 17:38:21 +00:00
< h4 class = "name" id = "toSeconds" > < span class = "type-signature" > < / span > toSeconds< span class = "signature" > (time, < span class = "optional" > bpm< / span > , < span class = "optional" > timeSignature< / span > )< / span > < span class = "type-signature" > → {number}< / span > < / h4 >
2014-06-18 21:39:05 +00:00
< / dt >
< dd >
< div class = "description" >
2014-06-19 17:38:21 +00:00
convert Tone.Time into seconds.
2014-06-18 21:39:05 +00:00
unlike the method which it overrides, this takes into account
transporttime and musical notation
< / div >
< h5 > Parameters:< / h5 >
< table class = "params" >
< 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 > bpm< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
< td class = "attributes" >
< 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" >
< 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#toSeconds" > Tone#toSeconds< / a >
< / li > < / dd >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-06-20 05:45:05 +00:00
< a href = "Tone.js.html" > Tone.js< / a > , < a href = "Tone.js.html#line2042" > line 2042< / a >
2014-06-18 21:39:05 +00:00
< / li > < / ul > < / dd >
< / dl >
2014-06-19 17:38:21 +00:00
< h5 > Returns:< / h5 >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > number< / span >
< / dd >
< / dl >
2014-06-18 21:39:05 +00:00
< / dd >
< dt >
< h4 class = "name" id = "toTransportTime" > < span class = "type-signature" > < / span > toTransportTime< span class = "signature" > (seconds, < span class = "optional" > bpm< / span > , < span class = "optional" > timeSignature< / span > )< / span > < span class = "type-signature" > → {string}< / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
Convert seconds to the closest transportTime in the form
measures:quarters:sixteenths
< / div >
< h5 > Parameters:< / h5 >
< table class = "params" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th > Argument< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > seconds< / 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 > bpm< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
< td class = "attributes" >
< 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" >
< 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#toTransportTime" > Tone#toTransportTime< / a >
< / li > < / dd >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-06-20 05:45:05 +00:00
< a href = "Tone.js.html" > Tone.js< / a > , < a href = "Tone.js.html#line2002" > line 2002< / a >
2014-06-18 21:39:05 +00:00
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > string< / span >
< / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "transportTimeToSeconds" > < span class = "type-signature" > < / span > transportTimeToSeconds< span class = "signature" > (transportTime, < span class = "optional" > bpm< / span > , < span class = "optional" > timeSignature< / span > )< / span > < span class = "type-signature" > → {number}< / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
convert transportTime into seconds
i.e.:
4:2:3 == 4 measures + 2 quarters + 3 sixteenths
< / div >
< h5 > Parameters:< / h5 >
< table class = "params" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th > Argument< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > transportTime< / 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" >
< 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" >
< 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#transportTimeToSeconds" > Tone#transportTimeToSeconds< / a >
< / li > < / dd >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-06-20 05:45:05 +00:00
< a href = "Tone.js.html" > Tone.js< / a > , < a href = "Tone.js.html#line1972" > line 1972< / a >
2014-06-18 21:39:05 +00:00
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< div class = "param-desc" >
seconds
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > number< / span >
< / dd >
< / dl >
< / dd >
< / dl >
< / article >
< / section >
< / div >
< nav >
2014-06-20 05:45:05 +00:00
< h2 > < a href = "index.html" > Index< / a > < / h2 > < h3 > Classes< / h3 > < ul > < 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.Envelope.html" > Envelope< / 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.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 > < h3 > Global< / h3 > < ul > < li > < a href = "global.html#for the default output" > for the default output< / a > < / li > < li > {GainNode}< / li > < / ul >
2014-06-18 21:39:05 +00:00
< / nav >
< br clear = "both" >
< footer >
2014-06-20 05:45:05 +00:00
Documentation generated by < a href = "https://github.com/jsdoc3/jsdoc" > JSDoc 3.2.2< / a > on Fri Jun 20 2014 01:43:58 GMT-0400 (EDT)
2014-06-18 21:39:05 +00:00
< / footer >
< script > prettyPrint ( ) ; < / script >
< script src = "scripts/linenumber.js" > < / script >
< / body >
< / html >
