Timeline
Extension
ExtensionDescription
Timeline can be used for scheduling functions in time.
Class Methods
.new
Create a new Timeline instance.
Arguments:
| clock |
An instance of TempoClock. |
| options |
An event containing options for the timeline. Valid options are:
options: ( mode: \time, quant: 1, liveReload: true ) |
Returns:
An instance of Timeline.
.newFromArray
Create an instance of Timeline using an array of time - function pairs; time is in beats or optionally in seconds.
Arguments:
| array |
An instance of Array with time - function pairs, like [ 0, { }, 1, { } ]. |
| clock |
See new method. |
| options |
See new method. |
Returns:
.newFromPath
Create an instance of Timeline using an external scd file containing an Array of time - function pairs; time is in beats or optionally in seconds.
Arguments:
| path |
A String representing the path of an scd file. The file must return an Array of time - function pairs, like [ 0, { }, 1, { } ]. |
| clock |
See new method. time - function |
| options |
See new method. |
Returns:
An instance of Timeline.
xxxxxxxxxx// Example contents of an .scd file[ 1, {"event 1".postln;}, 2, {"event 2".postln;}, 3, {"event 3".postln;}, 4, {"event 4".postln;}]Instance Methods
.play
Start the timeline according to quantisation value.
Returns:
The Timeline instance.
.stop
.add
Add a time,function pair, like [ 1.5, { } ].
Arguments:
| time |
This is in seconds or beats according to options. |
| function |
A Function to be avaluated at the given time. |
Returns:
The Timeline instance.
.plot
Graph a simple representation of the scheduled items.
Arguments:
| timeUnitLength |
Choose the width (in pixels) of every second in the plot. Also, use the +/- keys on the keyboard to zoom in/out of the graph. |
Returns:
The Timeline instance.
.options
Returns the current options event.
.clock
Get or set the TempoClock.
Examples
// Using the add method(c = TempoClock(5);t = Timeline.new(clock: c, options:(mode: \beats, quant: 1));t.add(2, {"test 1".postln});t.add(4, {"test 2".postln});t.add(9, {"test 3".postln}););t.play;t.plot;// Using an Array(t = Timeline.newFromArray( [ 1, {"test 1".postln}, 2.5, {"test 2".postln}, 3.5, {"test 3".postln} ]));t.play;// Using a patht = Timeline.newFromPath( PathName(CuePlayer.class.filenameSymbol.asString).parentPath +/+ "HelpSource/Classes/timeline" +/+ "t-score.scd" );t.play;// An Array or String can also be converted to a timeline.t = (PathName(CuePlayer.class.filenameSymbol.asString).parentPath +/+ "HelpSource/Classes/timeline" +/+ "t-score.scd").asTimeline;t.play;