Skip to content

Cues

A show is a list of cues. Each one does a single thing when it is fired — play a sound, put a picture on an output, send a message, stop something else — and each has its own page here.

CueWhat it does
AudioPlays a sound file
ImagePuts a still picture on a video output
VideoPlays a video file on a video output
TextPuts words on a video output
HTMLEmbeds a web page on a video output
YouTubeEmbeds a YouTube video on a video output
WebcamPuts a camera on a video output
VisioPuts a remote guest’s camera on a video output
ScreenPuts a shared screen on a video output
MultilaunchFires the cues it holds, all at once
PlaylistFires the cues it holds, one after another
FadeFades another cue to a level
Fade allFades everything out
StartStarts another cue
StopStops another cue
Stop allStops everything
Load showOpens another show
OSCSends an OSC message
MIDISends a MIDI message
MQTTPublishes an MQTT message
HTTPCalls an HTTP endpoint

What every cue has

Whatever its type, a cue carries:

SettingWhat it does
NumberHow you refer to it — also what OSC control uses to fire it
NameFree text, for you
CommentFree text, shown in the cue list
EnabledAn unticked cue is skipped: GO passes over it, a group does not fire it
ColourA tag colour in the cue list
DelaySeconds between firing the cue and it actually starting
Fade inSeconds to ramp up to level, for the cues that carry one
Auto followWhen it ends, fire the next playable cue
ScriptJavaScript that runs with the cue — see scripting

How a cue runs

Three shapes, which decide what “finished” means:

  • Stays up — image, text, html, youtube, webcam, visio, screen, and the two group types. Runs until something stops it.
  • Has a length — audio, video, fade, fade all. Ends on its own, and an auto-follow fires then.
  • Fire and forget — osc, midi, mqtt, http, start, stop, stop all, load show. Does its thing and is gone.

Invalid cues

A cue the engine cannot play is marked Invalid in the list and is skipped: an audio cue with no file, a video cue with no output picked, a YouTube cue with no connection, a cue whose script is enabled but does not compile. The reason shows on the row.