index :: tl

tl.timeline

aliases: [ceammc/timeline], [timeline]

Timeline - event scheduler

available since version: 0.7

---

information

With timeline you can schedule your events and start/pause/stop/move time This time formats for event are supported: clock format - HH:MM:SS.MS, or values like NUMBER UNIT: 10 ms, 10 msec, 20 sec, 30.5s. Note: spaces are ignored. Empty timeline always contains "end" event, that can't be removed. Events are referred by name or by index. Negative indexes are supported: -1 means last event (not "end" event, but last user event)

arguments:

• LENGTH timeline length
  type: float
  units: sec
  

methods:

• add add event to timeline. You can use simple syntax like [add 10.1 sec( to create event with default name, or use advanced: [add myEvent 510ms before end(
  parameters:

  • [NAME=eventN] event name (if ommitted, autogenerated name is used: event1, event2 etc.)
    type: symbol
    

  • [TIME] event time: see info section
    type: list
    

  • [relative] create relative event before or after target event
    type: symbol
    

  • [REL_EVENT] relative event name
    type: symbol
    

• clear remove all timeline events
  

• pause stops timeline at current position
  

• remove remove event by given index or name. [remove event1( or [remove 3(
  parameters:
  • [NAME|IDX] event name or index
    type: atom
    
• remove_at remove event at specified time
  parameters:
  • [TIME] time in supported format. See info section
    type: list
    

• reset reset timeline (call only when stopped)
  

• start start timeline from current position
  

• stop stops timeline and reset current position to the beginning
  

• to_event move time to specified event
  parameters:
  • [NAME|IDX] event or index
    type: atom
    
• to_time move time to time
  parameters:
  • [TIME] time in supported format. See info section
    type: list
    

properties:

• @is_running (readonly) Get if timeline is running
  type: bool
  default: 0
  

• @length (initonly) Get/set timeline length
  type: float
  units: sec
  min value: 0
  default: 60
  

• @size (readonly) Get number of events in timeline
  type: int
  min value: 0
  default: 1
  

• @current (readonly) Get current time
  type: float
  units: ms
  default: 0
  

• @current_sec (readonly) Get current time
  type: float
  units: sec
  default: 0
  

• @phase (readonly) Get current phase in [0-1) range
  type: float
  range: 0..1
  default: 0
  

• @events (readonly) Get list of event names in chronological order
  type: list
  default: end
  

• @loop Get/set loop mode
  type: bool
  default: 0
  

• @mode Get/set timeline mode. If timeline is fixed, when reached, it outputs end event and stops after that. Infinite timeline never stops by itself. Fixed timeline can have @loop property for repeats
  type: symbol
  enum: fixed, inf
  default: fixed
  

inlets:

• control inlet. Non-zero value starts timeline, zero - stops.
  type: control

outlets:

• list: event index, event name, current event time
  type: control

keywords:

timeline

See also: [tl.cue]

Authors: Serge Poltavsky

License: GPL3 or later