Source < Options >

Base class for sources. start/stop of this.context.transport.

Hierarchy

Constructor

new Source (
options:SourceOptions
) => Source

Properties

blockTime #

readonly Seconds

The number of seconds of 1 processing block (128 samples)

channelCount #

number

channelCount is the number of channels used when up-mixing and down-mixing connections to any inputs to the node. The default value is 2 except for specific nodes where its value is specially determined.

channelCountMode #

ChannelCountMode

channelCountMode determines how channels will be counted when up-mixing and down-mixing connections to any inputs to the node. The default value is "max". This attribute has no effect for nodes with no inputs.

  • "max" - computedNumberOfChannels is the maximum of the number of channels of all connections to an input. In this mode channelCount is ignored.
  • "clamped-max" - computedNumberOfChannels is determined as for "max" and then clamped to a maximum value of the given channelCount.
  • "explicit" - computedNumberOfChannels is the exact value as specified by the channelCount.

channelInterpretation #

ChannelInterpretation

channelInterpretation determines how individual channels will be treated when up-mixing and down-mixing connections to any inputs to the node. The default value is "speakers".

context #

BaseContext

The context belonging to the node.

debug #

boolean

Set this debug flag to log all events that happen in this class.

disposed #

readonly boolean

Indicates if the instance was disposed. 'Disposing' an instance means that all of the Web Audio nodes that were created for the instance are disconnected and freed for garbage collection.

input #

undefined

Sources have no inputs

mute #

boolean

Mute the output.


import { Oscillator } from "tone";
const osc = new Oscillator().toDestination().start();
// mute the output
osc.mute = true;

name #

string

The name of the class

numberOfInputs #

readonly number

The number of inputs feeding into the AudioNode. For source nodes, this will be 0.

numberOfOutputs #

readonly number

The number of outputs of the AudioNode.

onstop #

onStopCallback

The callback to invoke when the source is stopped.

output #

OutputNode

The output note

sampleTime #

readonly Seconds

The duration in seconds of one sample.

state #

readonly BasicPlaybackState

Returns the playback state of the source, either "started" or "stopped".


import { Player } from "tone";
const player = new Player("https://tonejs.github.io/examples/audio/FWDL.mp3", () => {
	player.start();
	console.log(player.state);
}).toDestination();

static version #

string

The version number semver

volume #

Param<"decibels" >

The volume of the output in decibels.


import { PWMOscillator } from "tone";
const source = new PWMOscillator().toDestination();
source.volume.value = -6;

Methods

chain #

Connect the output of this node to the rest of the nodes in series.


import { Destination, Filter, Oscillator, Volume } from "tone";
const osc = new Oscillator().start();
const filter = new Filter();
const volume = new Volume(-8);
// connect a node to the filter, volume and then to the master output
osc.chain(filter, volume, Destination);
chain (
...nodes:InputNode []
) => this

connect #

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

connect (
destination:InputNode ,

The output to connect to

outputNum= 0:number ,

The output to connect from

inputNum= 0:number

The input to connect to

) => this

disconnect #

disconnect the output

disconnect (
destination?:InputNode ,
outputNum= 0:number ,
inputNum= 0:number
) => this

dispose #

Clean up.

dispose ( ) => this

fan #

connect the output of this node to the rest of the nodes in parallel.

fan (
...nodes:InputNode []
) => this

get #

Get the object's attributes.


import { Oscillator } from "tone";
const osc = new Oscillator();
console.log(osc.get());
// returns {"type" : "sine", "frequency" : 440, ...etc}
get ( ) => Options

static getDefaults #

Returns all of the default options belonging to the class.

getDefaults ( ) => SourceOptions

immediate #

Return the current time of the Context clock without any lookAhead.

immediate ( ) => Seconds

now #

Return the current time of the Context clock plus the lookAhead.

now ( ) => Seconds

restart #

restart (
time:Time ,
offset?:Time ,
duration?:Time
) => this

set #

Set multiple properties at once with an object.


import { Filter } from "tone";
const filter = new Filter();
// set values using an object
filter.set({
	frequency: 300,
	type: "highpass"
});
set (
props:RecursivePartial<Options >
) => this

start #

Start the source at the specified time. If no time is given, start the source now.


import { Oscillator } from "tone";
const source = new Oscillator().toDestination();
source.start("+0.5"); // starts the source 0.5 seconds from now
start (
time?:Time ,

When the source should be started.

offset?:Time ,
duration?:Time
) => this

stop #

Stop the source at the specified time. If no time is given, stop the source now.


import { Oscillator } from "tone";
const source = new Oscillator().toDestination();
source.start();
source.stop("+0.5"); // stops the source 0.5 seconds from now
stop (
time?:Time

When the source should be stopped.

) => this

sync #

Sync the source to the Transport so that all subsequent calls to start and stop are synced to the TransportTime instead of the AudioContext time.


import { Oscillator, Transport } from "tone";
const osc = new Oscillator().toDestination();
// sync the source so that it plays between 0 and 0.3 on the Transport's timeline
osc.sync().start(0).stop(0.3);
// start the transport.
Transport.start();
// set it to loop once a second
Transport.loop = true;
Transport.loopEnd = 1;
sync ( ) => this

toDestination #

Connect the output to the context's destination node.

toDestination ( ) => this

toFrequency #

Convert the input to a frequency number

toFrequency (
freq:Frequency
) => Hertz

toMaster # DEPRECATED

Connect the output to the context's destination node. See toDestination

toMaster ( ) => this

toSeconds #

Convert the incoming time to seconds

toSeconds (
time?:Time
) => Seconds

toString #

Convert the class to a string


import { Oscillator } from "tone";
const osc = new Oscillator();
console.log(osc.toString());
toString ( ) => string

toTicks #

Convert the input time into ticks

toTicks (
time?:Time | TimeClass
) => Ticks

unsync #

Unsync the source to the Transport. See Source.sync

unsync ( ) => this