tone 14.8.27

package/build/esm/event/Pattern.js

@@ -0,0 +1,67 @@
+import { Loop } from "./Loop";
+import { PatternGenerator } from "./PatternGenerator";
+import { optionsFromArguments } from "../core/util/Defaults";
+import { noOp } from "../core/util/Interface";
+/**
+ * Pattern arpeggiates between the given notes
+ * in a number of patterns.
+ * @example
+ * const pattern = new Tone.Pattern((time, note) => {
+ * 	// the order of the notes passed in depends on the pattern
+ * }, ["C2", "D4", "E5", "A6"], "upDown");
+ * @category Event
+ */
+export class Pattern extends Loop {
+    constructor() {
+        super(optionsFromArguments(Pattern.getDefaults(), arguments, ["callback", "values", "pattern"]));
+        this.name = "Pattern";
+        const options = optionsFromArguments(Pattern.getDefaults(), arguments, ["callback", "values", "pattern"]);
+        this.callback = options.callback;
+        this._values = options.values;
+        this._pattern = PatternGenerator(options.values, options.pattern);
+        this._type = options.pattern;
+    }
+    static getDefaults() {
+        return Object.assign(Loop.getDefaults(), {
+            pattern: "up",
+            values: [],
+            callback: noOp,
+        });
+    }
+    /**
+     * Internal function called when the notes should be called
+     */
+    _tick(time) {
+        const value = this._pattern.next();
+        this._value = value.value;
+        this.callback(time, this._value);
+    }
+    /**
+     * The array of events.
+     */
+    get values() {
+        return this._values;
+    }
+    set values(val) {
+        this._values = val;
+        // reset the pattern
+        this.pattern = this._type;
+    }
+    /**
+     * The current value of the pattern.
+     */
+    get value() {
+        return this._value;
+    }
+    /**
+     * The pattern type. See Tone.CtrlPattern for the full list of patterns.
+     */
+    get pattern() {
+        return this._type;
+    }
+    set pattern(pattern) {
+        this._type = pattern;
+        this._pattern = PatternGenerator(this._values, this._type);
+    }
+}
+//# sourceMappingURL=Pattern.js.map

package/build/esm/event/Pattern.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Pattern.js","sourceRoot":"","sources":["../../../Tone/event/Pattern.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAe,MAAM,QAAQ,CAAC;AAC3C,OAAO,EAAE,gBAAgB,EAAe,MAAM,oBAAoB,CAAC;AAEnE,OAAO,EAAE,oBAAoB,EAAE,MAAM,uBAAuB,CAAC;AAE7D,OAAO,EAAE,IAAI,EAAE,MAAM,wBAAwB,CAAC;AAQ9C;;;;;;;;GAQG;AACH,MAAM,OAAO,OAAmB,SAAQ,IAA+B;IAwCtE;QAEC,KAAK,CAAC,oBAAoB,CAAC,OAAO,CAAC,WAAW,EAAE,EAAE,SAAS,EAAE,CAAC,UAAU,EAAE,QAAQ,EAAE,SAAS,CAAC,CAAC,CAAC,CAAC;QAxCzF,SAAI,GAAW,SAAS,CAAC;QAyCjC,MAAM,OAAO,GAAG,oBAAoB,CAAC,OAAO,CAAC,WAAW,EAAE,EAAE,SAAS,EAAE,CAAC,UAAU,EAAE,QAAQ,EAAE,SAAS,CAAC,CAAC,CAAC;QAE1G,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAAC;QACjC,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC,MAAM,CAAC;QAC9B,IAAI,CAAC,QAAQ,GAAG,gBAAgB,CAAC,OAAO,CAAC,MAAM,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC;QAClE,IAAI,CAAC,KAAK,GAAG,OAAO,CAAC,OAAO,CAAC;IAC9B,CAAC;IAED,MAAM,CAAC,WAAW;QACjB,OAAO,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,WAAW,EAAE,EAAE;YACxC,OAAO,EAAE,IAAY;YACrB,MAAM,EAAE,EAAE;YACV,QAAQ,EAAE,IAAI;SACd,CAAC,CAAC;IACJ,CAAC;IAED;;OAEG;IACO,KAAK,CAAC,IAAa;QAC5B,MAAM,KAAK,GAAG,IAAI,CAAC,QAAQ,CAAC,IAAI,EAA+B,CAAC;QAChE,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC,KAAK,CAAC;QAC1B,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;IAClC,CAAC;IAED;;OAEG;IACH,IAAI,MAAM;QACT,OAAO,IAAI,CAAC,OAAO,CAAC;IACrB,CAAC;IACD,IAAI,MAAM,CAAC,GAAG;QACb,IAAI,CAAC,OAAO,GAAG,GAAG,CAAC;QACnB,oBAAoB;QACpB,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC;IAC3B,CAAC;IAED;;OAEG;IACH,IAAI,KAAK;QACR,OAAO,IAAI,CAAC,MAAM,CAAC;IACpB,CAAC;IAED;;OAEG;IACH,IAAI,OAAO;QACV,OAAO,IAAI,CAAC,KAAK,CAAC;IACnB,CAAC;IACD,IAAI,OAAO,CAAC,OAAO;QAClB,IAAI,CAAC,KAAK,GAAG,OAAO,CAAC;QACrB,IAAI,CAAC,QAAQ,GAAG,gBAAgB,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC;IAC5D,CAAC;CACD"}

package/build/esm/event/PatternGenerator.d.ts

@@ -0,0 +1,12 @@
+/**
+ * The name of the patterns
+ */
+export declare type PatternName = "up" | "down" | "upDown" | "downUp" | "alternateUp" | "alternateDown" | "random" | "randomOnce" | "randomWalk";
+/**
+ * PatternGenerator returns a generator which will iterate over the given array
+ * of values and yield the items according to the passed in pattern
+ * @param values An array of values to iterate over
+ * @param pattern The name of the pattern use when iterating over
+ * @param index Where to start in the offset of the values array
+ */
+export declare function PatternGenerator<T>(values: T[], pattern?: PatternName, index?: number): Iterator<T>;

package/build/esm/event/PatternGenerator.js

@@ -0,0 +1,165 @@
+import { assert } from "../core/util/Debug";
+import { clamp } from "../core/util/Math";
+/**
+ * Start at the first value and go up to the last
+ */
+function* upPatternGen(values) {
+    let index = 0;
+    while (index < values.length) {
+        index = clampToArraySize(index, values);
+        yield values[index];
+        index++;
+    }
+}
+/**
+ * Start at the last value and go down to 0
+ */
+function* downPatternGen(values) {
+    let index = values.length - 1;
+    while (index >= 0) {
+        index = clampToArraySize(index, values);
+        yield values[index];
+        index--;
+    }
+}
+/**
+ * Infinitely yield the generator
+ */
+function* infiniteGen(values, gen) {
+    while (true) {
+        yield* gen(values);
+    }
+}
+/**
+ * Make sure that the index is in the given range
+ */
+function clampToArraySize(index, values) {
+    return clamp(index, 0, values.length - 1);
+}
+/**
+ * Alternate between two generators
+ */
+function* alternatingGenerator(values, directionUp) {
+    let index = directionUp ? 0 : values.length - 1;
+    while (true) {
+        index = clampToArraySize(index, values);
+        yield values[index];
+        if (directionUp) {
+            index++;
+            if (index >= values.length - 1) {
+                directionUp = false;
+            }
+        }
+        else {
+            index--;
+            if (index <= 0) {
+                directionUp = true;
+            }
+        }
+    }
+}
+/**
+ * Starting from the bottom move up 2, down 1
+ */
+function* jumpUp(values) {
+    let index = 0;
+    let stepIndex = 0;
+    while (index < values.length) {
+        index = clampToArraySize(index, values);
+        yield values[index];
+        stepIndex++;
+        index += (stepIndex % 2 ? 2 : -1);
+    }
+}
+/**
+ * Starting from the top move down 2, up 1
+ */
+function* jumpDown(values) {
+    let index = values.length - 1;
+    let stepIndex = 0;
+    while (index >= 0) {
+        index = clampToArraySize(index, values);
+        yield values[index];
+        stepIndex++;
+        index += (stepIndex % 2 ? -2 : 1);
+    }
+}
+/**
+ * Choose a random index each time
+ */
+function* randomGen(values) {
+    while (true) {
+        const randomIndex = Math.floor(Math.random() * values.length);
+        yield values[randomIndex];
+    }
+}
+/**
+ * Randomly go through all of the values once before choosing a new random order
+ */
+function* randomOnce(values) {
+    // create an array of indices
+    const copy = [];
+    for (let i = 0; i < values.length; i++) {
+        copy.push(i);
+    }
+    while (copy.length > 0) {
+        // random choose an index, and then remove it so it's not chosen again
+        const randVal = copy.splice(Math.floor(copy.length * Math.random()), 1);
+        const index = clampToArraySize(randVal[0], values);
+        yield values[index];
+    }
+}
+/**
+ * Randomly choose to walk up or down 1 index in the values array
+ */
+function* randomWalk(values) {
+    // randomly choose a starting index in the values array
+    let index = Math.floor(Math.random() * values.length);
+    while (true) {
+        if (index === 0) {
+            index++; // at bottom of array, so force upward step
+        }
+        else if (index === values.length - 1) {
+            index--; // at top of array, so force downward step
+        }
+        else if (Math.random() < 0.5) { // else choose random downward or upward step
+            index--;
+        }
+        else {
+            index++;
+        }
+        yield values[index];
+    }
+}
+/**
+ * PatternGenerator returns a generator which will iterate over the given array
+ * of values and yield the items according to the passed in pattern
+ * @param values An array of values to iterate over
+ * @param pattern The name of the pattern use when iterating over
+ * @param index Where to start in the offset of the values array
+ */
+export function* PatternGenerator(values, pattern = "up", index = 0) {
+    // safeguards
+    assert(values.length > 0, "The array must have more than one value in it");
+    switch (pattern) {
+        case "up":
+            yield* infiniteGen(values, upPatternGen);
+        case "down":
+            yield* infiniteGen(values, downPatternGen);
+        case "upDown":
+            yield* alternatingGenerator(values, true);
+        case "downUp":
+            yield* alternatingGenerator(values, false);
+        case "alternateUp":
+            yield* infiniteGen(values, jumpUp);
+        case "alternateDown":
+            yield* infiniteGen(values, jumpDown);
+        case "random":
+            yield* randomGen(values);
+        case "randomOnce":
+            yield* infiniteGen(values, randomOnce);
+        case "randomWalk":
+            yield* randomWalk(values);
+    }
+}
+//# sourceMappingURL=PatternGenerator.js.map

package/build/esm/event/PatternGenerator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"PatternGenerator.js","sourceRoot":"","sources":["../../../Tone/event/PatternGenerator.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,oBAAoB,CAAC;AAC5C,OAAO,EAAE,KAAK,EAAE,MAAM,mBAAmB,CAAC;AAO1C;;GAEG;AACH,QAAQ,CAAC,CAAC,YAAY,CAAI,MAAW;IACpC,IAAI,KAAK,GAAG,CAAC,CAAC;IACd,OAAO,KAAK,GAAG,MAAM,CAAC,MAAM,EAAE;QAC7B,KAAK,GAAG,gBAAgB,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;QACxC,MAAM,MAAM,CAAC,KAAK,CAAC,CAAC;QACpB,KAAK,EAAE,CAAC;KACR;AACF,CAAC;AAED;;GAEG;AACH,QAAQ,CAAC,CAAC,cAAc,CAAI,MAAW;IACtC,IAAI,KAAK,GAAG,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC;IAC9B,OAAO,KAAK,IAAI,CAAC,EAAE;QAClB,KAAK,GAAG,gBAAgB,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;QACxC,MAAM,MAAM,CAAC,KAAK,CAAC,CAAC;QACpB,KAAK,EAAE,CAAC;KACR;AACF,CAAC;AAED;;GAEG;AACH,QAAQ,CAAC,CAAC,WAAW,CAAI,MAAW,EAAE,GAAwB;IAC7D,OAAO,IAAI,EAAE;QACZ,KAAK,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;KACnB;AACF,CAAC;AAED;;GAEG;AACH,SAAS,gBAAgB,CAAC,KAAa,EAAE,MAAa;IACrD,OAAO,KAAK,CAAC,KAAK,EAAE,CAAC,EAAE,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;AAC3C,CAAC;AAED;;GAEG;AACH,QAAQ,CAAC,CAAC,oBAAoB,CAAI,MAAW,EAAE,WAAoB;IAClE,IAAI,KAAK,GAAG,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC;IAChD,OAAO,IAAI,EAAE;QACZ,KAAK,GAAG,gBAAgB,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;QACxC,MAAM,MAAM,CAAC,KAAK,CAAC,CAAC;QACpB,IAAI,WAAW,EAAE;YAChB,KAAK,EAAE,CAAC;YACR,IAAI,KAAK,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE;gBAC/B,WAAW,GAAG,KAAK,CAAC;aACpB;SACD;aAAM;YACN,KAAK,EAAE,CAAC;YACR,IAAI,KAAK,IAAI,CAAC,EAAE;gBACf,WAAW,GAAG,IAAI,CAAC;aACnB;SACD;KACD;AACF,CAAC;AAED;;GAEG;AACH,QAAQ,CAAC,CAAC,MAAM,CAAI,MAAW;IAC9B,IAAI,KAAK,GAAG,CAAC,CAAC;IACd,IAAI,SAAS,GAAG,CAAC,CAAC;IAClB,OAAO,KAAK,GAAG,MAAM,CAAC,MAAM,EAAE;QAC7B,KAAK,GAAG,gBAAgB,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;QACxC,MAAM,MAAM,CAAC,KAAK,CAAC,CAAC;QACpB,SAAS,EAAE,CAAC;QACZ,KAAK,IAAI,CAAC,SAAS,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;KAClC;AACF,CAAC;AAED;;GAEG;AACH,QAAQ,CAAC,CAAC,QAAQ,CAAI,MAAW;IAChC,IAAI,KAAK,GAAG,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC;IAC9B,IAAI,SAAS,GAAG,CAAC,CAAC;IAClB,OAAO,KAAK,IAAI,CAAC,EAAE;QAClB,KAAK,GAAG,gBAAgB,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;QACxC,MAAM,MAAM,CAAC,KAAK,CAAC,CAAC;QACpB,SAAS,EAAE,CAAC;QACZ,KAAK,IAAI,CAAC,SAAS,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;KAClC;AACF,CAAC;AAED;;GAEG;AACH,QAAQ,CAAC,CAAC,SAAS,CAAI,MAAW;IACjC,OAAO,IAAI,EAAE;QACZ,MAAM,WAAW,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC;QAC9D,MAAM,MAAM,CAAC,WAAW,CAAC,CAAC;KAC1B;AACF,CAAC;AAED;;GAEG;AACH,QAAQ,CAAC,CAAC,UAAU,CAAI,MAAW;IAClC,6BAA6B;IAC7B,MAAM,IAAI,GAAa,EAAE,CAAC;IAC1B,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;QACvC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;KACb;IACD,OAAO,IAAI,CAAC,MAAM,GAAG,CAAC,EAAE;QACvB,sEAAsE;QACtE,MAAM,OAAO,GAAG,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;QACxE,MAAM,KAAK,GAAG,gBAAgB,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC;QACnD,MAAM,MAAM,CAAC,KAAK,CAAC,CAAC;KACpB;AACF,CAAC;AAED;;GAEG;AACH,QAAQ,CAAC,CAAC,UAAU,CAAI,MAAW;IAClC,uDAAuD;IACvD,IAAI,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC;IACtD,OAAO,IAAI,EAAE;QACZ,IAAI,KAAK,KAAK,CAAC,EAAE;YAChB,KAAK,EAAE,CAAC,CAAC,2CAA2C;SACpD;aAAM,IAAI,KAAK,KAAK,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE;YACvC,KAAK,EAAE,CAAC,CAAC,0CAA0C;SACnD;aAAM,IAAI,IAAI,CAAC,MAAM,EAAE,GAAG,GAAG,EAAE,EAAE,6CAA6C;YAC9E,KAAK,EAAE,CAAC;SACR;aAAM;YACN,KAAK,EAAE,CAAC;SACR;QACD,MAAM,MAAM,CAAC,KAAK,CAAC,CAAC;KACpB;AACF,CAAC;AAED;;;;;;GAMG;AACH,MAAM,SAAS,CAAC,CAAC,gBAAgB,CAAI,MAAW,EAAE,UAAuB,IAAI,EAAE,KAAK,GAAG,CAAC;IACvF,aAAa;IACb,MAAM,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE,+CAA+C,CAAC,CAAC;IAC3E,QAAQ,OAAO,EAAE;QAChB,KAAK,IAAI;YACR,KAAK,CAAC,CAAC,WAAW,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC;QAC1C,KAAK,MAAM;YACV,KAAK,CAAC,CAAC,WAAW,CAAC,MAAM,EAAE,cAAc,CAAC,CAAC;QAC5C,KAAK,QAAQ;YACZ,KAAK,CAAC,CAAC,oBAAoB,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;QAC3C,KAAK,QAAQ;YACZ,KAAK,CAAC,CAAC,oBAAoB,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;QAC5C,KAAK,aAAa;YACjB,KAAK,CAAC,CAAC,WAAW,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;QACpC,KAAK,eAAe;YACnB,KAAK,CAAC,CAAC,WAAW,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;QACtC,KAAK,QAAQ;YACZ,KAAK,CAAC,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;QAC1B,KAAK,YAAY;YAChB,KAAK,CAAC,CAAC,WAAW,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC;QACxC,KAAK,YAAY;YAChB,KAAK,CAAC,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;KAC3B;AACF,CAAC"}

package/build/esm/event/Sequence.d.ts

@@ -0,0 +1,127 @@
+import { NormalRange, Positive, Seconds, Ticks, Time, TransportTime } from "../core/type/Units";
+import { ToneEvent, ToneEventCallback, ToneEventOptions } from "./ToneEvent";
+declare type SequenceEventDescription<T> = Array<T | Array<T | Array<T | Array<T | Array<T | T[]>>>>>;
+interface SequenceOptions<T> extends Omit<ToneEventOptions<T>, "value"> {
+    loopStart: number;
+    loopEnd: number;
+    subdivision: Time;
+    events: SequenceEventDescription<T>;
+}
+/**
+ * A sequence is an alternate notation of a part. Instead
+ * of passing in an array of [time, event] pairs, pass
+ * in an array of events which will be spaced at the
+ * given subdivision. Sub-arrays will subdivide that beat
+ * by the number of items are in the array.
+ * Sequence notation inspiration from [Tidal](http://yaxu.org/tidal/)
+ * @example
+ * const synth = new Tone.Synth().toDestination();
+ * const seq = new Tone.Sequence((time, note) => {
+ * 	synth.triggerAttackRelease(note, 0.1, time);
+ * 	// subdivisions are given as subarrays
+ * }, ["C4", ["E4", "D4", "E4"], "G4", ["A4", "G4"]]).start(0);
+ * Tone.Transport.start();
+ * @category Event
+ */
+export declare class Sequence<ValueType = any> extends ToneEvent<ValueType> {
+    readonly name: string;
+    /**
+     * The subdivison of each note
+     */
+    private _subdivision;
+    /**
+     * The object responsible for scheduling all of the events
+     */
+    private _part;
+    /**
+     * private reference to all of the sequence proxies
+     */
+    private _events;
+    /**
+     * The proxied array
+     */
+    private _eventsArray;
+    /**
+     * @param  callback  The callback to invoke with every note
+     * @param  sequence  The sequence
+     * @param  subdivision  The subdivision between which events are placed.
+     */
+    constructor(callback?: ToneEventCallback<ValueType>, events?: SequenceEventDescription<ValueType>, subdivision?: Time);
+    constructor(options?: Partial<SequenceOptions<ValueType>>);
+    static getDefaults(): SequenceOptions<any>;
+    /**
+     * The internal callback for when an event is invoked
+     */
+    private _seqCallback;
+    /**
+     * The sequence
+     */
+    get events(): any[];
+    set events(s: any[]);
+    /**
+     * Start the part at the given time.
+     * @param  time    When to start the part.
+     * @param  offset  The offset index to start at
+     */
+    start(time?: TransportTime, offset?: number): this;
+    /**
+     * Stop the part at the given time.
+     * @param  time  When to stop the part.
+     */
+    stop(time?: TransportTime): this;
+    /**
+     * The subdivision of the sequence. This can only be
+     * set in the constructor. The subdivision is the
+     * interval between successive steps.
+     */
+    get subdivision(): Seconds;
+    /**
+     * Create a sequence proxy which can be monitored to create subsequences
+     */
+    private _createSequence;
+    /**
+     * When the sequence has changed, all of the events need to be recreated
+     */
+    private _eventsUpdated;
+    /**
+     * reschedule all of the events that need to be rescheduled
+     */
+    private _rescheduleSequence;
+    /**
+     * Get the time of the index given the Sequence's subdivision
+     * @param  index
+     * @return The time of that index
+     */
+    private _indexTime;
+    /**
+     * Clear all of the events
+     */
+    clear(): this;
+    dispose(): this;
+    get loop(): boolean | number;
+    set loop(l: boolean | number);
+    /**
+     * The index at which the sequence should start looping
+     */
+    get loopStart(): number;
+    set loopStart(index: number);
+    /**
+     * The index at which the sequence should end looping
+     */
+    get loopEnd(): number;
+    set loopEnd(index: number);
+    get startOffset(): Ticks;
+    set startOffset(start: Ticks);
+    get playbackRate(): Positive;
+    set playbackRate(rate: Positive);
+    get probability(): NormalRange;
+    set probability(prob: NormalRange);
+    get progress(): NormalRange;
+    get humanize(): boolean | Time;
+    set humanize(variation: boolean | Time);
+    /**
+     * The number of scheduled events
+     */
+    get length(): number;
+}
+export {};

package/build/esm/event/Sequence.js

@@ -0,0 +1,247 @@
+import { TicksClass } from "../core/type/Ticks";
+import { omitFromObject, optionsFromArguments } from "../core/util/Defaults";
+import { isArray, isString } from "../core/util/TypeCheck";
+import { Part } from "./Part";
+import { ToneEvent } from "./ToneEvent";
+/**
+ * A sequence is an alternate notation of a part. Instead
+ * of passing in an array of [time, event] pairs, pass
+ * in an array of events which will be spaced at the
+ * given subdivision. Sub-arrays will subdivide that beat
+ * by the number of items are in the array.
+ * Sequence notation inspiration from [Tidal](http://yaxu.org/tidal/)
+ * @example
+ * const synth = new Tone.Synth().toDestination();
+ * const seq = new Tone.Sequence((time, note) => {
+ * 	synth.triggerAttackRelease(note, 0.1, time);
+ * 	// subdivisions are given as subarrays
+ * }, ["C4", ["E4", "D4", "E4"], "G4", ["A4", "G4"]]).start(0);
+ * Tone.Transport.start();
+ * @category Event
+ */
+export class Sequence extends ToneEvent {
+    constructor() {
+        super(optionsFromArguments(Sequence.getDefaults(), arguments, ["callback", "events", "subdivision"]));
+        this.name = "Sequence";
+        /**
+         * The object responsible for scheduling all of the events
+         */
+        this._part = new Part({
+            callback: this._seqCallback.bind(this),
+            context: this.context,
+        });
+        /**
+         * private reference to all of the sequence proxies
+         */
+        this._events = [];
+        /**
+         * The proxied array
+         */
+        this._eventsArray = [];
+        const options = optionsFromArguments(Sequence.getDefaults(), arguments, ["callback", "events", "subdivision"]);
+        this._subdivision = this.toTicks(options.subdivision);
+        this.events = options.events;
+        // set all of the values
+        this.loop = options.loop;
+        this.loopStart = options.loopStart;
+        this.loopEnd = options.loopEnd;
+        this.playbackRate = options.playbackRate;
+        this.probability = options.probability;
+        this.humanize = options.humanize;
+        this.mute = options.mute;
+        this.playbackRate = options.playbackRate;
+    }
+    static getDefaults() {
+        return Object.assign(omitFromObject(ToneEvent.getDefaults(), ["value"]), {
+            events: [],
+            loop: true,
+            loopEnd: 0,
+            loopStart: 0,
+            subdivision: "8n",
+        });
+    }
+    /**
+     * The internal callback for when an event is invoked
+     */
+    _seqCallback(time, value) {
+        if (value !== null && !this.mute) {
+            this.callback(time, value);
+        }
+    }
+    /**
+     * The sequence
+     */
+    get events() {
+        return this._events;
+    }
+    set events(s) {
+        this.clear();
+        this._eventsArray = s;
+        this._events = this._createSequence(this._eventsArray);
+        this._eventsUpdated();
+    }
+    /**
+     * Start the part at the given time.
+     * @param  time    When to start the part.
+     * @param  offset  The offset index to start at
+     */
+    start(time, offset) {
+        this._part.start(time, offset ? this._indexTime(offset) : offset);
+        return this;
+    }
+    /**
+     * Stop the part at the given time.
+     * @param  time  When to stop the part.
+     */
+    stop(time) {
+        this._part.stop(time);
+        return this;
+    }
+    /**
+     * The subdivision of the sequence. This can only be
+     * set in the constructor. The subdivision is the
+     * interval between successive steps.
+     */
+    get subdivision() {
+        return new TicksClass(this.context, this._subdivision).toSeconds();
+    }
+    /**
+     * Create a sequence proxy which can be monitored to create subsequences
+     */
+    _createSequence(array) {
+        return new Proxy(array, {
+            get: (target, property) => {
+                // property is index in this case
+                return target[property];
+            },
+            set: (target, property, value) => {
+                if (isString(property) && isFinite(parseInt(property, 10))) {
+                    if (isArray(value)) {
+                        target[property] = this._createSequence(value);
+                    }
+                    else {
+                        target[property] = value;
+                    }
+                }
+                else {
+                    target[property] = value;
+                }
+                this._eventsUpdated();
+                // return true to accept the changes
+                return true;
+            },
+        });
+    }
+    /**
+     * When the sequence has changed, all of the events need to be recreated
+     */
+    _eventsUpdated() {
+        this._part.clear();
+        this._rescheduleSequence(this._eventsArray, this._subdivision, this.startOffset);
+        // update the loopEnd
+        this.loopEnd = this.loopEnd;
+    }
+    /**
+     * reschedule all of the events that need to be rescheduled
+     */
+    _rescheduleSequence(sequence, subdivision, startOffset) {
+        sequence.forEach((value, index) => {
+            const eventOffset = index * (subdivision) + startOffset;
+            if (isArray(value)) {
+                this._rescheduleSequence(value, subdivision / value.length, eventOffset);
+            }
+            else {
+                const startTime = new TicksClass(this.context, eventOffset, "i").toSeconds();
+                this._part.add(startTime, value);
+            }
+        });
+    }
+    /**
+     * Get the time of the index given the Sequence's subdivision
+     * @param  index
+     * @return The time of that index
+     */
+    _indexTime(index) {
+        return new TicksClass(this.context, index * (this._subdivision) + this.startOffset).toSeconds();
+    }
+    /**
+     * Clear all of the events
+     */
+    clear() {
+        this._part.clear();
+        return this;
+    }
+    dispose() {
+        super.dispose();
+        this._part.dispose();
+        return this;
+    }
+    //-------------------------------------
+    // PROXY CALLS
+    //-------------------------------------
+    get loop() {
+        return this._part.loop;
+    }
+    set loop(l) {
+        this._part.loop = l;
+    }
+    /**
+     * The index at which the sequence should start looping
+     */
+    get loopStart() {
+        return this._loopStart;
+    }
+    set loopStart(index) {
+        this._loopStart = index;
+        this._part.loopStart = this._indexTime(index);
+    }
+    /**
+     * The index at which the sequence should end looping
+     */
+    get loopEnd() {
+        return this._loopEnd;
+    }
+    set loopEnd(index) {
+        this._loopEnd = index;
+        if (index === 0) {
+            this._part.loopEnd = this._indexTime(this._eventsArray.length);
+        }
+        else {
+            this._part.loopEnd = this._indexTime(index);
+        }
+    }
+    get startOffset() {
+        return this._part.startOffset;
+    }
+    set startOffset(start) {
+        this._part.startOffset = start;
+    }
+    get playbackRate() {
+        return this._part.playbackRate;
+    }
+    set playbackRate(rate) {
+        this._part.playbackRate = rate;
+    }
+    get probability() {
+        return this._part.probability;
+    }
+    set probability(prob) {
+        this._part.probability = prob;
+    }
+    get progress() {
+        return this._part.progress;
+    }
+    get humanize() {
+        return this._part.humanize;
+    }
+    set humanize(variation) {
+        this._part.humanize = variation;
+    }
+    /**
+     * The number of scheduled events
+     */
+    get length() {
+        return this._part.length;
+    }
+}
+//# sourceMappingURL=Sequence.js.map

package/build/esm/event/Sequence.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Sequence.js","sourceRoot":"","sources":["../../../Tone/event/Sequence.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAC;AAEhD,OAAO,EAAE,cAAc,EAAE,oBAAoB,EAAE,MAAM,uBAAuB,CAAC;AAC7E,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,wBAAwB,CAAC;AAC3D,OAAO,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAC9B,OAAO,EAAE,SAAS,EAAuC,MAAM,aAAa,CAAC;AAW7E;;;;;;;;;;;;;;;GAeG;AACH,MAAM,OAAO,QAA0B,SAAQ,SAAoB;IAsClE;QAEC,KAAK,CAAC,oBAAoB,CAAC,QAAQ,CAAC,WAAW,EAAE,EAAE,SAAS,EAAE,CAAC,UAAU,EAAE,QAAQ,EAAE,aAAa,CAAC,CAAC,CAAC,CAAC;QAtC9F,SAAI,GAAW,UAAU,CAAC;QAOnC;;WAEG;QACK,UAAK,GAAS,IAAI,IAAI,CAAC;YAC9B,QAAQ,EAAE,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC;YACtC,OAAO,EAAE,IAAI,CAAC,OAAO;SACrB,CAAC,CAAC;QAEH;;WAEG;QACK,YAAO,GAAwC,EAAE,CAAC;QAE1D;;WAEG;QACK,iBAAY,GAAwC,EAAE,CAAC;QAgB9D,MAAM,OAAO,GAAG,oBAAoB,CAAC,QAAQ,CAAC,WAAW,EAAE,EAAE,SAAS,EAAE,CAAC,UAAU,EAAE,QAAQ,EAAE,aAAa,CAAC,CAAC,CAAC;QAE/G,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;QAEtD,IAAI,CAAC,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;QAE7B,wBAAwB;QACxB,IAAI,CAAC,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;QACzB,IAAI,CAAC,SAAS,GAAG,OAAO,CAAC,SAAS,CAAC;QACnC,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC;QAC/B,IAAI,CAAC,YAAY,GAAG,OAAO,CAAC,YAAY,CAAC;QACzC,IAAI,CAAC,WAAW,GAAG,OAAO,CAAC,WAAW,CAAC;QACvC,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAAC;QACjC,IAAI,CAAC,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;QACzB,IAAI,CAAC,YAAY,GAAG,OAAO,CAAC,YAAY,CAAC;IAC1C,CAAC;IAED,MAAM,CAAC,WAAW;QACjB,OAAO,MAAM,CAAC,MAAM,CAAC,cAAc,CAAC,SAAS,CAAC,WAAW,EAAE,EAAE,CAAC,OAAO,CAAC,CAAC,EAAE;YACxE,MAAM,EAAE,EAAE;YACV,IAAI,EAAE,IAAI;YACV,OAAO,EAAE,CAAC;YACV,SAAS,EAAE,CAAC;YACZ,WAAW,EAAE,IAAI;SACjB,CAAC,CAAC;IACJ,CAAC;IAED;;OAEG;IACK,YAAY,CAAC,IAAa,EAAE,KAAU;QAC7C,IAAI,KAAK,KAAK,IAAI,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE;YACjC,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;SAC3B;IACF,CAAC;IAED;;OAEG;IACH,IAAI,MAAM;QACT,OAAO,IAAI,CAAC,OAAO,CAAC;IACrB,CAAC;IACD,IAAI,MAAM,CAAC,CAAC;QACX,IAAI,CAAC,KAAK,EAAE,CAAC;QACb,IAAI,CAAC,YAAY,GAAG,CAAC,CAAC;QACtB,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;QACvD,IAAI,CAAC,cAAc,EAAE,CAAC;IACvB,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,IAAoB,EAAE,MAAe;QAC1C,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC;QAClE,OAAO,IAAI,CAAC;IACb,CAAC;IAED;;;OAGG;IACH,IAAI,CAAC,IAAoB;QACxB,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACtB,OAAO,IAAI,CAAC;IACb,CAAC;IAED;;;;OAIG;IACH,IAAI,WAAW;QACd,OAAO,IAAI,UAAU,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,YAAY,CAAC,CAAC,SAAS,EAAE,CAAC;IACpE,CAAC;IAED;;OAEG;IACK,eAAe,CAAC,KAAY;QACnC,OAAO,IAAI,KAAK,CAAC,KAAK,EAAE;YACvB,GAAG,EAAE,CAAC,MAAa,EAAE,QAAqB,EAAO,EAAE;gBAClD,iCAAiC;gBACjC,OAAO,MAAM,CAAC,QAAQ,CAAC,CAAC;YACzB,CAAC;YACD,GAAG,EAAE,CAAC,MAAa,EAAE,QAAqB,EAAE,KAAU,EAAW,EAAE;gBAClE,IAAI,QAAQ,CAAC,QAAQ,CAAC,IAAI,QAAQ,CAAC,QAAQ,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC,EAAE;oBAC3D,IAAI,OAAO,CAAC,KAAK,CAAC,EAAE;wBACnB,MAAM,CAAC,QAAQ,CAAC,GAAG,IAAI,CAAC,eAAe,CAAC,KAAK,CAAC,CAAC;qBAC/C;yBAAM;wBACN,MAAM,CAAC,QAAQ,CAAC,GAAG,KAAK,CAAC;qBACzB;iBACD;qBAAM;oBACN,MAAM,CAAC,QAAQ,CAAC,GAAG,KAAK,CAAC;iBACzB;gBACD,IAAI,CAAC,cAAc,EAAE,CAAC;gBACtB,oCAAoC;gBACpC,OAAO,IAAI,CAAC;YACb,CAAC;SACD,CAAC,CAAC;IACJ,CAAC;IAED;;OAEG;IACK,cAAc;QACrB,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE,CAAC;QACnB,IAAI,CAAC,mBAAmB,CAAC,IAAI,CAAC,YAAY,EAAE,IAAI,CAAC,YAAY,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;QACjF,qBAAqB;QACrB,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC;IAC7B,CAAC;IAED;;OAEG;IACK,mBAAmB,CAAC,QAAe,EAAE,WAAkB,EAAE,WAAkB;QAClF,QAAQ,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,KAAK,EAAE,EAAE;YACjC,MAAM,WAAW,GAAG,KAAK,GAAG,CAAC,WAAW,CAAC,GAAG,WAAW,CAAC;YACxD,IAAI,OAAO,CAAC,KAAK,CAAC,EAAE;gBACnB,IAAI,CAAC,mBAAmB,CAAC,KAAK,EAAE,WAAW,GAAG,KAAK,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC;aACzE;iBAAM;gBACN,MAAM,SAAS,GAAG,IAAI,UAAU,CAAC,IAAI,CAAC,OAAO,EAAE,WAAW,EAAE,GAAG,CAAC,CAAC,SAAS,EAAE,CAAC;gBAC7E,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,SAAS,EAAE,KAAK,CAAC,CAAC;aACjC;QACF,CAAC,CAAC,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACK,UAAU,CAAC,KAAa;QAC/B,OAAO,IAAI,UAAU,CAAC,IAAI,CAAC,OAAO,EAAE,KAAK,GAAG,CAAC,IAAI,CAAC,YAAY,CAAC,GAAG,IAAI,CAAC,WAAW,CAAC,CAAC,SAAS,EAAE,CAAC;IACjG,CAAC;IAED;;OAEG;IACH,KAAK;QACJ,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE,CAAC;QACnB,OAAO,IAAI,CAAC;IACb,CAAC;IAED,OAAO;QACN,KAAK,CAAC,OAAO,EAAE,CAAC;QAChB,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE,CAAC;QACrB,OAAO,IAAI,CAAC;IACb,CAAC;IAED,uCAAuC;IACvC,cAAc;IACd,uCAAuC;IAEvC,IAAI,IAAI;QACP,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC;IACxB,CAAC;IACD,IAAI,IAAI,CAAC,CAAC;QACT,IAAI,CAAC,KAAK,CAAC,IAAI,GAAG,CAAC,CAAC;IACrB,CAAC;IAED;;OAEG;IACH,IAAI,SAAS;QACZ,OAAO,IAAI,CAAC,UAAU,CAAC;IACxB,CAAC;IACD,IAAI,SAAS,CAAC,KAAK;QAClB,IAAI,CAAC,UAAU,GAAG,KAAK,CAAC;QACxB,IAAI,CAAC,KAAK,CAAC,SAAS,GAAG,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;IAC/C,CAAC;IAED;;OAEG;IACH,IAAI,OAAO;QACV,OAAO,IAAI,CAAC,QAAQ,CAAC;IACtB,CAAC;IACD,IAAI,OAAO,CAAC,KAAK;QAChB,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC;QACtB,IAAI,KAAK,KAAK,CAAC,EAAE;YAChB,IAAI,CAAC,KAAK,CAAC,OAAO,GAAG,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC;SAC/D;aAAM;YACN,IAAI,CAAC,KAAK,CAAC,OAAO,GAAG,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;SAC5C;IACF,CAAC;IAED,IAAI,WAAW;QACd,OAAO,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC;IAC/B,CAAC;IACD,IAAI,WAAW,CAAC,KAAK;QACpB,IAAI,CAAC,KAAK,CAAC,WAAW,GAAG,KAAK,CAAC;IAChC,CAAC;IAED,IAAI,YAAY;QACf,OAAO,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC;IAChC,CAAC;IACD,IAAI,YAAY,CAAC,IAAI;QACpB,IAAI,CAAC,KAAK,CAAC,YAAY,GAAG,IAAI,CAAC;IAChC,CAAC;IAED,IAAI,WAAW;QACd,OAAO,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC;IAC/B,CAAC;IACD,IAAI,WAAW,CAAC,IAAI;QACnB,IAAI,CAAC,KAAK,CAAC,WAAW,GAAG,IAAI,CAAC;IAC/B,CAAC;IAED,IAAI,QAAQ;QACX,OAAO,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC;IAC5B,CAAC;IAED,IAAI,QAAQ;QACX,OAAO,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC;IAC5B,CAAC;IACD,IAAI,QAAQ,CAAC,SAAS;QACrB,IAAI,CAAC,KAAK,CAAC,QAAQ,GAAG,SAAS,CAAC;IACjC,CAAC;IAED;;OAEG;IACH,IAAI,MAAM;QACT,OAAO,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC;IAC1B,CAAC;CACD"}