Class: Oscillator

Extends

• Tone.Source

Members

frequency :Tone.Signal

the frequency control signal

Type:

• Tone.Signal

Source:

• Tone.js, line 2267

input :GainNode

default input of the ToneNode

Type:

• GainNode

Inherited From:

• Tone#input

Source:

• Tone.js, line 110

oscillator :OscillatorNode

the main oscillator

Type:

• OscillatorNode

Source:

• Tone.js, line 2262

output :GainNode

unlike most ToneNodes, Sources only have an output and no input

Type:

• GainNode

Inherited From:

• Tone.Source#output

Source:

• Tone.js, line 2162

state :Tone.Source.State

Type:

• Tone.Source.State

Inherited From:

• Tone.Source#state

Source:

• Tone.js, line 2167

Methods

chain()

connect together all of the arguments in series

Parameters:

Type	Argument	Description
AudioParam | Tone	<repeatable>

Inherited From:

• Tone#chain

Source:

• Tone.js, line 167

connect(unit)

connect the output of a ToneNode to an AudioParam, AudioNode, or ToneNode

Parameters:

Name	Type	Description
unit	Tone | AudioParam | AudioNode

Inherited From:

• Tone#connect

Source:

• Tone.js, line 152

dbToGain(db) → {number}

convert db scale to gain scale (0-1)

Parameters:

Name	Type	Description
db	number

Inherited From:

• Tone#dbToGain

Source:

• Tone.js, line 226

Returns:

Type

number

defaultArg(given, fallback) → {*}

if a the given is undefined, use the fallback

Parameters:

Name	Type	Description
given	*
fallback	*

Inherited From:

• Tone#defaultArg

Source:

• Tone.js, line 189

Returns:

Type

*

disconnect()

disconnect the output

Inherited From:

• Tone#disconnect

Source:

• Tone.js, line 159

dispose()

dispose and disconnect

Source:

• Tone.js, line 2382

equalPowerScale(percent) → {number}

equal power gain scale good for cross-fading

Parameters:

Name	Type	Description
percent	number	(0-1)

Inherited From:

• Tone#equalPowerScale

Source:

• Tone.js, line 200

Returns:

output gain (0-1)

Type

number

expScale(gain) → {number}

Parameters:

Name	Type	Description
gain	number	(0-1)

Inherited From:

• Tone#expScale

Source:

• Tone.js, line 217

Returns:

gain (decibel scale but betwee 0-1)

Type

number

frequencyToSeconds(freq) → {number}

convert a frequency into seconds accepts both numbers and strings i.e. 10hz or 10 both equal .1

Parameters:

Name	Type	Description
freq	number | string

Inherited From:

• Tone#frequencyToSeconds

Source:

• Tone.js, line 345

Returns:

Type

number

gainToDb(gain) → {number}

convert gain scale to decibels

Parameters:

Name	Type	Description
gain	number	(0-1)

Inherited From:

• Tone#gainToDb

Source:

• Tone.js, line 235

Returns:

Type

number

interpolate(input, outputMin, outputMax) → {number}

interpolate the input value (0-1) to be between outputMin and outputMax

Parameters:

Name	Type	Description
input	number
outputMin	number
outputMax	number

Inherited From:

• Tone#interpolate

Source:

• Tone.js, line 246

Returns:

Type

number

logScale(gain) → {number}

Parameters:

Name	Type	Description
gain	number	(0-1)

Inherited From:

• Tone#logScale

Source:

• Tone.js, line 209

Returns:

gain (decibel scale but betwee 0-1)

Type

number

noGC()

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

Inherited From:

• Tone#noGC

Source:

• Tone.js, line 483

normalize(input, inputMin, inputMax) → {number}

normalize the input to 0-1 from between inputMin to inputMax

Parameters:

Name	Type	Description
input	number
inputMin	number
inputMax	number

Inherited From:

• Tone#normalize

Source:

• Tone.js, line 257

Returns:

Type

number

notationToSeconds(notation, bpm, timeSignature) → {number}

convert notation format strings to seconds

Parameters:

Name	Type	Argument	Description
notation	string
bpm	number	<optional>
timeSignature	number	<optional>

Inherited From:

• Tone#notationToSeconds

Source:

• Tone.js, line 2004

Returns:

Type

number

now() → {number}

Inherited From:

• Tone#now

Source:

• Tone.js, line 284

Returns:

the currentTime from the AudioContext

Type

number

onended()

Source:

• Tone.js, line 2272

<virtual> pause(time)

Parameters:

Name	Type	Description
time	Tone.Time

Inherited From:

• Tone.Source#pause

Source:

• Tone.js, line 2189

receive(channelName)

recieve the input from the desired channelName to the input gain of 'this' node.

Parameters:

Name	Type	Description
channelName	string

Inherited From:

• Tone#receive

Source:

• Tone.js, line 3147

samplesToSeconds(samples) → {number}

convert a sample count to seconds

Parameters:

Name	Type	Description
samples	number

Inherited From:

• Tone#samplesToSeconds

Source:

• Tone.js, line 293

Returns:

Type

number

secondsToFrequency(seconds) → {number}

convert a number in seconds to a frequency

Parameters:

Name	Type	Description
seconds	number

Inherited From:

• Tone#secondsToFrequency

Source:

• Tone.js, line 354

Returns:

Type

number

send(channelName, amount) → {GainNode}

send signal to a channel name

Parameters:

Name	Type	Description
channelName	string
amount	number

Inherited From:

• Tone#send

Source:

• Tone.js, line 3132

Returns:

Type

GainNode

setFrequency(val, rampTime)

exponentially ramp the frequency of the oscillator over the rampTime

Parameters:

Name	Type	Argument	Description
val	Tone.Time
rampTime	Tone.Time	<optional>	when the oscillator will arrive at the frequency

Source:

• Tone.js, line 2353

setType(type)

set the oscillator type

Parameters:

Name	Type	Description
type	string	(sine|square|triangle|sawtooth)

Source:

• Tone.js, line 2366

setVolume(value, fadeTime)

Parameters:

Name	Type	Argument	Description
value	number
fadeTime	Tone.Time	<optional>	(optional) time it takes to reach the value

Inherited From:

• Tone.Source#setVolume

Source:

• Tone.js, line 2218

start(time)

start the oscillator

Parameters:

Name	Type	Description
time	Tone.Time

Source:

• Tone.js, line 2287

stop(time)

stop the oscillator

Parameters:

Name	Type	Argument	Description
time	Tone.Time	<optional>	(optional) timing parameter

Source:

• Tone.js, line 2311

sync()

Sync the oscillator to the transport

the current ratio between the oscillator and the Transport BPM is fixed and any change to the Transport BPM will change this oscillator in that same ratio

Transport start/pause/stop will also start/pause/stop the oscillator

Source:

• Tone.js, line 2329

toFrequency(time) → {number}

convert a time to a frequency

Parameters:

Name	Type	Description
time	Tone.Time

Inherited From:

• Tone#toFrequency

Source:

• Tone.js, line 2091

Returns:

the time in hertz

Type

number

toMaster()

connect 'this' to the master output

Inherited From:

• Tone#toMaster

Source:

• Tone.js, line 454

toSamples(time) → {number}

convert a time into samples

Parameters:

Name	Type	Description
time	Tone.time

Inherited From:

• Tone#toSamples

Source:

• Tone.js, line 303

Returns:

Type

number

toSeconds(time, now) → {number}

convert Tone.Time to seconds

this is a simplified version which only handles numbers and 'now' relative numbers. If the Transport is included this method is overridden to include many other features including notationTime, Frequency, and transportTime

Parameters:

Name	Type	Argument	Description
time	Tone.Time
now	number	<optional>	if passed in, this number will be used for all 'now' relative timings

Inherited From:

• Tone#toSeconds

Source:

• Tone.js, line 321

Returns:

seconds in the same timescale as the AudioContext

Type

number

toSeconds(time, now) → {number}

convert Tone.Time into seconds.

unlike the method which it overrides, this takes into account transporttime and musical notation

Parameters:

Name	Type	Argument	Description
time	Tone.Time
now	number	<optional>	if passed in, this number will be used for all 'now' relative timings

Inherited From:

• Tone#toSeconds

Source:

• Tone.js, line 2113

Returns:

Type

number

unsync()

unsync the oscillator from the Transport

Source:

• Tone.js, line 2340