Tone.Timeline

↳ EXTENDS Tone

A Timeline class for scheduling and maintaining state along a timeline. All events must have a “time” property. Internally, events are stored in time order for fast retrieval.

CONSTRUCTOR

new Tone.Timeline ( [
memory
= Infinity ] )
memory

The number of previous events that are retained.

default: Infinity

DEFAULTS

{
memory : Infinity
}

Members

.length

Number READONLY #

The number of items in the timeline.

</>

.memory

Positive #

The memory of the timeline, i.e. how many events in the past it will retain

</>

Methods

.shift ( )

#
↪ returns Object

The first event object

Return the first event in the timeline and remove it

</>

.cancel ( )

#
time

The time to query.

type: Number
↪ returns Tone.Timeline

this

Cancel events after the given time

</>

.cancelBefore ( )

#
time

The time to cancel before.

type: Number
↪ returns Tone.Timeline

this

Cancel events before or equal to the given time.

</>

.dispose ( )

#
↪ returns Tone.Timeline

this

Clean up.

</>

.forEach ( )

#
callback

The callback to invoke with every item

↪ returns Tone.Timeline

this

Iterate over everything in the array

</>

.forEachAfter ( )

#
time

The time to check if items are before

type: Number
callback

The callback to invoke with every item

↪ returns Tone.Timeline

this

Iterate over everything in the array after the given time.

</>

.forEachAtTime ( )

#
time

The time to check if items are before

type: Number
callback

The callback to invoke with every item

↪ returns Tone.Timeline

this

Iterate over everything in the array at the given time

</>

.forEachBefore ( )

#
time

The time to check if items are before

type: Number
callback

The callback to invoke with every item

↪ returns Tone.Timeline

this

Iterate over everything in the array at or before the given time.

</>

.forEachBetween ( )

#
startTime

The time to check if items are before

type: Number
endTime

The end of the test interval.

type: Number
callback

The callback to invoke with every item

↪ returns Tone.Timeline

this

Iterate over everything in the array between the startTime and endTime. The timerange is inclusive of the startTime, but exclusive of the endTime. range = [startTime, endTime).

</>

.forEachFrom ( )

#
time

The time to check if items are before

type: Number
callback

The callback to invoke with every item

↪ returns Tone.Timeline

this

Iterate over everything in the array at or after the given time. Similar to forEachAfter, but includes the item(s) at the given time.

</>

.get ( )

#
time

The time to query.

type: Number
comparator

Which value in the object to compare

type: String
↪ returns Object

The event object set after that time.

Get the nearest event whose time is less than or equal to the given time.

</>

.getAfter ( )

#
time

The time to query.

type: Number
comparator

Which value in the object to compare

type: String
↪ returns Object

The event object after the given time

Get the event which is scheduled after the given time.

</>

.getBefore ( )

#
time

The time to query.

type: Number
comparator

Which value in the object to compare

type: String
↪ returns Object

The event object before the given time

Get the event before the event at the given time.

</>

.peek ( )

#
↪ returns Object

The first event object

Return the first event in the timeline without removing it

</>

.previousEvent ( )

#
event

The event to find the previous one of

type: Object
↪ returns Object

The event right before the given event

Returns the previous event if there is one. null otherwise

</>

.remove ( )

#
event

The event object to remove from the list.

type: Object
↪ returns Tone.Timeline

this

Remove an event from the timeline.

</>

.add ( )

#
event

The event object to insert into the timeline.

type: Object
↪ returns Tone.Timeline

this

Insert an event object onto the timeline. Events must have a “time” attribute.

</>
docs generated Sep 15 2019