Class Part<ValueType>

Part is a collection ToneEvents which can be started/stopped and looped as a single unit.

Example

const synth = new Tone.Synth().toDestination();
const part = new Tone.Part(((time, note) => {
    // the notes given as the second element in the array
    // will be passed in as the second argument
    synth.triggerAttackRelease(note, "8n", time);
}), [[0, "C2"], ["0:2", "C3"], ["0:3:2", "G2"]]).start(0);
Tone.Transport.start();

Example

const synth = new Tone.Synth().toDestination();
// use an array of objects as long as the object has a "time" attribute
const part = new Tone.Part(((time, value) => {
    // the value is an object which contains both the note and the velocity
    synth.triggerAttackRelease(value.note, "8n", time, value.velocity);
}), [{ time: 0, note: "C3", velocity: 0.9 },
    { time: "0:2", note: "C4", velocity: 0.5 }
]).start(0);
Tone.Transport.start();

Type Parameters

  • ValueType = any

Hierarchy (view full)

Constructors

constructor

Properties

callback context debug mute name value version

Accessors

blockTime disposed humanize length loop loopEnd loopStart playbackRate probability progress sampleTime startOffset state

Methods

add at cancel clear dispose get immediate now remove set start stop toFrequency toSeconds toString toTicks getDefaults

Constructors

constructor

Properties

callback

callback: ToneEventCallback<ValueType>

The callback to invoke.

Readonly context

context: BaseContext

The context belonging to the node.

debug

debug: boolean = false

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

mute

mute: boolean

If mute is true, the callback won't be invoked.

Readonly name

name: string = "Part"

value

value: ValueType

The value which is passed to the callback function.

Static version

version: string = version

The version number semver

Accessors

blockTime

  • get blockTime(): number

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

    Returns number

    Example

    console.log(Tone.Destination.blockTime);

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

  • If set to true, will apply small random variation to the callback time. If the value is given as a time, it will randomize by that amount.

    Returns boolean | Unit.Time

    Example

    const event = new Tone.ToneEvent();
    event.humanize = true;
  • set humanize(variation): void

  • Parameters

    Returns void

length

  • get length(): number

  • The number of scheduled notes in the part.

    Returns number

loop

  • get loop(): number | boolean

  • If the part should loop or not between Part.loopStart and Part.loopEnd. If set to true, the part will loop indefinitely, if set to a number greater than 1 it will play a specific number of times, if set to false, 0 or 1, the part will only play once.

    Returns number | boolean

    Example

    const part = new Tone.Part();
    // loop the part 8 times
    part.loop = 8;
  • set loop(loop): void

  • Parameters

    • loop: number | boolean

    Returns void

loopEnd

loopStart

playbackRate

  • get playbackRate(): number

  • The playback rate of the part

    Returns number

  • set playbackRate(rate): void

  • Parameters

    • rate: number

    Returns void

probability

  • get probability(): number

  • The probability of the notes being triggered.

    Returns number

  • set probability(prob): void

  • Parameters

    • prob: number

    Returns void

progress

  • get progress(): number

  • The current progress of the loop interval. Returns 0 if the event is not started yet or it is not set to loop.

    Returns number

sampleTime

startOffset

  • get startOffset(): number

  • The start from the scheduled start time.

    Returns number

  • set startOffset(offset): void

  • Parameters

    • offset: number

    Returns void

state

Methods

add

  • add(obj): this

  • Add a an event to the part.

    Parameters

    • obj: {
          time: Unit.Time;
          [key: string]: any;
      }

    Returns this

    Example

    const part = new Tone.Part();
    part.add("1m", "C#+11");
  • add(time, value?): this

  • Parameters

    Returns this

at

  • at(time, value?): null | ToneEvent<any>

  • Get/Set an Event's value at the given time. If a value is passed in and no event exists at the given time, one will be created with that value. If two events are at the same time, the first one will be returned.

    Parameters

    • time: Unit.Time

      The time of the event to get or set.

    • Optional value: any

      If a value is passed in, the value of the event at the given time will be set to it.

    Returns null | ToneEvent<any>

    Example

    const part = new Tone.Part();
    part.at("1m"); // returns the part at the first measure
    part.at("2m", "C2"); // set the value at "2m" to C2.
    // if an event didn't exist at that time, it will be created.

cancel

clear

dispose

get

immediate

now

remove

  • remove(obj): this

  • Remove an event from the part. If the event at that time is a Part, it will remove the entire part.

    Parameters

    • obj: {
          time: Unit.Time;
          [key: string]: any;
      }

    Returns this

  • remove(time, value?): this

  • Parameters

    Returns this

set

  • set(props): this

  • Set multiple properties at once with an object.

    Parameters

    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;

start

  • start(time?, offset?): this

  • Start the part at the given time.

    Parameters

    • Optional time: Unit.Time

      When to start the part.

    • Optional offset: Unit.Time

      The offset from the start of the part to begin playing at.

    Returns this

stop

toFrequency

toSeconds

  • toSeconds(time?): number

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

    Parameters

    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);

toString

  • toString(): string

  • Convert the class to a string

    Returns string

    Example

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

toTicks

Static getDefaults

Settings

Member Visibility

Theme

On This Page

constructorcallbackcontextdebugmutenamevalueversionblockTimedisposedhumanizelengthlooploopEndloopStartplaybackRateprobabilityprogresssampleTimestartOffsetstateaddatcancelcleardisposegetimmediatenowremovesetstartstoptoFrequencytoSecondstoStringtoTicksgetDefaults