Documentation
    Preparing search index...

    Class Timeline<GenericEvent>Internal

    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.

    Type Parameters

    Hierarchy (View Summary)

    Index
    constructor
    _timeline debug increasing memory name version
    disposed length
    _search add cancel cancelBefore dispose forEach forEachAfter forEachAtTime forEachBefore forEachBetween forEachFrom get getAfter getBefore log peek previousEvent remove shift toString getDefaults

    Protected_timeline

    _timeline: GenericEvent[]

    The array of scheduled timeline events

    debug: boolean

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

    increasing: boolean

    If the time value must always be greater than or equal to the last element on the list.

    memory: number

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

    name: string

    The name of the class

    version: string

    The version number semver

    • 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

    • get length(): number

      The number of items in the timeline.

      Returns number

    Protected_search

    • _search(time: number, param?: TimelineSearchParam): number

      Does a binary search on the timeline array and returns the nearest event index whose time is after or equal to the given time. If a time is searched before the first index in the timeline, -1 is returned. If the time is after the end, the index of the last item is returned.

      Parameters

      Returns number

    • Insert an event object onto the timeline. Events must have a "time" attribute.

      Parameters

      • event: GenericEvent

        The event object to insert into the timeline.

      Returns this

    • Cancel events at and after the given time

      Parameters

      • after: number

        The time to query.

      Returns this

    • Cancel events before or equal to the given time.

      Parameters

      • time: number

        The time to cancel before.

      Returns this

    • Clean up.

      Returns this

    • Iterate over everything in the array

      Parameters

      • callback: (event: GenericEvent) => void

        The callback to invoke with every item

      Returns this

    • Iterate over everything in the array after the given time.

      Parameters

      • time: number

        The time to check if items are before

      • callback: (event: GenericEvent) => void

        The callback to invoke with every item

      Returns this

    • Iterate over everything in the array at the given time

      Parameters

      • time: number

        The time to check if items are before

      • callback: (event: GenericEvent) => void

        The callback to invoke with every item

      Returns this

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

      Parameters

      • time: number

        The time to check if items are before

      • callback: (event: GenericEvent) => void

        The callback to invoke with every item

      Returns 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).

      Parameters

      • startTime: number

        The time to check if items are before

      • endTime: number

        The end of the test interval.

      • callback: (event: GenericEvent) => void

        The callback to invoke with every item

      Returns 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.

      Parameters

      • time: number

        The time to check if items are before

      • callback: (event: GenericEvent) => void

        The callback to invoke with every item

      Returns this

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

      Parameters

      Returns GenericEvent | null

    • Get the event which is scheduled after the given time.

      Parameters

      Returns GenericEvent | null

    • Get the event before the event at the given time.

      Parameters

      • time: number

        The time to query.

      Returns GenericEvent | null

    • Prints the outputs to the console log for debugging purposes. Prints the contents only if either the object has a property called debug set to true, or a variable called TONE_DEBUG_CLASS is set to the name of the class.

      Parameters

      • ...args: any[]

      Returns void

      const osc = new Tone.Oscillator();
      // prints all logs originating from this oscillator
      osc.debug = true;
      // calls to start/stop will print in the console
      osc.start();

    • Return the first event in the timeline without removing it

      Returns GenericEvent | undefined

      The first event object

    • Returns the previous event if there is one. null otherwise

      Parameters

      Returns GenericEvent | null

      The event right before the given event

    • Remove an event from the timeline.

      Parameters

      • event: GenericEvent

        The event object to remove from the list.

      Returns this

      this

    • Return the first event in the timeline and remove it

      Returns GenericEvent | undefined

    • Convert the class to a string

      Returns string

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

    • Returns all of the default options belonging to the class.

      Returns TimelineOptions

    Settings
    Member Visibility

    On This Page
    Constructors
    Properties
    Accessors
    Methods