Class Analyser

Readonly context

debug

Static version

blockTime

• get blockTime(): number

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

  Returns number

  Example

  console.log(Tone.Destination.blockTime);
  Copy

channelCount

• get 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.

  Returns number
• set channelCount(channelCount): void

• Parameters

  • channelCount: number

  Returns void

channelCountMode

• get 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.

  Returns ChannelCountMode
• set channelCountMode(channelCountMode): void

• Parameters

  • channelCountMode: ChannelCountMode

  Returns void

channelInterpretation

• get 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".

  Returns ChannelInterpretation
• set channelInterpretation(channelInterpretation): void

• Parameters

  • channelInterpretation: ChannelInterpretation

  Returns void

disposed

• get disposed(): 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.

  Returns boolean

numberOfInputs

• get numberOfInputs(): number

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

  Returns number

  Example

  const node = new Tone.Gain();
  console.log(node.numberOfInputs);
  Copy

numberOfOutputs

• get numberOfOutputs(): number

• The number of outputs of the AudioNode.

  Returns number

  Example

  const node = new Tone.Gain();
  console.log(node.numberOfOutputs);
  Copy

sampleTime

• get sampleTime(): number

• The duration in seconds of one sample.

  Returns number

chain

• chain(...nodes): this

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

  Parameters

  • Rest ...nodes: InputNode[]

  Returns this

  Example

  const player = new Tone.Player("https://tonejs.github.io/audio/drum-samples/handdrum-loop.mp3");
  player.autostart = true;
  const filter = new Tone.AutoFilter(4).start();
  const distortion = new Tone.Distortion(0.5);
  // connect the player to the filter, distortion and then to the master output
  player.chain(filter, distortion, Tone.Destination);
  Copy

connect

• connect(destination, outputNum?, inputNum?): this

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

  Parameters

  • destination: InputNode

    The output to connect to
  • outputNum: number = 0

    The output to connect from
  • inputNum: number = 0

    The input to connect to

  Returns this

disconnect

• disconnect(destination?, outputNum?, inputNum?): this

• disconnect the output

  Parameters

  • Optional destination: InputNode
  • outputNum: number = 0
  • inputNum: number = 0

  Returns this

fan

• fan(...nodes): this

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

  Parameters

  • Rest ...nodes: InputNode[]

  Returns this

  Example

  const player = new Tone.Player("https://tonejs.github.io/audio/drum-samples/conga-rhythm.mp3");
  player.autostart = true;
  const pitchShift = new Tone.PitchShift(4).toDestination();
  const filter = new Tone.Filter("G5").toDestination();
  // connect a node to the pitch shift and filter in parallel
  player.fan(pitchShift, filter);
  Copy

get

• get(): AnalyserOptions

• Get the object's attributes.

  Returns AnalyserOptions

  Example

  const osc = new Tone.Oscillator();
  console.log(osc.get());
  Copy

immediate

• immediate(): number

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

  Returns number

  Example

  setInterval(() => {
      console.log(Tone.immediate());
  }, 100);
  Copy

now

• now(): number

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

  Returns number

  Example

  setInterval(() => {
      console.log(Tone.now());
  }, 100);
  Copy

set

• set(props): this

• Set multiple properties at once with an object.

  Parameters

  • props: RecursivePartial<AnalyserOptions>

  Returns this

  Example

  const filter = new Tone.Filter().toDestination();
  // set values using an object
  filter.set({
      frequency: "C6",
      type: "highpass"
  });
  const player = new Tone.Player("https://tonejs.github.io/audio/berklee/Analogsynth_octaves_highmid.mp3").connect(filter);
  player.autostart = true;
  Copy

toDestination

• toDestination(): this

• Connect the output to the context's destination node.

  Returns this

  Example

  const osc = new Tone.Oscillator("C2").start();
  osc.toDestination();
  Copy

toFrequency

• toFrequency(freq): number

• Convert the input to a frequency number

  Parameters

  • freq: Unit.Frequency

  Returns number

  Example

  const gain = new Tone.Gain();
  console.log(gain.toFrequency("4n"));
  Copy

toMaster

• toMaster(): this

• Connect the output to the context's destination node.

  Returns this

  See

  toDestination

  Deprecated

toSeconds

• toSeconds(time?): number

• Convert the incoming time to seconds. This is calculated against the current TransportClass bpm

  Parameters

  • Optional time: Unit.Time

  Returns number

  Example

  const gain = new Tone.Gain();
  setInterval(() => console.log(gain.toSeconds("4n")), 100);
  // ramp the tempo to 60 bpm over 30 seconds
  Tone.getTransport().bpm.rampTo(60, 30);
  Copy

toString

• toString(): string

• Convert the class to a string

  Returns string

  Example

  const osc = new Tone.Oscillator();
  console.log(osc.toString());
  Copy

toTicks

• toTicks(time?): number

• Convert the input time into ticks

  Parameters

  • Optional time: Unit.Time | TimeClass<number, TimeBaseUnit>

  Returns number

  Example

  const gain = new Tone.Gain();
  console.log(gain.toTicks("4n"));
  Copy