Type: WoControlCue

From Waltz
Revision as of 15:04, 23 July 2019 by Patrick Angle (talk | contribs)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

The WoControlCue type represents a single cue on a Watchout Media Server node. Cues may not be unique, and a cue is only valid for the timeline from which is was retrieved. Using a cue on another timeline or another Watchout instance altogether will result in Waltz attempting its best-guess at how to set the cue in Watchout, normally seeking to the time on the timeline that the cue was supposed to reference on its original timeline.

Constructors

You can not create WoControlCue objects, but a list of them can be retrieved from a Watchout Media Server node or a WoTimeline object using the getCues(…) function. The current cue can be retrieved using the getCurrentCue(…) function.

Parameters

Type Details
name String Note: The parameter is read-only. The name of the cue.
time Time Note: The parameter is read-only. The time at which the cue occurs on the timeline.
transportEvent String Note: The parameter is read-only. The transport event that the cue triggers, either "Play", "Pause", or "Stop".
jumpEvent String Note: The parameter is read-only. The jump event that the cue triggers, either "None", "Time", or "Cue". The time or cue is defined by the jumpTime or jumpCue parameters defined below.
jumpTime Time Note: The parameter is read-only. The time to which the cue jumps, if the jumpEvent is "Time".
jumpCue String Note: The parameter is read-only. The cue name to which the cue jumps, if the jumpEvent is "Cue".
targetTimeline String Note: The parameter is read-only. The name of the timeline this cue is targeting for its action.

Functions

WoControlCue does not define any functions.

Types
Primitives Boolean · Number · String
Objects Color · Dimension · DmxMultiverse · DmxUniverse · LocalInterface · Material · Point · RemoteAddress/IP · Scene · Time · Touch
Node Specific NdiSource · WoControlCue · WoHitTestResult · WoTimeline
Collections List · List of Lists · Map · Varargs
Special Any · Consumer · Expression · Null · Void