Documentation - RD/ShowCockpit

Control & Integration Made Easy

Driver Documentation for v3.8.0

This page contains documentation of the available drivers.

Video / Renewed Vision / ProPresenter - Websocket (6)

Interface with ProPresenter through the Websocket interface

< Back to drivers list

    Element Options


IP Address

The IP address of the system running ProPresenter

Port

Port

Password

Password

    Functions


Get Library   LUA Script

Returns a list of all items in the library

Get Current Presentation   LUA Script

Returns the current presentation name

Slides Control   Button LUA Script

Triggers an action on slides
  • Action: The action to perform on slides - one of {Next, Previous, Jump To Slide}
  • Slide Number: Number of the slide to trigger

Get Current Slide   LUA Script

Returns the current slide number

Clear   Button LUA Script

Clears a desired asset
  • Clear Scope: The asset to clear - one of {All, Slide, Props, Audio, Video, Telestrator, To Logo}

Get Stage Display Sets   LUA Script

Returns a list of all stage displays

Stage Display Select   Button Selector LUA Script

Selects a specific display
  • Display Number: Number of the display to trigger (when using a button)

Stage Display Message   Button LUA Script

Display message on stage view
  • Message: Message to display

Stage Hide Message   Button LUA Script

Hide message on stage view

Timeline Control   Button LUA Script

Controls a timeline on the current presentation
  • Action: Action to perform on the timeline - one of {Play / Pause, Rewind}

Clock Control   Button LUA Script

Triggers actions on clocks
  • All Clocks: Enable to act on all clocks
  • Clock Name: The name of the clock (if not acting on all clocks)
  • Action: The action to perform on clock(s) - one of {Start, Stop, Reset}

Get Clock List   LUA Script

Returns a list of all clocks

Get Clock Type   LUA Script

Returns the type of a clock
  • Clock Name: The name of the clock

Get Clock Duration   LUA Script

Returns the duration of a clock
  • Clock Name: The name of the clock

Get Clock End Time   LUA Script

Returns the end time of a clock
  • Clock Name: The name of the clock

Get Clock Current Time   LUA Script

Returns the current time of a clock
  • Clock Name: The name of the clock

Get Clock State   LUA Script

Returns the state of a clock
  • Clock Name: The name of the clock

Get Clock Is PM   LUA Script

Returns true if the clock is has hours in PM format
  • Clock Name: The name of the clock

Get Clock Is Overrun   LUA Script

Returns true if the clock is overrun
  • Clock Name: The name of the clock

Audio Play/Pause   Button LUA Script

Controls the play status of the audio

Audio Play Song   Button LUA Script

Plays one audio song
  • Playlist Name: The name of the playlist where the song is
  • Song Name: The name of the song to play

Get Audio Is Playing   LUA Script

Returns true if the audio is playing

Get Audio Playlists   LUA Script

Returns audio playlists names

Get Audio Current Song Name   LUA Script

Returns current song name

Get Audio Current Song Artist   LUA Script

Returns current song artist

Get Audio Playlist Data   LUA Script

Returns info about an audio playlist
  • Playlist Name: Name of the playlist to get data from