The Timeline API contains specific commands for the Timeline Component and Timelines it contains.
Timeline | |||
---|---|---|---|
Properties | |||
Property Name | Return Data Type | Description | |
Timeline.Timelines | Lua Table [Number,String] | This returns a table of Timeline objects indexed by timeline name, individual timelines can be accesed by the format Timelines[“My Timeline”] | |
Timeline.TimelinesByID | Lua Table [Number, String | This returns a lua table of Timeline objects indexed by their ID, only timelines with a valid ID will be included, timelines can be accesed using the format TimelinesByID5 | |
Functions | |||
Function Name | Parameters | Return Data Type | Description |
StopAll | () | Returns Nothing | stops all components |
PlayAll | () | Returns Nothing | Starts all timelines playing |
RewindAll | () | Returns Nothing | rewinds all timelines without changing the play mode (so if timelines were playing they will continue playing but from start) |
MuteAll | () | Returns Nothing | Mutes all timelines, returns nothing |
UnMuteAll | () | Returns Nothing | UnMutes all timelines, returns nothing |
Play | () | Returns Nothing | Plays the Timeline |
Stop | () | Returns Nothing | Stops the Timeline |
Pause | () | Returns Nothing | Pauses the Timeline |
Rewind | () | Returns Nothing | Rewinds the Timeline |
Mute | () | Returns Nothing | Mutes the Timeline |
UnMute | () | Returns Nothing | UnMutes the Timeline |
GotoCue | (cuenumber) | Returns Nothing | jumps playhead to specific cue with cuenumber (cuenumber can be decimal ie. 4.5) |
Timeline object
The Timeline objects referenced in the above tables have the following parameters:
- Name name of timeline – can be read or set
- ID unique ID of timeline as integer – can be read or set
- Start time of first event in timeline in milliseconds – read only
- End time of last event in timeline in milliseconds – read only
- Position position of playhead in milliseconds – can be read or set
- TimecodeEnabled state of timecode enabled, can be read or set
Hinterlasse einen Kommentar.