2014-06-22 02:02:41 +00:00
<!DOCTYPE html>
< html lang = "en" >
< head >
< meta charset = "utf-8" >
< title > Tone.js Class: Transport< / 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" >
2014-06-23 18:52:33 +00:00
< link type = "text/css" rel = "stylesheet" href = "styles/site.spacelab.css" >
2014-06-22 02:02:41 +00:00
< / head >
< body >
< div class = "container-fluid" >
< div class = "navbar navbar-fixed-top navbar-inverse" >
< div class = "navbar-inner" >
< a class = "brand" href = "index.html" > Tone.js< / a >
< ul class = "nav" >
< li class = "dropdown" >
< a href = "classes.list.html" class = "dropdown-toggle" data-toggle = "dropdown" > Classes< b
class="caret">< / b > < / a >
2014-06-22 03:16:17 +00:00
< ul class = "dropdown-menu " >
2014-06-22 02:02:41 +00:00
< li >
< a href = "Tone.html" > Tone< / a >
< / li >
< li >
< a href = "Tone.Add.html" > Add< / a >
< / li >
< li >
< a href = "Tone.AutoPanner.html" > AutoPanner< / a >
< / li >
< li >
< a href = "Tone.BitCrusher.html" > BitCrusher< / a >
< / li >
< li >
< a href = "Tone.DryWet.html" > DryWet< / a >
< / li >
2014-06-22 02:56:51 +00:00
< li >
< a href = "Tone.Effect.html" > Effect< / a >
< / li >
2014-06-22 02:02:41 +00:00
< li >
< a href = "Tone.Envelope.html" > Envelope< / a >
< / li >
2014-06-22 02:56:51 +00:00
< li >
< a href = "Tone.FeedbackDelay.html" > FeedbackDelay< / a >
< / li >
< li >
< a href = "Tone.FeedbackEffect.html" > FeedbackEffect< / a >
< / li >
2014-06-22 02:02:41 +00:00
< 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 >
2014-06-22 02:56:51 +00:00
< li >
< a href = "Tone.Panner.html" > Panner< / a >
< / li >
< li >
< a href = "Tone.PingPongDelay.html" > PingPongDelay< / a >
< / li >
2014-06-22 02:02:41 +00:00
< li >
< a href = "Tone.Player.html" > Player< / a >
< / li >
< li >
< a href = "Tone.Recorder.html" > Recorder< / a >
< / li >
< li >
< a href = "Tone.Scale.html" > Scale< / a >
< / li >
< li >
< a href = "Tone.Signal.html" > Signal< / a >
< / li >
< li >
< a href = "Tone.Source.html" > Source< / a >
< / li >
< li >
< a href = "Tone.Split.html" > Split< / a >
< / li >
< li >
< a href = "Tone.Transport.html" > Transport< / a >
< / li >
< / ul >
< / li >
< / ul >
< / div >
< / div >
< div class = "row-fluid" >
< div class = "span8" >
< div id = "main" >
< h1 class = "page-title" > Class: Transport< / h1 >
< section >
< header >
< h2 >
< span class = "ancestors" > < a href = "Tone.html" > Tone< / a > .< / span >
Transport
< / h2 >
< / header >
< article >
< div class = "container-overview" >
< dt >
< h4 class = "name" id = "Transport" > < span class = "type-signature" > < / span > new Transport< span class = "signature" > ()< / span > < span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > oscillator-based transport allows for simple musical timing
supports tempo curves and time changes< / p >
< / div >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-06-22 02:56:51 +00:00
< a href = "Transport.js.html" > core/Transport.js< / a > , < a href = "Transport.js.html#sunlight-1-line-11" > line 11< / a >
2014-06-22 02:02:41 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< / div >
< h3 class = "subsection-title" > Extends< / h3 >
< ul >
< li > < a href = "Tone.html" > Tone< / a > < / li >
< / ul >
2014-06-23 18:20:16 +00:00
< h3 class = "subsection-title" > Members< / h3 >
2014-06-22 02:02:41 +00:00
2014-06-23 18:20:16 +00:00
< dl >
2014-06-22 02:02:41 +00:00
< dt >
2014-06-23 18:20:16 +00:00
< h4 class = "name" id = "input" > < span class = "type-signature" > < / span > input< span class = "type-signature" > :GainNode< / span > < / h4 >
2014-06-22 02:02:41 +00:00
< / dt >
< dd >
< div class = "description" >
2014-06-23 18:20:16 +00:00
< p > default input of the ToneNode< / p >
2014-06-22 02:02:41 +00:00
< / div >
2014-06-23 18:20:16 +00:00
< h5 > Type:< / h5 >
< ul >
< li >
< span class = "param-type" > GainNode< / span >
< / li >
< / ul >
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-23 18:20:16 +00:00
< a href = "Tone.html#input" > Tone#input< / 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-23 18:52:33 +00:00
< a href = "Tone.js.html" > core/Tone.js< / a > , < a href = "Tone.js.html#sunlight-1-line-110" > line 110< / a >
2014-06-22 02:02:41 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "loop" > < span class = "type-signature" > < / span > loop< span class = "type-signature" > :boolean< / span > < / h4 >
< / dt >
< dd >
< h5 > Type:< / h5 >
< ul >
< li >
< span class = "param-type" > boolean< / span >
< / li >
< / ul >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-06-23 17:38:55 +00:00
< a href = "Transport.js.html" > core/Transport.js< / a > , < a href = "Transport.js.html#sunlight-1-line-25" > line 25< / a >
2014-06-22 02:02:41 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "output" > < span class = "type-signature" > < / span > output< span class = "type-signature" > :GainNode< / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > default output of the ToneNode< / p >
< / div >
< h5 > Type:< / h5 >
< ul >
< li >
< span class = "param-type" > GainNode< / span >
< / li >
< / ul >
< dl class = "details" >
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
< a href = "Tone.html#output" > Tone#output< / a >
< / li > < / dd >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-06-23 18:52:33 +00:00
< a href = "Tone.js.html" > core/Tone.js< / a > , < a href = "Tone.js.html#sunlight-1-line-116" > line 116< / a >
2014-06-22 02:02:41 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "state" > < span class = "type-signature" > < / span > state< span class = "type-signature" > :TransportState< / span > < / h4 >
< / dt >
< dd >
< h5 > Type:< / h5 >
< ul >
< li >
< span class = "param-type" > TransportState< / span >
< / li >
< / ul >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-06-23 17:38:55 +00:00
< a href = "Transport.js.html" > core/Transport.js< / a > , < a href = "Transport.js.html#sunlight-1-line-30" > line 30< / a >
2014-06-22 02:02:41 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< / dl >
< h3 class = "subsection-title" > Methods< / h3 >
< dl >
< dt >
< h4 class = "name" id = "_processBuffer" > < span class = "type-signature" > < / span > _processBuffer< span class = "signature" > (event)< / span > < span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > called when a buffer is ready< / 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 > event< / code > < / td >
< td class = "type" >
< span class = "param-type" > AudioProcessingEvent< / 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-23 17:38:55 +00:00
< a href = "Transport.js.html" > core/Transport.js< / a > , < a href = "Transport.js.html#sunlight-1-line-142" > line 142< / a >
2014-06-22 02:02:41 +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" >
< 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 >
2014-06-23 18:52:33 +00:00
< a href = "Tone.js.html" > core/Tone.js< / a > , < a href = "Tone.js.html#sunlight-1-line-167" > line 167< / a >
2014-06-22 02:02:41 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "clearInterval" > < span class = "type-signature" > < / span > clearInterval< span class = "signature" > (rmInterval)< / span > < span class = "type-signature" > → {boolean}< / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > clear an interval from the processing array< / 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 > rmInterval< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
< td class = "description last" > < p > the interval to remove< / p > < / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-06-23 17:38:55 +00:00
< a href = "Transport.js.html" > core/Transport.js< / a > , < a href = "Transport.js.html#sunlight-1-line-271" > line 271< / a >
2014-06-22 02:02:41 +00:00
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< div class = "param-desc" >
< p > true if the event was removed< / p >
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > boolean< / span >
< / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "clearIntervals" > < span class = "type-signature" > < / span > clearIntervals< span class = "signature" > ()< / span > < span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > removes all of the intervals that are currently set< / p >
< / div >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-06-23 17:38:55 +00:00
< a href = "Transport.js.html" > core/Transport.js< / a > , < a href = "Transport.js.html#sunlight-1-line-285" > line 285< / a >
2014-06-22 02:02:41 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "clearTimeline" > < span class = "type-signature" > < / span > clearTimeline< span class = "signature" > (timelineID)< / span > < span class = "type-signature" > → {boolean}< / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > clear the transportTimeline event from the< / 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 > timelineID< / 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-23 17:38:55 +00:00
< a href = "Transport.js.html" > core/Transport.js< / a > , < a href = "Transport.js.html#sunlight-1-line-378" > line 378< / a >
2014-06-22 02:02:41 +00:00
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< div class = "param-desc" >
< p > true if it was removed< / p >
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > boolean< / span >
< / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "clearTimelines" > < span class = "type-signature" > < / span > clearTimelines< span class = "signature" > ()< / span > < span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > remove all events from the timeline< / p >
< / div >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-06-23 17:38:55 +00:00
< a href = "Transport.js.html" > core/Transport.js< / a > , < a href = "Transport.js.html#sunlight-1-line-392" > line 392< / a >
2014-06-22 02:02:41 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "clearTimeout" > < span class = "type-signature" > < / span > clearTimeout< span class = "signature" > (timeoutID)< / span > < span class = "type-signature" > → {boolean}< / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > clear the timeout based on it's ID< / 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 > timeoutID< / 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-23 17:38:55 +00:00
< a href = "Transport.js.html" > core/Transport.js< / a > , < a href = "Transport.js.html#sunlight-1-line-322" > line 322< / a >
2014-06-22 02:02:41 +00:00
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< div class = "param-desc" >
< p > true if the timeout was removed< / p >
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > boolean< / span >
< / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "clearTimeouts" > < span class = "type-signature" > < / span > clearTimeouts< span class = "signature" > ()< / span > < span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > removes all of the timeouts that are currently set< / p >
< / div >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-06-23 17:38:55 +00:00
< a href = "Transport.js.html" > core/Transport.js< / a > , < a href = "Transport.js.html#sunlight-1-line-338" > line 338< / a >
2014-06-22 02:02:41 +00:00
< / li > < / ul > < / dd >
< dt class = "tag-todo" > To Do:< / dt >
< dd class = "tag-todo" >
< ul >
< li > (optionally) remove events after a certain time< / 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 >
2014-06-23 18:52:33 +00:00
< a href = "Tone.js.html" > core/Tone.js< / a > , < a href = "Tone.js.html#sunlight-1-line-152" > line 152< / a >
2014-06-22 02:02:41 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "dbToGain" > < span class = "type-signature" > < / span > dbToGain< span class = "signature" > (db)< / span > < span class = "type-signature" > → {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 >
2014-06-23 18:52:33 +00:00
< a href = "Tone.js.html" > core/Tone.js< / a > , < a href = "Tone.js.html#sunlight-1-line-226" > line 226< / 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 >
< 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 >
2014-06-23 18:52:33 +00:00
< a href = "Tone.js.html" > core/Tone.js< / a > , < a href = "Tone.js.html#sunlight-1-line-189" > line 189< / 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" > *< / 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 >
2014-06-23 18:52:33 +00:00
< a href = "Tone.js.html" > core/Tone.js< / a > , < a href = "Tone.js.html#sunlight-1-line-159" > line 159< / a >
2014-06-22 02:02:41 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "dispose" > < span class = "type-signature" > < virtual> < / span > dispose< span class = "signature" > ()< / span > < span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > a dispose method< / p >
< / div >
< dl class = "details" >
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
< a href = "Tone.html#dispose" > Tone#dispose< / a >
< / li > < / dd >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-06-23 18:52:33 +00:00
< a href = "Tone.js.html" > core/Tone.js< / a > , < a href = "Tone.js.html#sunlight-1-line-274" > line 274< / a >
2014-06-22 02:02:41 +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" >
< 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 >
2014-06-23 18:52:33 +00:00
< a href = "Tone.js.html" > core/Tone.js< / a > , < a href = "Tone.js.html#sunlight-1-line-200" > line 200< / a >
2014-06-22 02:02:41 +00:00
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< div class = "param-desc" >
< p > output gain (0-1)< / p >
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > number< / span >
< / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "expScale" > < span class = "type-signature" > < / span > expScale< span class = "signature" > (gain)< / span > < span class = "type-signature" > → {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 >
2014-06-23 18:52:33 +00:00
< a href = "Tone.js.html" > core/Tone.js< / a > , < a href = "Tone.js.html#sunlight-1-line-217" > line 217< / a >
2014-06-22 02:02:41 +00:00
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< div class = "param-desc" >
< p > gain (decibel scale but betwee 0-1)< / p >
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > number< / span >
< / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "frequencyToSeconds" > < span class = "type-signature" > < / span > frequencyToSeconds< span class = "signature" > (freq)< / span > < span class = "type-signature" > → {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:02:41 +00:00
i.e. 10hz or 10 both equal .1< / p >
< / div >
< h5 > Parameters:< / h5 >
< table class = "params table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > freq< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
|
< span class = "param-type" > string< / span >
< / td >
< td class = "description last" > < / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
< a href = "Tone.html#frequencyToSeconds" > Tone#frequencyToSeconds< / a >
< / li > < / dd >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-06-23 18:52:33 +00:00
< a href = "Tone.js.html" > core/Tone.js< / a > , < a href = "Tone.js.html#sunlight-1-line-345" > line 345< / 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 >
< 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" >
< p > convert gain scale to decibels< / p >
< / div >
< h5 > Parameters:< / h5 >
< table class = "params table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > gain< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
< td class = "description last" > < p > (0-1)< / p > < / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
< a href = "Tone.html#gainToDb" > Tone#gainToDb< / a >
< / li > < / dd >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-06-23 18:52:33 +00:00
< a href = "Tone.js.html" > core/Tone.js< / a > , < a href = "Tone.js.html#sunlight-1-line-235" > line 235< / 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 >
< h4 class = "name" id = "getBpm" > < span class = "type-signature" > < / span > getBpm< span class = "signature" > ()< / span > < span class = "type-signature" > → {number}< / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > return the current BPM< / p >
< / div >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-06-23 17:38:55 +00:00
< a href = "Transport.js.html" > core/Transport.js< / a > , < a href = "Transport.js.html#sunlight-1-line-527" > line 527< / 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 >
< h4 class = "name" id = "getTimeSignature" > < span class = "type-signature" > < / span > getTimeSignature< span class = "signature" > ()< / span > < span class = "type-signature" > → {number}< / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > return the time signature as just the numerator
2014-06-19 17:38:21 +00:00
over 4 is assumed.
2014-06-22 02:56:51 +00:00
for example 4/4 would return 4 and 6/8 would return 3< / p >
2014-06-22 02:02:41 +00:00
< / div >
2014-06-22 02:56:51 +00:00
< dl class = "details" >
2014-06-22 02:02:41 +00:00
2014-06-22 02:56:51 +00:00
2014-06-22 02:02:41 +00:00
2014-06-22 02:56:51 +00:00
2014-06-22 02:02:41 +00:00
2014-06-22 02:56:51 +00:00
2014-06-22 02:02:41 +00:00
2014-06-22 02:56:51 +00:00
2014-06-22 02:02:41 +00:00
2014-06-22 02:56:51 +00:00
2014-06-22 02:02:41 +00:00
2014-06-22 02:56:51 +00:00
2014-06-22 02:02:41 +00:00
2014-06-22 02:56:51 +00:00
2014-06-22 02:02:41 +00:00
2014-06-22 02:56:51 +00:00
2014-06-22 02:02:41 +00:00
2014-06-22 02:56:51 +00:00
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-06-23 17:38:55 +00:00
< a href = "Transport.js.html" > core/Transport.js< / a > , < a href = "Transport.js.html#sunlight-1-line-554" > line 554< / a >
2014-06-22 02:56:51 +00:00
< / li > < / ul > < / dd >
2014-06-22 02:02:41 +00:00
2014-06-22 02:56:51 +00:00
2014-06-22 02:02:41 +00:00
2014-06-22 02:56:51 +00:00
2014-06-22 02:02:41 +00:00
2014-06-22 02:56:51 +00:00
< / dl >
2014-06-22 02:02:41 +00:00
2014-06-22 02:56:51 +00:00
2014-06-22 02:02:41 +00:00
2014-06-22 02:56:51 +00:00
2014-06-22 02:02:41 +00:00
2014-06-22 02:56:51 +00:00
< h5 > Returns:< / h5 >
2014-06-22 02:15:54 +00:00
2014-06-22 02:02:41 +00:00
2014-06-22 02:56:51 +00:00
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > number< / span >
2014-06-22 02:02:41 +00:00
2014-06-22 02:56:51 +00:00
< / dd >
< / dl >
2014-06-22 02:02:41 +00:00
2014-06-22 02:56:51 +00:00
< / dd >
2014-06-22 02:02:41 +00:00
2014-06-22 02:56:51 +00:00
2014-06-22 02:02:41 +00:00
2014-06-22 02:56:51 +00:00
< dt >
< h4 class = "name" id = "getTransportTime" > < span class = "type-signature" > < / span > getTransportTime< span class = "signature" > ()< / span > < span class = "type-signature" > → {string}< / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > get the transport time< / p >
< / div >
2014-06-22 02:02:41 +00:00
2014-06-22 02:56:51 +00:00
2014-06-22 02:02:41 +00:00
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-06-23 17:38:55 +00:00
< a href = "Transport.js.html" > core/Transport.js< / a > , < a href = "Transport.js.html#sunlight-1-line-420" > line 420< / a >
2014-06-22 02:02:41 +00:00
< / li > < / ul > < / dd >
< / dl >
2014-06-22 02:15:54 +00:00
< h5 > Returns:< / h5 >
< div class = "param-desc" >
2014-06-22 02:56:51 +00:00
< p > in transportTime format (measures:beats:sixteenths)< / p >
2014-06-22 02:15:54 +00:00
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
2014-06-22 02:56:51 +00:00
< span class = "param-type" > string< / span >
2014-06-22 02:15:54 +00:00
< / dd >
< / dl >
2014-06-22 02:02:41 +00:00
< / dd >
< dt >
2014-06-22 02:56:51 +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-22 02:02:41 +00:00
< / dt >
< dd >
< div class = "description" >
2014-06-22 02:56:51 +00:00
< p > interpolate the input value (0-1) to be between outputMin and outputMax< / 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 >
2014-06-22 02:15:54 +00:00
< tr >
2014-06-22 02:56:51 +00:00
< td class = "name" > < code > input< / code > < / td >
2014-06-22 02:15:54 +00:00
< td class = "type" >
2014-06-22 02:56:51 +00:00
< span class = "param-type" > number< / span >
2014-06-22 02:15:54 +00:00
< / td >
< td class = "description last" > < / td >
< / tr >
2014-06-22 02:02:41 +00:00
< tr >
2014-06-22 02:56:51 +00:00
< td class = "name" > < code > outputMin< / code > < / td >
2014-06-22 02:02:41 +00:00
< td class = "type" >
2014-06-22 02:56:51 +00:00
< span class = "param-type" > number< / span >
2014-06-22 02:02:41 +00:00
< / td >
< td class = "description last" > < / td >
< / tr >
2014-06-22 02:15:54 +00:00
< tr >
2014-06-22 02:56:51 +00:00
< td class = "name" > < code > outputMax< / code > < / td >
2014-06-22 02:15:54 +00:00
< td class = "type" >
2014-06-22 02:56:51 +00:00
< span class = "param-type" > number< / span >
2014-06-22 02:15:54 +00:00
< / td >
2014-06-22 02:56:51 +00:00
< td class = "description last" > < / td >
2014-06-22 02:15:54 +00:00
< / tr >
2014-06-22 02:02:41 +00:00
< / tbody >
< / table >
< dl class = "details" >
2014-06-22 02:56:51 +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-22 02:02:41 +00:00
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-06-23 18:52:33 +00:00
< a href = "Tone.js.html" > core/Tone.js< / a > , < a href = "Tone.js.html#sunlight-1-line-246" > line 246< / a >
2014-06-22 02:02:41 +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-22 02:02:41 +00:00
< / dd >
< dt >
2014-06-22 02:56:51 +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-22 02:02:41 +00:00
< / 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 >
2014-06-22 02:56:51 +00:00
< td class = "name" > < code > gain< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
< td class = "description last" > < p > (0-1)< / p > < / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
< a href = "Tone.html#logScale" > Tone#logScale< / a >
< / li > < / dd >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-06-23 18:52:33 +00:00
< a href = "Tone.js.html" > core/Tone.js< / a > , < a href = "Tone.js.html#sunlight-1-line-209" > line 209< / a >
2014-06-22 02:56:51 +00:00
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< div class = "param-desc" >
< p > gain (decibel scale but betwee 0-1)< / p >
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > number< / span >
< / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "noGC" > < span class = "type-signature" > < / span > noGC< span class = "signature" > ()< / span > < span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > makes a connection to ensure that the node will not be garbage collected
until 'dispose' is explicitly called< / p >
< p > use carefully. circumvents JS and WebAudio's normal Garbage Collection behavior< / p >
< / div >
< dl class = "details" >
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
< a href = "Tone.html#noGC" > Tone#noGC< / a >
< / li > < / dd >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
< a href = "Master.js.html" > core/Master.js< / a > , < a href = "Master.js.html#sunlight-1-line-95" > line 95< / a >
< / 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" >
< p > normalize the input to 0-1 from between inputMin to inputMax< / p >
< / div >
< h5 > Parameters:< / h5 >
< table class = "params table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > input< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
< td class = "description last" > < / td >
< / tr >
< tr >
< td class = "name" > < code > inputMin< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
< td class = "description last" > < / td >
< / tr >
< tr >
< td class = "name" > < code > inputMax< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
< td class = "description last" > < / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
< a href = "Tone.html#normalize" > Tone#normalize< / a >
< / li > < / dd >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-06-23 18:52:33 +00:00
< a href = "Tone.js.html" > core/Tone.js< / a > , < a href = "Tone.js.html#sunlight-1-line-257" > line 257< / a >
2014-06-22 02:56:51 +00:00
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > number< / span >
< / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "notationToSeconds" > < span class = "type-signature" > < / span > notationToSeconds< span class = "signature" > (notation, < span class = "optional" > bpm< / span > , < span class = "optional" > timeSignature< / span > )< / span > < span class = "type-signature" > → {number}< / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > convert notation format strings to seconds< / p >
< / div >
< h5 > Parameters:< / h5 >
< table class = "params table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th > Argument< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > notation< / code > < / td >
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
< td class = "attributes" >
< / td >
< td class = "description last" > < / td >
< / tr >
< tr >
< td class = "name" > < code > bpm< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
< td class = "attributes" >
< 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-23 18:52:33 +00:00
< a href = "Transport.js.html" > core/Transport.js< / a > , < a href = "Transport.js.html#sunlight-1-line-729" > line 729< / a >
2014-06-22 02:56:51 +00:00
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > number< / span >
< / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "now" > < span class = "type-signature" > < / span > now< span class = "signature" > ()< / span > < span class = "type-signature" > → {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-23 18:52:33 +00:00
< a href = "Tone.js.html" > core/Tone.js< / a > , < a href = "Tone.js.html#sunlight-1-line-284" > line 284< / a >
2014-06-22 02:56:51 +00:00
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< div class = "param-desc" >
< p > the currentTime from the AudioContext< / p >
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > number< / span >
< / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "pause" > < span class = "type-signature" > < / span > pause< span class = "signature" > (time)< / span > < span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > pause the transport and all sources synced to the transport< / 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 = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-06-23 17:38:55 +00:00
< a href = "Transport.js.html" > core/Transport.js< / a > , < a href = "Transport.js.html#sunlight-1-line-489" > line 489< / a >
2014-06-22 02:56:51 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "receive" > < span class = "type-signature" > < / span > receive< span class = "signature" > (channelName)< / span > < span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > recieve the input from the desired channelName to the input gain of 'this' node.< / p >
< / div >
< h5 > Parameters:< / h5 >
< table class = "params table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > channelName< / code > < / td >
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
< td class = "description last" > < / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
< a href = "Tone.html#receive" > Tone#receive< / a >
< / li > < / dd >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
< a href = "Bus.js.html" > core/Bus.js< / a > , < a href = "Bus.js.html#sunlight-1-line-38" > line 38< / a >
< / 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" >
< p > convert a sample count to seconds< / p >
< / div >
< h5 > Parameters:< / h5 >
< table class = "params table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > samples< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
< td class = "description last" > < / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
< a href = "Tone.html#samplesToSeconds" > Tone#samplesToSeconds< / a >
< / li > < / dd >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-06-23 18:52:33 +00:00
< a href = "Tone.js.html" > core/Tone.js< / a > , < a href = "Tone.js.html#sunlight-1-line-293" > line 293< / a >
2014-06-22 02:56:51 +00:00
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > number< / span >
< / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "secondsToFrequency" > < span class = "type-signature" > < / span > secondsToFrequency< span class = "signature" > (seconds)< / span > < span class = "type-signature" > → {number}< / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > convert a number in seconds to a frequency< / p >
< / div >
< h5 > Parameters:< / h5 >
< table class = "params table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > seconds< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
< td class = "description last" > < / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
< a href = "Tone.html#secondsToFrequency" > Tone#secondsToFrequency< / a >
< / li > < / dd >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-06-23 18:52:33 +00:00
< a href = "Tone.js.html" > core/Tone.js< / a > , < a href = "Tone.js.html#sunlight-1-line-354" > line 354< / a >
2014-06-22 02:56:51 +00:00
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > number< / span >
< / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "send" > < span class = "type-signature" > < / span > send< span class = "signature" > (channelName, amount)< / span > < span class = "type-signature" > → {GainNode}< / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > send signal to a channel name< / p >
< / div >
< h5 > Parameters:< / h5 >
< table class = "params table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > channelName< / code > < / td >
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
< td class = "description last" > < / td >
< / tr >
< tr >
< td class = "name" > < code > amount< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
< td class = "description last" > < / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
< a href = "Tone.html#send" > Tone#send< / a >
< / li > < / dd >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
< a href = "Bus.js.html" > core/Bus.js< / a > , < a href = "Bus.js.html#sunlight-1-line-23" > line 23< / a >
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > GainNode< / span >
< / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "setBpm" > < span class = "type-signature" > < / span > setBpm< span class = "signature" > (bpm, < span class = "optional" > rampTime< / span > )< / span > < span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > set the BPM
optionally ramp to the bpm over some time< / 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 > bpm< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
< td class = "attributes" >
< / td >
< td class = "description last" > < / td >
< / tr >
< tr >
< td class = "name" > < code > rampTime< / code > < / td >
< td class = "type" >
< span class = "param-type" > Tone.Time< / span >
< / td >
< td class = "attributes" >
< 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-23 17:38:55 +00:00
< a href = "Transport.js.html" > core/Transport.js< / a > , < a href = "Transport.js.html#sunlight-1-line-509" > line 509< / a >
2014-06-22 02:56:51 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "setInterval" > < span class = "type-signature" > < / span > setInterval< span class = "signature" > (callback, interval, ctx)< / span > < span class = "type-signature" > → {number}< / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > intervals are recurring events< / 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 > callback< / code > < / td >
< td class = "type" >
< span class = "param-type" > function< / span >
< / td >
< td class = "description last" > < / td >
< / tr >
< tr >
< td class = "name" > < code > interval< / code > < / td >
< td class = "type" >
< span class = "param-type" > Tone.Time< / span >
< / td >
< td class = "description last" > < / td >
< / tr >
< tr >
< td class = "name" > < code > ctx< / code > < / td >
< td class = "type" >
< span class = "param-type" > Object< / span >
< / td >
< td class = "description last" > < p > the context the function is invoked in< / p > < / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-06-23 17:38:55 +00:00
< a href = "Transport.js.html" > core/Transport.js< / a > , < a href = "Transport.js.html#sunlight-1-line-259" > line 259< / a >
2014-06-22 02:56:51 +00:00
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< div class = "param-desc" >
< p > the id of the interval< / p >
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > number< / span >
< / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "setLoopEnd" > < span class = "type-signature" > < / span > setLoopEnd< span class = "signature" > (endPosition)< / span > < span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > set the loop start position< / 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 > endPosition< / 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-23 17:38:55 +00:00
< a href = "Transport.js.html" > core/Transport.js< / a > , < a href = "Transport.js.html#sunlight-1-line-572" > line 572< / a >
2014-06-22 02:56:51 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "setLoopPoint" > < span class = "type-signature" > < / span > setLoopPoint< span class = "signature" > (startPosition, endPosition)< / span > < span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > shorthand loop setting< / 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 > startPosition< / code > < / td >
< td class = "type" >
< span class = "param-type" > Tone.Time< / span >
< / td >
< td class = "description last" > < / td >
< / tr >
< tr >
< td class = "name" > < code > endPosition< / 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-23 17:38:55 +00:00
< a href = "Transport.js.html" > core/Transport.js< / a > , < a href = "Transport.js.html#sunlight-1-line-581" > line 581< / a >
2014-06-22 02:56:51 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "setLoopStart" > < span class = "type-signature" > < / span > setLoopStart< span class = "signature" > (startPosition)< / span > < span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > set the loop start position< / 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 > startPosition< / 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-23 17:38:55 +00:00
< a href = "Transport.js.html" > core/Transport.js< / a > , < a href = "Transport.js.html#sunlight-1-line-563" > line 563< / a >
2014-06-22 02:56:51 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "setTimeline" > < span class = "type-signature" > < / span > setTimeline< span class = "signature" > (callback, timeout, ctx)< / span > < span class = "type-signature" > → {number}< / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > Timeline events are synced to the transportTimeline of the Transport
Unlike Timeout, Timeline events will restart after the
Transport has been stopped and restarted.< / 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 > callback< / code > < / td >
< td class = "type" >
< span class = "param-type" > function< / span >
< / td >
< td class = "description last" > < / td >
< / tr >
< tr >
< td class = "name" > < code > timeout< / code > < / td >
< td class = "type" >
< span class = "param-type" > Tome.Time< / span >
< / td >
< td class = "description last" > < / td >
< / tr >
< tr >
< td class = "name" > < code > ctx< / code > < / td >
< td class = "type" >
< span class = "param-type" > Object< / span >
< / td >
< td class = "description last" > < p > the context in which the funtion is called< / p > < / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-06-23 17:38:55 +00:00
< a href = "Transport.js.html" > core/Transport.js< / a > , < a href = "Transport.js.html#sunlight-1-line-357" > line 357< / a >
2014-06-22 02:56:51 +00:00
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< div class = "param-desc" >
< p > the id for clearing the transportTimeline event< / p >
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > number< / span >
< / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "setTimeout" > < span class = "type-signature" > < / span > setTimeout< span class = "signature" > (callback, time, ctx)< / span > < span class = "type-signature" > → {number}< / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > set a timeout to occur after time from now< / 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 > callback< / code > < / td >
< td class = "type" >
< span class = "param-type" > function< / 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" > < / td >
< / tr >
< tr >
< td class = "name" > < code > ctx< / code > < / td >
< td class = "type" >
< span class = "param-type" > Object< / span >
< / td >
< td class = "description last" > < p > the context to invoke the callback in< / p > < / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-06-23 17:38:55 +00:00
< a href = "Transport.js.html" > core/Transport.js< / a > , < a href = "Transport.js.html#sunlight-1-line-301" > line 301< / a >
2014-06-22 02:56:51 +00:00
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< div class = "param-desc" >
< p > the id of the timeout for clearing timeouts< / p >
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > number< / span >
< / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "setTimeSignature" > < span class = "type-signature" > < / span > setTimeSignature< span class = "signature" > (numerator, < span class = "optional" > denominator< / span > )< / span > < span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > set the time signature< / 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 > numerator< / 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 > denominator< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
< td class = "attributes" >
< optional>< br >
< / td >
< td class = "description last" > < p > defaults to 4< / p > < / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-06-23 17:38:55 +00:00
< a href = "Transport.js.html" > core/Transport.js< / a > , < a href = "Transport.js.html#sunlight-1-line-542" > line 542< / a >
2014-06-22 02:56:51 +00:00
< / li > < / ul > < / dd >
< / dl >
< h5 > Example< / h5 >
< pre class = "sunlight-highlight-javascript" > this.setTimeSignature(4); //for 4/4
< / pre >
< / dd >
< dt >
< h4 class = "name" id = "setTransportTime" > < span class = "type-signature" > < / span > setTransportTime< span class = "signature" > (progress)< / span > < span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > set the transport time, jump to the position right away< / 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 > progress< / code > < / td >
2014-06-22 02:02:41 +00:00
< td class = "type" >
2014-06-22 02:56:51 +00:00
< span class = "param-type" > Tone.Time< / span >
2014-06-22 02:02:41 +00:00
< / td >
< td class = "description last" > < / td >
< / tr >
2014-06-22 02:56:51 +00:00
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-06-23 17:38:55 +00:00
< a href = "Transport.js.html" > core/Transport.js< / a > , < a href = "Transport.js.html#sunlight-1-line-434" > line 434< / a >
2014-06-22 02:56:51 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "start" > < span class = "type-signature" > < / span > start< span class = "signature" > (time)< / span > < span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > start the transport and all sources synced to the transport< / 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 >
2014-06-22 02:15:54 +00:00
< tr >
2014-06-22 02:56:51 +00:00
< td class = "name" > < code > time< / code > < / td >
2014-06-22 02:15:54 +00:00
< td class = "type" >
2014-06-22 02:56:51 +00:00
< span class = "param-type" > Tone.Time< / span >
2014-06-22 02:15:54 +00:00
< / td >
2014-06-22 02:56:51 +00:00
< td class = "description last" > < / td >
2014-06-22 02:15:54 +00:00
< / tr >
2014-06-22 02:02:41 +00:00
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-06-23 17:38:55 +00:00
< a href = "Transport.js.html" > core/Transport.js< / a > , < a href = "Transport.js.html#sunlight-1-line-448" > line 448< / a >
2014-06-22 02:02:41 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
2014-06-22 02:56:51 +00:00
< h4 class = "name" id = "stop" > < span class = "type-signature" > < / span > stop< span class = "signature" > (time)< / span > < span class = "type-signature" > < / span > < / h4 >
2014-06-22 02:02:41 +00:00
< / dt >
< dd >
< div class = "description" >
2014-06-22 02:56:51 +00:00
< p > stop the transport and all sources synced to the transport< / 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 >
2014-06-22 02:56:51 +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 = "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-23 17:38:55 +00:00
< a href = "Transport.js.html" > core/Transport.js< / a > , < a href = "Transport.js.html#sunlight-1-line-471" > line 471< / a >
2014-06-22 02:02:41 +00:00
< / li > < / ul > < / dd >
< / dl >
2014-06-22 02:15:54 +00:00
< / dd >
2014-06-22 02:02:41 +00:00
2014-06-22 02:15:54 +00:00
< dt >
2014-06-22 02:56:51 +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-22 02:15:54 +00:00
< / dt >
< dd >
< div class = "description" >
2014-06-22 02:56:51 +00:00
< p > convert a time to a frequency< / p >
2014-06-22 02:15:54 +00:00
< / div >
2014-06-22 02:02:41 +00:00
2014-06-22 02:15:54 +00:00
< h5 > Parameters:< / h5 >
2014-06-22 02:02:41 +00:00
2014-06-22 02:15:54 +00:00
< table class = "params table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
2014-06-22 02:02:41 +00:00
2014-06-22 02:15:54 +00:00
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > time< / code > < / td >
2014-06-22 02:56:51 +00:00
< 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 >
2014-06-23 18:52:33 +00:00
< a href = "Transport.js.html" > core/Transport.js< / a > , < a href = "Transport.js.html#sunlight-1-line-816" > line 816< / a >
2014-06-22 02:56:51 +00:00
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< div class = "param-desc" >
< p > the time in hertz< / p >
< / div >
2014-06-22 02:02:41 +00:00
2014-06-22 02:56:51 +00:00
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > number< / span >
2014-06-22 02:02:41 +00:00
2014-06-22 02:56:51 +00:00
< / dd >
< / dl >
2014-06-22 02:02:41 +00:00
2014-06-22 02:15:54 +00:00
2014-06-22 02:56:51 +00:00
< / dd >
< dt >
< h4 class = "name" id = "toMaster" > < span class = "type-signature" > < / span > toMaster< span class = "signature" > ()< / span > < span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > connect 'this' to the master output< / p >
< / div >
2014-06-22 02:15:54 +00:00
2014-06-22 02:02:41 +00:00
2014-06-22 02:56:51 +00:00
2014-06-22 02:02:41 +00:00
< dl class = "details" >
2014-06-22 02:56:51 +00:00
< 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-22 02:02:41 +00:00
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-06-22 02:56:51 +00:00
< a href = "Master.js.html" > core/Master.js< / a > , < a href = "Master.js.html#sunlight-1-line-66" > line 66< / a >
2014-06-22 02:02:41 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
2014-06-22 02:56:51 +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:56:51 +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:56:51 +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" >
2014-06-22 02:56:51 +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-22 02:02:41 +00:00
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-06-23 18:52:33 +00:00
< a href = "Tone.js.html" > core/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 >
2014-06-22 02:56:51 +00:00
< h5 > Returns:< / h5 >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > number< / span >
< / dd >
< / dl >
2014-06-22 02:02:41 +00:00
< / dd >
< dt >
2014-06-22 02:56:51 +00:00
< h4 class = "name" id = "toSeconds" > < span class = "type-signature" > < / span > toSeconds< span class = "signature" > (time, < span class = "optional" > now< / span > )< / span > < span class = "type-signature" > → {number}< / span > < / h4 >
2014-06-22 02:02:41 +00:00
< / dt >
< dd >
< div class = "description" >
2014-06-22 02:56:51 +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 >
2014-06-22 02:56:51 +00:00
< th > Argument< / th >
2014-06-22 02:02:41 +00:00
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > time< / code > < / td >
< td class = "type" >
< span class = "param-type" > Tone.Time< / span >
< / td >
2014-06-22 02:56:51 +00:00
< td class = "attributes" >
< / td >
2014-06-22 02:02:41 +00:00
< td class = "description last" > < / td >
< / tr >
2014-06-22 02:56:51 +00:00
< tr >
< td class = "name" > < code > now< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
< td class = "attributes" >
< optional>< br >
< / td >
< td class = "description last" > < p > if passed in, this number will be
used for all 'now' relative timings< / p > < / td >
< / tr >
2014-06-22 02:02:41 +00:00
< / tbody >
< / table >
< dl class = "details" >
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
2014-06-22 02:56:51 +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-23 18:52:33 +00:00
< a href = "Tone.js.html" > core/Tone.js< / a > , < a href = "Tone.js.html#sunlight-1-line-321" > line 321< / a >
2014-06-22 02:02:41 +00:00
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
2014-06-23 18:52:33 +00:00
< div class = "param-desc" >
< p > seconds in the same timescale as the AudioContext< / p >
< / div >
2014-06-22 02:02:41 +00:00
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > number< / span >
< / dd >
< / dl >
< / dd >
< dt >
2014-06-22 02:56:51 +00:00
< h4 class = "name" id = "toSeconds" > < span class = "type-signature" > < / span > toSeconds< span class = "signature" > (time, < span class = "optional" > now< / span > )< / span > < span class = "type-signature" > → {number}< / span > < / h4 >
2014-06-22 02:15:54 +00:00
< / dt >
< dd >
< div class = "description" >
2014-06-22 02:56:51 +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:15:54 +00:00
< / div >
2014-06-22 02:02:41 +00:00
2014-06-22 02:15:54 +00:00
< h5 > Parameters:< / h5 >
2014-06-22 02:02:41 +00:00
2014-06-22 02:15:54 +00:00
< table class = "params table table-striped" >
< thead >
< tr >
< th > Name< / th >
2014-06-22 02:02:41 +00:00
2014-06-22 02:15:54 +00:00
< th > Type< / th >
2014-06-22 02:02:41 +00:00
2014-06-22 02:15:54 +00:00
2014-06-22 02:56:51 +00:00
< th > Argument< / th >
2014-06-22 02:02:41 +00:00
2014-06-22 02:15:54 +00:00
2014-06-22 02:02:41 +00:00
2014-06-22 02:15:54 +00:00
< th class = "last" > Description< / th >
< / tr >
< / thead >
2014-06-22 02:02:41 +00:00
2014-06-22 02:15:54 +00:00
< tbody >
2014-06-22 02:02:41 +00:00
< 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" >
2014-06-22 02:56:51 +00:00
< span class = "param-type" > Tone.Time< / span >
< / td >
< td class = "attributes" >
< / td >
< td class = "description last" > < / td >
< / tr >
< tr >
< td class = "name" > < code > now< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
2014-06-22 02:02:41 +00:00
< / td >
2014-06-22 02:56:51 +00:00
< td class = "attributes" >
< optional>< br >
< / td >
2014-06-22 02:02:41 +00:00
2014-06-22 02:56:51 +00:00
< td class = "description last" > < p > if passed in, this number will be
used for all 'now' relative timings< / p > < / td >
2014-06-22 02:02:41 +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:56:51 +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-23 18:52:33 +00:00
< a href = "Transport.js.html" > core/Transport.js< / a > , < a href = "Transport.js.html#sunlight-1-line-838" > line 838< / 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:56:51 +00:00
< h4 class = "name" id = "toTicks" > < span class = "type-signature" > < / span > toTicks< 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:56:51 +00:00
< p > turns the time into< / 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 = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-06-23 17:38:55 +00:00
< a href = "Transport.js.html" > core/Transport.js< / a > , < a href = "Transport.js.html#sunlight-1-line-406" > line 406< / 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:56:51 +00:00
< h4 class = "name" id = "unsync" > < span class = "type-signature" > < / span > unsync< span class = "signature" > (source)< / span > < span class = "type-signature" > < / span > < / h4 >
2014-06-22 02:02:41 +00:00
< / dt >
< dd >
< div class = "description" >
2014-06-22 02:56:51 +00:00
< p > remove the source from the list of Synced Sources< / 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 >
2014-06-22 02:56:51 +00:00
< td class = "name" > < code > source< / code > < / td >
2014-06-22 02:02:41 +00:00
< td class = "type" >
2014-06-22 02:56:51 +00:00
< span class = "param-type" > < a href = "Tone.Source.html" > Tone.Source< / a > < / span >
2014-06-22 02:02:41 +00:00
< / td >
2014-06-22 02:56:51 +00:00
< td class = "description last" > < p > [description]< / p > < / td >
2014-06-22 02:02:41 +00:00
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-06-23 17:38:55 +00:00
< a href = "Transport.js.html" > core/Transport.js< / a > , < a href = "Transport.js.html#sunlight-1-line-603" > line 603< / a >
2014-06-22 02:02:41 +00:00
< / li > < / ul > < / dd >
< / dl >
2014-06-22 02:56:51 +00:00
< / dd >
2014-06-22 02:02:41 +00:00
2014-06-22 02:56:51 +00:00
< / dl >
2014-06-22 02:02:41 +00:00
2014-06-22 02:56:51 +00:00
2014-06-22 02:02:41 +00:00
2014-06-22 02:56:51 +00:00
< / article >
2014-06-22 02:02:41 +00:00
2014-06-22 02:56:51 +00:00
< / section >
2014-06-22 02:02:41 +00:00
2014-06-22 02:56:51 +00:00
< / div >
< div class = "clearfix" > < / div >
< footer >
< span class = "copyright" >
Tone No Tone Copyright © 2014.
< / span >
< br / >
< span class = "jsdoc-message" >
2014-06-23 18:52:33 +00:00
Documentation generated on Mon Jun 23 2014 14:51:36 GMT-0400 (EDT).
2014-06-22 02:56:51 +00:00
< / span >
< / footer >
< / div >
< div class = "span3" >
< div id = "toc" > < / div >
< / div >
< br clear = "both" >
< / div >
< / div >
< script src = "scripts/sunlight.js" > < / script >
< script src = "scripts/sunlight.javascript.js" > < / script >
< script src = "scripts/sunlight-plugin.doclinks.js" > < / script >
< script src = "scripts/sunlight-plugin.linenumbers.js" > < / script >
< script src = "scripts/sunlight-plugin.menu.js" > < / script >
< script src = "scripts/jquery.min.js" > < / script >
< script src = "scripts/jquery.scrollTo.js" > < / script >
< script src = "scripts/jquery.localScroll.js" > < / script >
< script src = "scripts/bootstrap-dropdown.js" > < / script >
< script src = "scripts/toc.js" > < / script >
< script > Sunlight . highlightAll ( { lineNumbers : true , showMenu : true , enableDoclinks : true } ) ; < / script >
< script >
$( function () {
$( "#toc" ).toc( {
selectors : "h1,h2,h3,h4",
showAndHide : false,
scrollTo : 60
} );
$( "#toc>ul" ).addClass( "nav nav-pills nav-stacked" );
$( "#main span[id^='toc']" ).addClass( "toc-shim" );
} );
< / script >
2014-06-23 17:38:55 +00:00
< script >
$( function () {
$('#main').localScroll({
offset: { top: 56 } //offset by the height of your header (give or take a few px, see what works for you)
});
$( "dt h4.name" ).each( function () {
var $this = $( this );
var icon = $( "< i / > " ).addClass( "icon-plus-sign" ).addClass( "pull-right" ).addClass( "icon-white" );
var dt = $this.parents( "dt" );
var children = dt.next( "dd" );
$this.append( icon ).css( {cursor : "pointer"} );
$this.addClass( "member-collapsed" ).addClass( "member" );
children.hide();
$this.toggle( function () {
icon.addClass( "icon-minus-sign" ).removeClass( "icon-plus-sign" ).removeClass( "icon-white" );
$this.addClass( "member-open" ).removeClass( "member-collapsed" );
children.slideDown();
}, function () {
icon.addClass( "icon-plus-sign" ).removeClass( "icon-minus-sign" ).addClass( "icon-white" );
$this.addClass( "member-collapsed" ).removeClass( "member-open" );
children.slideUp();
} );
} );
} );
< / script >
2014-06-22 02:56:51 +00:00
< / body >
2014-06-18 21:39:05 +00:00
< / html >