The Timeline+ API contains specific commands for the Timeline+ Component and Timelines it contains.
| Timeline+ | ||||
|---|---|---|---|---|
| Properties | ||||
| Property Name | Return Data Type | Description | Example Syntax | |
| 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”] | HippoNet.LocalHost.TimelinePlus.Timelines |
|
| 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 | HippoNet.LocalHost.TimelinePlus.TimelinesByID |
|
| Functions | ||||
| Function Name | Parameters | Return Data Type | Description | Example Syntax |
| StopAll | () | Returns Nothing | stops all timelines playing | HippoNet.LocalHost.TimelinePlus:StopAll() |
| PlayAll | () | Returns Nothing | Starts all timelines playing | HippoNet.LocalHost.TimelinePlus:PlayAll() |
| RewindAll | () | Returns Nothing | rewinds all timelines without changing the play mode (so if timelines were playing they will continue playing but from start) | HippoNet.LocalHost.TimelinePlus:RewindAll() |
| MuteAll | () | Returns Nothing | Mutes all timelines, returns nothing | HippoNet.LocalHost.TimelinePlus:MuteAll() |
| UnMuteAll | () | Returns Nothing | UnMutes all timelines, returns nothing | HippoNet.LocalHost.TimelinePlus:UnMuteAll() |
| Play | () | Returns Nothing | Plays the Timeline | HippoNet.LocalHost.TimelinePlus.Timelines['Colour']:Play() |
| Stop | () | Returns Nothing | Stops the Timeline | HippoNet.LocalHost.TimelinePlus.Timelines['Colour']:Stop() |
| Pause | () | Returns Nothing | Pauses the Timeline | HippoNet.LocalHost.TimelinePlus.Timelines['Colour']:Pause() |
| Mute | () | Returns Nothing | Mutes the Timeline | HippoNet.LocalHost.TimelinePlus.Timelines['Colour']:Mute() |
| UnMute | () | Returns Nothing | UnMutes the Timeline | HippoNet.LocalHost.TimelinePlus.Timelines['Colour']:UnMute() |
| GoCue | (cuenumber, “Action”) | Returns Nothing | jumps playhead to specific cue with cuenumber (cuenumber can be decimal ie. 4.5) and starts action play | HippoNet.LocalHost.TimelinePlus.Timelines['Colour']:GoCue(2,"Play") |
| GoNextCue | () | Returns Nothing | Advances the Playhead to the next cue | HippoNet.LocalHost.TimelinePlus.Timelines['Colour']:GoNextCue() |
| GoPreviousCue | () | Returns Nothing | Advances the Playhead to the previous cue | HippoNet.LocalHost.TimelinePlus.Timelines['Colour']:GoPreviousCue() |
| ForceUpdate | () | Returns Nothing | Updates live values to where the playhead is currently at | HippoNet.LocalHost.TimelinePlus.Timelines['Colour']:ForceUpdate() |
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
Post your comment on this topic.