Class Pattern<ValueType>

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

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

humanize

• get humanize(): boolean | Unit.Time

• Random variation +/-0.01s to the scheduled time. Or give it a time value which it will randomize by.

  Returns boolean | Unit.Time
• set humanize(variation): void

• Parameters

  • variation: boolean | Unit.Time

  Returns void

interval

• get interval(): Unit.Time

• The time between successive callbacks.

  Returns Unit.Time

  Example

  const loop = new Tone.Loop();
  loop.interval = "8n"; // loop every 8n
  Copy

• set interval(interval): void

• Parameters

  • interval: Unit.Time

  Returns void

iterations

• get iterations(): number

• The number of iterations of the loop. The default value is Infinity (loop forever).

  Returns number
• set iterations(iters): void

• Parameters

  • iters: number

  Returns void

mute

• get mute(): boolean

• Muting the Loop means that no callbacks are invoked.

  Returns boolean
• set mute(mute): void

• Parameters

  • mute: boolean

  Returns void

playbackRate

• get playbackRate(): number

• The playback rate of the loop. The normal playback rate is 1 (no change). A playbackRate of 2 would be twice as fast.

  Returns number
• set playbackRate(rate): void

• Parameters

  • rate: number

  Returns void

probability

• get probability(): number

• The probably of the callback being invoked.

  Returns number
• set probability(prob): void

• Parameters

  • prob: number

  Returns void

progress

• get progress(): number

• The progress of the loop as a value between 0-1. 0, when the loop is stopped or done iterating.

  Returns number

sampleTime

• get sampleTime(): number

• The duration in seconds of one sample.

  Returns number

state

• get state(): BasicPlaybackState

• The state of the Loop, either started or stopped.

  Returns BasicPlaybackState

cancel

• cancel(time?): this

• Cancel all scheduled events greater than or equal to the given time

  Parameters

  • Optional time: Unit.Time

    The time after which events will be cancel.

  Returns this

dispose

• dispose(): this

• Returns this

get

• get(): PatternOptions<ValueType>

• Get the object's attributes.

  Returns PatternOptions<ValueType>

  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<PatternOptions<ValueType>>

  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

start

• start(time?): this

• Start the loop at the specified time along the Transport's timeline.

  Parameters

  • Optional time: Unit.Time

    When to start the Loop.

  Returns this

stop

• stop(time?): this

• Stop the loop at the given time.

  Parameters

  • Optional time: Unit.Time

    When to stop the Loop.

  Returns this

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

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