Class: Scale

Extends

• Tone

Members

<private> _inputMax :number

Type:

• number

Source:

• Tone.js, line 736

<private> _inputMin :number

Type:

• number

Source:

• Tone.js, line 733

<private> _outputMax :number

Type:

• number

Source:

• Tone.js, line 742

<private> _outputMin :number

Type:

• number

Source:

• Tone.js, line 739

<private> _plusInput :Tone.Add

Type:

• Tone.Add

Source:

• Tone.js, line 747

<private> _plusOutput :Tone.Add

Type:

• Tone.Add

Source:

• Tone.js, line 753

<private> _scale :Tone.Multiply

Type:

• Tone.Multiply

Source:

• Tone.js, line 750

isFrequency

true if the input is in the format number+hz i.e.: 10hz

Inherited From:

• Tone#isFrequency

Source:

• Tone.js, line 1700

isNotation

tests if a string is musical notation i.e.: 4n = quarter note 2m = two measures 8t = eighth-note triplet

Inherited From:

• Tone#isNotation

Source:

• Tone.js, line 1672

isTransportTime

tests if a string is transportTime i.e. : 1:2:0 = 1 measure + two quarter notes + 0 sixteenth notes

Inherited From:

• Tone#isTransportTime

Source:

• Tone.js, line 1686

Methods

<private> _setScalingParameters()

set the scaling parameters

Source:

• Tone.js, line 769

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 1715

Returns:

Type

number

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 2558

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 2543

Returns:

Type

GainNode

setInputMax(val)

set the input max value

Parameters:

Name	Type	Description
val	number

Source:

• Tone.js, line 789

setInputMin(val)

set the input min value

Parameters:

Name	Type	Description
val	number

Source:

• Tone.js, line 780

setOutputMax(val)

set the output max value

Parameters:

Name	Type	Description
val	number

Source:

• Tone.js, line 807

setOutputMin(val)

set the output min value

Parameters:

Name	Type	Description
val	number

Source:

• Tone.js, line 798

toFrequency(time) → {number}

convert a time to a frequency

Parameters:

Name	Type	Description
time	Tone.Time

Inherited From:

• Tone#toFrequency

Source:

• Tone.js, line 1796

Returns:

the time in hertz

Type

number

toSeconds(time, bpm, timeSignature)

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
bpm	number	<optional>
timeSignature	number	<optional>

Inherited From:

• Tone#toSeconds

Source:

• Tone.js, line 1816

toTransportTime(seconds, bpm, timeSignature) → {string}

Convert seconds to the closest transportTime in the form measures:quarters:sixteenths

Parameters:

Name	Type	Argument	Description
seconds	Tone.Time
bpm	number	<optional>
timeSignature	number	<optional>

Inherited From:

• Tone#toTransportTime

Source:

• Tone.js, line 1777

Returns:

Type

string

transportTimeToSeconds(transportTime, bpm, timeSignature) → {number}

convert transportTime into seconds i.e.: 4:2:3 == 4 measures + 2 quarters + 3 sixteenths

Parameters:

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

Inherited From:

• Tone#transportTimeToSeconds

Source:

• Tone.js, line 1747

Returns:

seconds

Type

number