2014-06-22 02:02:41 +00:00
<!DOCTYPE html>
< html lang = "en" >
< head >
< meta charset = "utf-8" >
< title > Tone.js Class: Oscillator< / 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.readable.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 " >
< 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 >
< / li >
< li class = "dropdown" >
< a href = "global.html" class = "dropdown-toggle" data-toggle = "dropdown" > Global< b
class="caret">< / b > < / a >
< ul class = "dropdown-menu " >
< li >
< a href = "global.html#for the default output" > for the default output< / a >
< / li >
< li >
{GainNode}
< / li >
< / ul >
< / li >
< / ul >
< / div >
< / div >
< div class = "row-fluid" >
< div class = "span8" >
< div id = "main" >
< h1 class = "page-title" > Class: Oscillator< / h1 >
< section >
< header >
< h2 >
< span class = "ancestors" > < a href = "Tone.html" > Tone< / a > .< / span >
Oscillator
< / h2 >
< / header >
< article >
< div class = "container-overview" >
< dt >
< h4 class = "name" id = "Oscillator" > < span class = "type-signature" > < / span > new Oscillator< span class = "signature" > (freq, < span class = "optional" > type< / span > )< / span > < span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > Oscillator< / p >
< p > Oscilator with start, pause, stop and sync to Transport< / 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 > freq< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
|
< span class = "param-type" > string< / span >
< / td >
< td class = "attributes" >
< / td >
< td class = "description last" > < p > starting frequency< / p > < / td >
< / tr >
< tr >
< td class = "name" > < code > type< / code > < / td >
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
< td class = "attributes" >
< optional>< br >
< / td >
< td class = "description last" > < p > type of oscillator (sine|square|triangle|sawtooth)< / p > < / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< 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#sunlight-1-line-2186" > line 2186< / a >
< / li > < / ul > < / dd >
< / dl >
< / dd >
< / div >
< h3 class = "subsection-title" > Extends< / h3 >
< ul >
< li > < a href = "Tone.Source.html" > Tone.Source< / a > < / li >
< / ul >
< h3 class = "subsection-title" > Members< / h3 >
< dl >
< dt >
< h4 class = "name" id = "bufferSize" > < span class = "type-signature" > < / span > bufferSize< span class = "type-signature" > :number< / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > the default buffer size< / p >
< / 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#bufferSize" > Tone#bufferSize< / 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#sunlight-1-line-131" > line 131< / a >
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "context" > < span class = "type-signature" > < / span > context< span class = "type-signature" > :AudioContext< / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > A static pointer to the audio context< / p >
< / div >
< h5 > Type:< / h5 >
< ul >
< li >
< span class = "param-type" > AudioContext< / 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#context" > Tone#context< / 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#sunlight-1-line-125" > line 125< / a >
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "frequency" > < span class = "type-signature" > < / span > frequency< span class = "type-signature" > :< a href = "Tone.Signal.html" > Tone.Signal< / a > < / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > the frequency control 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 = "Tone.js.html" > Tone.js< / a > , < a href = "Tone.js.html#sunlight-1-line-2198" > line 2198< / a >
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "input" > < span class = "type-signature" > < / span > input< span class = "type-signature" > :GainNode< / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > default input 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#input" > Tone#input< / 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#sunlight-1-line-102" > line 102< / a >
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "isFrequency" > < span class = "type-signature" > < / span > isFrequency< span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > true if the input is in the format number+hz
i.e.: 10hz< / p >
< / div >
< 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 >
< a href = "Tone.js.html" > Tone.js< / a > , < a href = "Tone.js.html#sunlight-1-line-1925" > line 1925< / a >
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "isNotation" > < span class = "type-signature" > < / span > isNotation< span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > tests if a string is musical notation
2014-06-19 17:38:21 +00:00
i.e.:
2014-06-22 02:02:41 +00:00
4n = quarter note
2m = two measures
8t = eighth-note triplet< / p >
< / div >
< dl class = "details" >
< 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 >
< 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#sunlight-1-line-1897" > line 1897< / a >
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "isTransportTime" > < span class = "type-signature" > < / span > isTransportTime< span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > tests if a string is transportTime
2014-06-19 17:38:21 +00:00
i.e. :
2014-06-22 02:02:41 +00:00
1:2:0 = 1 measure + two quarter notes + 0 sixteenth notes< / p >
< / div >
< dl class = "details" >
< 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 >
< a href = "Tone.js.html" > Tone.js< / a > , < a href = "Tone.js.html#sunlight-1-line-1911" > line 1911< / a >
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "oscillator" > < span class = "type-signature" > < / span > oscillator< span class = "type-signature" > :OscillatorNode< / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > the main oscillator< / p >
< / div >
< h5 > Type:< / h5 >
< ul >
< li >
< span class = "param-type" > OscillatorNode< / span >
< / li >
< / ul >
< dl class = "details" >
< 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#sunlight-1-line-2193" > line 2193< / a >
< / 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 > unlike most ToneNodes, Sources only have an output and no input< / 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.Source.html#output" > Tone.Source#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#sunlight-1-line-2090" > line 2090< / a >
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "state" > < span class = "type-signature" > < / span > state< span class = "type-signature" > :< a href = "Tone.Source.html#State" > Tone.Source.State< / a > < / span > < / h4 >
< / dt >
< dd >
< h5 > Type:< / h5 >
< ul >
< li >
< span class = "param-type" > < a href = "Tone.Source.html#State" > Tone.Source.State< / a > < / span >
< / li >
< / ul >
< dl class = "details" >
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
< a href = "Tone.Source.html#state" > Tone.Source#state< / 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#sunlight-1-line-2095" > line 2095< / a >
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "waveShaperResolution" > < span class = "type-signature" > < / span > waveShaperResolution< span class = "type-signature" > :number< / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > the default resolution for WaveShaperNodes< / p >
< / 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#sunlight-1-line-137" > line 137< / a >
< / li > < / ul > < / dd >
< / dl >
< / dd >
< / dl >
< h3 class = "subsection-title" > Methods< / h3 >
< dl >
< dt >
< h4 class = "name" id = "_onended" > < span class = "type-signature" > < private> < / span > _onended< span class = "signature" > ()< / span > < span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > internal on end call< / p >
< / div >
< dl class = "details" >
< 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#sunlight-1-line-2305" > line 2305< / a >
< / 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" >
< 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" >
< 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 >
< a href = "Tone.js.html" > Tone.js< / a > , < a href = "Tone.js.html#sunlight-1-line-162" > 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" >
< p > connect the output of a ToneNode to an AudioParam, AudioNode, or ToneNode< / 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 > 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#sunlight-1-line-147" > 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" >
< 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 >
< a href = "Tone.js.html" > Tone.js< / a > , < a href = "Tone.js.html#sunlight-1-line-226" > 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" >
< 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 >
< a href = "Tone.js.html" > Tone.js< / a > , < a href = "Tone.js.html#sunlight-1-line-189" > 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" >
< 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 >
< a href = "Tone.js.html" > Tone.js< / a > , < a href = "Tone.js.html#sunlight-1-line-154" > 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" >
< p > dispose and disconnect< / p >
< / div >
< dl class = "details" >
< 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#sunlight-1-line-2313" > line 2313< / a >
< / 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" >
< 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 >
< a href = "Tone.js.html" > Tone.js< / a > , < a href = "Tone.js.html#sunlight-1-line-200" > line 200< / a >
< / 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" > → {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 >
< a href = "Tone.js.html" > Tone.js< / a > , < a href = "Tone.js.html#sunlight-1-line-217" > line 217< / a >
< / 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 = "fadeTo" > < span class = "type-signature" > < / span > fadeTo< span class = "signature" > (value, time)< / span > < span class = "type-signature" > < / 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 > value< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
< td class = "description last" > < / td >
< / tr >
< tr >
< td class = "name" > < code > time< / code > < / td >
< td class = "type" >
< span class = "param-type" > Tone.Time< / span >
< / td >
< td class = "description last" > < p > (relative to 'now')< / 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.Source.html#fadeTo" > Tone.Source#fadeTo< / 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#sunlight-1-line-2146" > line 2146< / a >
< / li > < / ul > < / 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" >
< p > convert a frequency into seconds
2014-06-19 17:38:21 +00:00
accepts both numbers and strings
2014-06-22 02:15:54 +00:00
i.e. 10hz or 10 both equal .1
2014-06-19 17:38:21 +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-22 02:15:54 +00:00
< td class = "name" > < code > freq< / code > < / td >
2014-06-19 17:38:21 +00:00
< td class = "type" >
< span class = "param-type" > number< / span >
2014-06-22 02:15:54 +00:00
|
2014-06-19 17:38:21 +00:00
2014-06-22 02:15:54 +00:00
< span class = "param-type" > string< / span >
2014-06-19 17:38:21 +00:00
< / 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-22 02:15:54 +00:00
< a href = "Tone.html#frequencyToSeconds" > Tone#frequencyToSeconds< / a >
2014-06-19 17:38:21 +00:00
< / li > < / dd >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-06-22 02:15:54 +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 >
2014-06-22 02:15:54 +00:00
< h4 class = "name" id = "gainToDb" > < span class = "type-signature" > < / span > gainToDb< span class = "signature" > (gain)< / span > < span class = "type-signature" > → {number}< / span > < / h4 >
2014-06-19 17:38:21 +00:00
< / dt >
< dd >
2014-06-22 02:15:54 +00:00
< div class = "description" >
convert gain scale to decibels
< / div >
2014-06-19 17:38:21 +00:00
2014-06-22 02:15:54 +00:00
< 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 >
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 >
2014-06-22 02:15:54 +00:00
< a href = "Tone.html#gainToDb" > Tone#gainToDb< / a >
2014-06-19 17:38:21 +00:00
< / li > < / dd >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-06-22 02:15:54 +00:00
< a href = "Tone.js.html" > Tone.js< / a > , < a href = "Tone.js.html#line235" > line 235< / 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 >
2014-06-22 02:15:54 +00:00
< 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 >
2014-06-19 17:38:21 +00:00
< / dt >
< dd >
2014-06-22 02:15:54 +00:00
< div class = "description" >
interpolate the input value (0-1) to be between outputMin and outputMax
< / div >
2014-06-19 17:38:21 +00:00
2014-06-22 02:15:54 +00:00
< 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 >
2014-06-19 17:38:21 +00:00
< dl class = "details" >
2014-06-22 02:15:54 +00:00
< 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 >
2014-06-19 17:38:21 +00:00
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-06-22 02:15:54 +00:00
< a href = "Tone.js.html" > Tone.js< / a > , < a href = "Tone.js.html#line246" > line 246< / a >
2014-06-19 17:38:21 +00:00
< / li > < / ul > < / dd >
< / dl >
2014-06-22 02:15:54 +00:00
< h5 > Returns:< / h5 >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > number< / span >
< / dd >
< / dl >
2014-06-19 17:38:21 +00:00
< / dd >
< dt >
2014-06-22 02:15:54 +00:00
< h4 class = "name" id = "logScale" > < span class = "type-signature" > < / span > logScale< span class = "signature" > (gain)< / span > < span class = "type-signature" > → {number}< / span > < / h4 >
2014-06-19 17:38:21 +00:00
< / 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 >
2014-06-22 02:15:54 +00:00
< td class = "name" > < code > gain< / code > < / td >
2014-06-19 17:38:21 +00:00
< td class = "type" >
2014-06-22 02:15:54 +00:00
< span class = "param-type" > number< / span >
2014-06-19 17:38:21 +00:00
< / td >
2014-06-22 02:15:54 +00:00
< td class = "description last" > (0-1)< / td >
2014-06-19 17:38:21 +00:00
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
2014-06-22 02:15:54 +00:00
< a href = "Tone.html#logScale" > Tone#logScale< / a >
2014-06-19 17:38:21 +00:00
< / li > < / dd >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-06-22 02:15:54 +00:00
< a href = "Tone.js.html" > Tone.js< / a > , < a href = "Tone.js.html#line209" > line 209< / a >
2014-06-19 17:38:21 +00:00
< / li > < / ul > < / dd >
< / dl >
2014-06-22 02:15:54 +00:00
< 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 >
2014-06-19 17:38:21 +00:00
< / dd >
< dt >
2014-06-22 02:15:54 +00:00
< h4 class = "name" id = "noGC" > < span class = "type-signature" > < / span > noGC< span class = "signature" > ()< / span > < span class = "type-signature" > < / span > < / h4 >
2014-06-19 17:38:21 +00:00
< / dt >
< dd >
< div class = "description" >
2014-06-22 02:15:54 +00:00
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
2014-06-19 17:38:21 +00:00
< / div >
< dl class = "details" >
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
2014-06-22 02:15:54 +00:00
< a href = "Tone.html#noGC" > Tone#noGC< / a >
2014-06-19 17:38:21 +00:00
< / li > < / dd >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-06-22 02:15:54 +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 >
2014-06-22 02:15:54 +00:00
< 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 >
2014-06-19 17:38:21 +00:00
< / dt >
< dd >
< div class = "description" >
2014-06-22 02:15:54 +00:00
normalize the input to 0-1 from between inputMin to inputMax
2014-06-19 17:38:21 +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-22 02:15:54 +00:00
< 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 >
2014-06-19 17:38:21 +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-22 02:15:54 +00:00
< a href = "Tone.html#normalize" > Tone#normalize< / a >
2014-06-19 17:38:21 +00:00
< / li > < / dd >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-06-22 02:15:54 +00:00
< a href = "Tone.js.html" > Tone.js< / a > , < a href = "Tone.js.html#line257" > line 257< / 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 >
2014-06-22 02:15:54 +00:00
< 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 >
2014-06-19 17:38:21 +00:00
< / dt >
< dd >
< div class = "description" >
2014-06-22 02:15:54 +00:00
convert notation format strings to seconds
2014-06-19 17:38:21 +00:00
< / div >
< h5 > Parameters:< / h5 >
< table class = "params" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
2014-06-22 02:15:54 +00:00
< th > Argument< / th >
2014-06-19 17:38:21 +00:00
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
2014-06-22 02:15:54 +00:00
< 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 >
2014-06-19 17:38:21 +00:00
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
2014-06-22 02:15:54 +00:00
< td class = "attributes" >
< optional>< br >
< / 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 >
2014-06-22 02:15:54 +00:00
< a href = "Tone.html#notationToSeconds" > Tone#notationToSeconds< / a >
2014-06-19 17:38:21 +00:00
< / li > < / dd >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-06-22 02:15:54 +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 >
2014-06-22 02:15:54 +00:00
< h4 class = "name" id = "now" > < span class = "type-signature" > < / span > now< span class = "signature" > ()< / span > < span class = "type-signature" > → {number}< / span > < / h4 >
2014-06-19 17:38:21 +00:00
< / dt >
< dd >
< dl class = "details" >
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
2014-06-22 02:15:54 +00:00
< a href = "Tone.html#now" > Tone#now< / a >
2014-06-19 17:38:21 +00:00
< / li > < / dd >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-06-22 02:15:54 +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 >
2014-06-22 02:15:54 +00:00
< div class = "param-desc" >
the currentTime from the AudioContext
< / div >
2014-06-19 17:38:21 +00:00
< dl >
< dt >
Type
< / dt >
< dd >
2014-06-22 02:15:54 +00:00
< span class = "param-type" > number< / span >
2014-06-19 17:38:21 +00:00
< / dd >
< / dl >
2014-06-18 21:39:05 +00:00
< / dd >
< dt >
2014-06-22 02:15:54 +00:00
< h4 class = "name" id = "onended" > < span class = "type-signature" > < / span > onended< span class = "signature" > ()< / span > < span class = "type-signature" > < / span > < / h4 >
2014-06-18 21:39:05 +00:00
< / dt >
< dd >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-06-22 02:15:54 +00:00
< a href = "Tone.js.html" > Tone.js< / a > , < a href = "Tone.js.html#line2203" > line 2203< / a >
2014-06-18 21:39:05 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
2014-06-22 02:15:54 +00:00
< h4 class = "name" id = "pause" > < span class = "type-signature" > < abstract> < / span > pause< span class = "signature" > (time)< / span > < span class = "type-signature" > < / span > < / h4 >
2014-06-18 21:39:05 +00:00
< / 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 >
2014-06-22 02:15:54 +00:00
< td class = "name" > < code > time< / code > < / td >
2014-06-18 21:39:05 +00:00
< td class = "type" >
2014-06-22 02:15:54 +00:00
< span class = "param-type" > Tone.Time< / span >
2014-06-18 21:39:05 +00:00
< / td >
2014-06-22 02:15:54 +00:00
< td class = "description last" > < / td >
2014-06-18 21:39:05 +00:00
< / tr >
< / tbody >
< / table >
< dl class = "details" >
2014-06-22 02:15:54 +00:00
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
< a href = "Tone.Source.html#pause" > Tone.Source#pause< / 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-22 02:15:54 +00:00
< a href = "Tone.js.html" > Tone.js< / a > , < a href = "Tone.js.html#line2117" > line 2117< / a >
2014-06-18 21:39:05 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
2014-06-22 02:15:54 +00:00
< h4 class = "name" id = "receive" > < span class = "type-signature" > < / span > receive< span class = "signature" > (channelName)< / span > < span class = "type-signature" > < / span > < / h4 >
2014-06-18 21:39:05 +00:00
< / dt >
< dd >
2014-06-22 02:15:54 +00:00
< div class = "description" >
recieve the input from the desired channelName to the input gain of 'this' node.
< / div >
2014-06-18 21:39:05 +00:00
< 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-22 02:15:54 +00:00
< td class = "name" > < code > channelName< / code > < / td >
2014-06-18 21:39:05 +00:00
< td class = "type" >
2014-06-22 02:15:54 +00:00
< span class = "param-type" > string< / span >
2014-06-18 21:39:05 +00:00
< / 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-22 02:15:54 +00:00
< a href = "Tone.html#receive" > Tone#receive< / 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-22 02:15:54 +00:00
< a href = "Tone.js.html" > Tone.js< / a > , < a href = "Tone.js.html#line2832" > line 2832< / a >
2014-06-18 21:39:05 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
2014-06-22 02:15:54 +00:00
< h4 class = "name" id = "samplesToSeconds" > < span class = "type-signature" > < / span > samplesToSeconds< span class = "signature" > (samples)< / span > < span class = "type-signature" > → {number}< / span > < / h4 >
2014-06-18 21:39:05 +00:00
< / dt >
< dd >
< div class = "description" >
2014-06-22 02:15:54 +00:00
convert a sample count to seconds
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-22 02:15:54 +00:00
< td class = "name" > < code > samples< / code > < / td >
2014-06-18 21:39:05 +00:00
< td class = "type" >
2014-06-22 02:15:54 +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" >
2014-06-22 02:15:54 +00:00
< 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 >
2014-06-18 21:39:05 +00:00
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-06-22 02:15:54 +00:00
< a href = "Tone.js.html" > Tone.js< / a > , < a href = "Tone.js.html#line293" > line 293< / a >
2014-06-18 21:39:05 +00:00
< / li > < / ul > < / dd >
< / dl >
2014-06-22 02:15:54 +00:00
< h5 > Returns:< / h5 >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > number< / span >
2014-06-18 21:39:05 +00:00
2014-06-22 02:15:54 +00:00
< / dd >
< / dl >
2014-06-18 21:39:05 +00:00
2014-06-22 02:15:54 +00:00
2014-06-18 21:39:05 +00:00
< / dd >
< dt >
2014-06-22 02:15:54 +00:00
< h4 class = "name" id = "secondsToFrequency" > < span class = "type-signature" > < / span > secondsToFrequency< span class = "signature" > (seconds)< / span > < span class = "type-signature" > → {number}< / span > < / h4 >
2014-06-18 21:39:05 +00:00
< / dt >
< dd >
< div class = "description" >
2014-06-22 02:15:54 +00:00
convert a number in seconds 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-22 02:15:54 +00:00
< td class = "name" > < code > seconds< / code > < / td >
2014-06-18 21:39:05 +00:00
< td class = "type" >
2014-06-22 02:15:54 +00:00
< span class = "param-type" > number< / span >
2014-06-18 21:39:05 +00:00
< / td >
2014-06-22 02:15:54 +00:00
< td class = "description last" > < / td >
2014-06-18 21:39:05 +00:00
< / tr >
< / tbody >
< / table >
< dl class = "details" >
2014-06-22 02:15:54 +00:00
< 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 >
2014-06-18 21:39:05 +00:00
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-06-22 02:15:54 +00:00
< a href = "Tone.js.html" > Tone.js< / a > , < a href = "Tone.js.html#line352" > line 352< / a >
2014-06-18 21:39:05 +00:00
< / li > < / ul > < / dd >
< / dl >
2014-06-19 17:38:21 +00:00
2014-06-22 02:15:54 +00:00
< h5 > Returns:< / h5 >
2014-06-19 17:38:21 +00:00
2014-06-18 21:39:05 +00:00
2014-06-19 17:38:21 +00:00
2014-06-22 02:15:54 +00:00
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > number< / span >
2014-06-19 17:38:21 +00:00
2014-06-18 21:39:05 +00:00
2014-06-22 02:15:54 +00:00
< / dd >
2014-06-18 21:39:05 +00:00
< / dl >
2014-06-22 02:15:54 +00:00
2014-06-18 21:39:05 +00:00
< / dd >
< dt >
2014-06-22 02:15:54 +00:00
< h4 class = "name" id = "send" > < span class = "type-signature" > < / span > send< span class = "signature" > (channelName, amount)< / span > < span class = "type-signature" > → {GainNode}< / span > < / h4 >
2014-06-18 21:39:05 +00:00
< / dt >
< dd >
2014-06-19 17:38:21 +00:00
< div class = "description" >
2014-06-22 02:15:54 +00:00
send signal to a channel name
2014-06-19 17:38:21 +00:00
< / div >
2014-06-18 21:39:05 +00:00
< 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-22 02:15:54 +00:00
< td class = "name" > < code > channelName< / code > < / td >
2014-06-18 21:39:05 +00:00
< td class = "type" >
2014-06-22 02:15:54 +00:00
< 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 >
2014-06-18 21:39:05 +00:00
< / 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-22 02:15:54 +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-22 02:15:54 +00:00
< a href = "Tone.js.html" > Tone.js< / a > , < a href = "Tone.js.html#line2817" > line 2817< / 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 >
2014-06-22 02:15:54 +00:00
< span class = "param-type" > GainNode< / span >
2014-06-19 17:38:21 +00:00
< / dd >
< / dl >
2014-06-18 21:39:05 +00:00
< / dd >
< dt >
2014-06-22 02:15:54 +00:00
< h4 class = "name" id = "setFrequency" > < span class = "type-signature" > < / span > setFrequency< span class = "signature" > (val, < span class = "optional" > rampTime< / span > )< / span > < span class = "type-signature" > < / span > < / h4 >
2014-06-18 21:39:05 +00:00
< / dt >
< dd >
< div class = "description" >
2014-06-22 02:15:54 +00:00
exponentially ramp the frequency of the oscillator over the rampTime
2014-06-18 21:39:05 +00:00
< / div >
2014-06-22 02:15:54 +00:00
< 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 > val< / 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 > rampTime< / code > < / td >
< td class = "type" >
< span class = "param-type" > Tone.Time< / span >
< / td >
< td class = "attributes" >
< optional>< br >
< / td >
< td class = "description last" > when the oscillator will arrive at the frequency< / td >
< / tr >
< / tbody >
< / table >
2014-06-18 21:39:05 +00:00
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-06-22 02:15:54 +00:00
< a href = "Tone.js.html" > Tone.js< / a > , < a href = "Tone.js.html#line2284" > line 2284< / a >
2014-06-18 21:39:05 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
2014-06-22 02:15:54 +00:00
< h4 class = "name" id = "setType" > < span class = "type-signature" > < / span > setType< span class = "signature" > (type)< / span > < span class = "type-signature" > < / span > < / h4 >
2014-06-18 21:39:05 +00:00
< / dt >
< dd >
< div class = "description" >
2014-06-22 02:15:54 +00:00
set the oscillator type
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-22 02:15:54 +00:00
< td class = "name" > < code > type< / code > < / td >
2014-06-18 21:39:05 +00:00
< td class = "type" >
2014-06-22 02:15:54 +00:00
< span class = "param-type" > string< / span >
2014-06-18 21:39:05 +00:00
< / td >
2014-06-22 02:15:54 +00:00
< td class = "description last" > (sine|square|triangle|sawtooth)< / td >
2014-06-18 21:39:05 +00:00
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-06-22 02:15:54 +00:00
< a href = "Tone.js.html" > Tone.js< / a > , < a href = "Tone.js.html#line2297" > line 2297< / a >
2014-06-18 21:39:05 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
2014-06-22 02:15:54 +00:00
< h4 class = "name" id = "setVolume" > < span class = "type-signature" > < / span > setVolume< span class = "signature" > (value)< / span > < span class = "type-signature" > < / span > < / h4 >
2014-06-18 21:39:05 +00:00
< / 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 >
2014-06-22 02:15:54 +00:00
< td class = "name" > < code > value< / code > < / td >
2014-06-18 21:39:05 +00:00
< td class = "type" >
2014-06-22 02:15:54 +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 = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
2014-06-22 02:15:54 +00:00
< a href = "Tone.Source.html#setVolume" > Tone.Source#setVolume< / 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-22 02:15:54 +00:00
< a href = "Tone.js.html" > Tone.js< / a > , < a href = "Tone.js.html#line2157" > line 2157< / a >
2014-06-18 21:39:05 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
2014-06-22 02:15:54 +00:00
< h4 class = "name" id = "start" > < span class = "type-signature" > < / span > start< span class = "signature" > (time)< / span > < span class = "type-signature" > < / span > < / h4 >
2014-06-18 21:39:05 +00:00
< / dt >
< dd >
< div class = "description" >
2014-06-22 02:15:54 +00:00
start the oscillator
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 = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-06-22 02:15:54 +00:00
< a href = "Tone.js.html" > Tone.js< / a > , < a href = "Tone.js.html#line2218" > line 2218< / a >
2014-06-18 21:39:05 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
2014-06-22 02:15:54 +00:00
< h4 class = "name" id = "stop" > < span class = "type-signature" > < / span > stop< span class = "signature" > (< span class = "optional" > time< / span > )< / span > < span class = "type-signature" > < / span > < / h4 >
2014-06-18 21:39:05 +00:00
< / dt >
< dd >
< div class = "description" >
2014-06-22 02:15:54 +00:00
stop the oscillator
2014-06-18 21:39:05 +00:00
< / 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 >
2014-06-22 02:15:54 +00:00
< td class = "name" > < code > time< / code > < / td >
2014-06-18 21:39:05 +00:00
< td class = "type" >
< span class = "param-type" > Tone.Time< / span >
< / td >
< td class = "attributes" >
< optional>< br >
< / td >
2014-06-22 02:15:54 +00:00
< td class = "description last" > (optional) timing parameter< / td >
2014-06-18 21:39:05 +00:00
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-06-22 02:15:54 +00:00
< a href = "Tone.js.html" > Tone.js< / a > , < a href = "Tone.js.html#line2242" > line 2242< / a >
2014-06-18 21:39:05 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
2014-06-22 02:15:54 +00:00
< h4 class = "name" id = "sync" > < span class = "type-signature" > < / span > sync< span class = "signature" > ()< / span > < span class = "type-signature" > < / span > < / h4 >
2014-06-18 21:39:05 +00:00
< / dt >
< dd >
< div class = "description" >
2014-06-22 02:15:54 +00:00
Sync the oscillator to the transport
the current ratio between the oscillator and the Transport BPM
2014-06-19 17:38:21 +00:00
is fixed and any change to the Transport BPM will change this
2014-06-22 02:02:41 +00:00
oscillator in that same ratio< / p >
< p > Transport start/pause/stop will also start/pause/stop the oscillator< / p >
< / div >
< dl class = "details" >
< 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#sunlight-1-line-2260" > line 2260< / a >
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "toFrequency" > < span class = "type-signature" > < / span > toFrequency< span class = "signature" > (time)< / span > < span class = "type-signature" > → {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 >
< a href = "Tone.js.html" > Tone.js< / a > , < a href = "Tone.js.html#sunlight-1-line-2021" > line 2021< / a >
< / 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 >
2014-06-22 02:15:54 +00:00
< 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 >
2014-06-22 02:02:41 +00:00
2014-06-22 02:15:54 +00:00
2014-06-22 02:02:41 +00:00
< dl class = "details" >
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
2014-06-22 02:15:54 +00:00
< a href = "Tone.html#toMaster" > Tone#toMaster< / a >
2014-06-22 02:02:41 +00:00
< / li > < / dd >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-06-22 02:15:54 +00:00
< a href = "Tone.js.html" > Tone.js< / a > , < a href = "Tone.js.html#sunlight-1-line-1187" > line 1187< / a >
2014-06-22 02:02:41 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
2014-06-22 02:15:54 +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-22 02:02:41 +00:00
< / dt >
< dd >
< div class = "description" >
2014-06-22 02:15:54 +00:00
< p > convert a time into samples< / p >
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 >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > time< / code > < / td >
< td class = "type" >
2014-06-22 02:15:54 +00:00
< span class = "param-type" > Tone.time< / span >
2014-06-22 02:02:41 +00:00
< / 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-22 02:15:54 +00:00
< a href = "Tone.html#toSamples" > Tone#toSamples< / a >
2014-06-22 02:02:41 +00:00
< / li > < / dd >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-06-22 02:15:54 +00:00
< a href = "Tone.js.html" > Tone.js< / a > , < a href = "Tone.js.html#sunlight-1-line-303" > line 303< / a >
2014-06-22 02:02:41 +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-22 02:15:54 +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-22 02:02:41 +00:00
< / dt >
< dd >
< div class = "description" >
2014-06-22 02:15:54 +00:00
< 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 >
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 >
< 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#toSeconds" > Tone#toSeconds< / a >
< / li > < / dd >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-06-22 02:15:54 +00:00
< a href = "Tone.js.html" > Tone.js< / a > , < a href = "Tone.js.html#sunlight-1-line-319" > line 319< / a >
2014-06-22 02:02:41 +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-22 02:15:54 +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-22 02:02:41 +00:00
< / dt >
< dd >
< div class = "description" >
2014-06-22 02:15:54 +00:00
< p > convert Tone.Time into seconds.< / p >
< p > unlike the method which it overrides, this takes into account
transporttime and musical notation< / p >
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 >
< th > Argument< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
2014-06-22 02:15:54 +00:00
< td class = "name" > < code > time< / code > < / td >
2014-06-22 02:02:41 +00:00
< 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 >
2014-06-22 02:15:54 +00:00
< a href = "Tone.html#toSeconds" > Tone#toSeconds< / a >
2014-06-22 02:02:41 +00:00
< / li > < / dd >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-06-22 02:15:54 +00:00
< a href = "Tone.js.html" > Tone.js< / a > , < a href = "Tone.js.html#sunlight-1-line-2042" > line 2042< / a >
2014-06-22 02:02:41 +00:00
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< dl >
< dt >
Type
< / dt >
< dd >
2014-06-22 02:15:54 +00:00
< span class = "param-type" > number< / span >
2014-06-22 02:02:41 +00:00
< / dd >
< / dl >
< / dd >
< dt >
2014-06-22 02:15:54 +00:00
< 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 >
2014-06-22 02:02:41 +00:00
< / dt >
< dd >
< div class = "description" >
2014-06-22 02:15:54 +00:00
< p > Convert seconds to the closest transportTime in the form
measures:quarters:sixteenths< / p >
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 >
< th > Argument< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
2014-06-22 02:15:54 +00:00
< td class = "name" > < code > seconds< / code > < / td >
2014-06-22 02:02:41 +00:00
< td class = "type" >
2014-06-22 02:15:54 +00:00
< span class = "param-type" > Tone.Time< / span >
2014-06-22 02:02:41 +00:00
< / 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 >
2014-06-22 02:15:54 +00:00
< a href = "Tone.html#toTransportTime" > Tone#toTransportTime< / a >
2014-06-22 02:02:41 +00:00
< / li > < / dd >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-06-22 02:15:54 +00:00
< a href = "Tone.js.html" > Tone.js< / a > , < a href = "Tone.js.html#sunlight-1-line-2002" > line 2002< / a >
2014-06-22 02:02:41 +00:00
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< dl >
< dt >
Type
< / dt >
< dd >
2014-06-22 02:15:54 +00:00
< span class = "param-type" > string< / span >
2014-06-22 02:02:41 +00:00
< / dd >
< / dl >
< / dd >
< dt >
2014-06-22 02:15:54 +00:00
< 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 >
2014-06-22 02:02:41 +00:00
< / dt >
< dd >
< div class = "description" >
2014-06-22 02:15:54 +00:00
< p > convert transportTime into seconds
2014-06-18 21:39:05 +00:00
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 >
< dt >
< h4 class = "name" id = "unsync" > < span class = "type-signature" > < / span > unsync< span class = "signature" > ()< / span > < span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
unsync the oscillator from the Transport
< / 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#line2271" > line 2271< / a >
2014-06-18 21:39:05 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< / dl >
< / article >
< / section >
< / div >
< nav >
2014-06-20 15:04:17 +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.Panner.html" > Panner< / 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 15:04:17 +00:00
Documentation generated by < a href = "https://github.com/jsdoc3/jsdoc" > JSDoc 3.2.2< / a > on Fri Jun 20 2014 11:03:22 GMT-0400 (EDT)
2014-06-18 21:39:05 +00:00
< / footer >
< script > prettyPrint ( ) ; < / script >
< script src = "scripts/linenumber.js" > < / script >
< / body >
< / html >
