ProPresenter API 6

Accepts one of the following messages:

• #0authenticate (publish)authenticate__pub

  RemoteAuthentication

  This is the first command ProPresenter expects to receive over the websocket. This command requests authentication.

  For ProPresenter 6, the protocol must be 600

  RELATED RESPONSE: authenticate (subscribe)

  Payload

  object

  action

  required

  string

  Const:"authenticate"

  protocol

  required

  number

  Const:600

  password

  required

  string

  as defined in the ProPresenter network settings

  Additional properties are NOT allowed.

  Examples

  Payload

  • #1 Example

    {
      "action": "authenticate",
      "protocol": 600,
      "password": "myGreatPassword"
    }
    

• #1libraryRequest (publish)libraryRequest__pub

  Get Library (all presentations)

  Will return all items in the ProPresenter library.

  • Note that the response will include escaped slashes in path names.

  RELATED RESPONSE: libraryRequest (subscribe)

  Payload

  object

  action

  required

  string

  Const:"libraryRequest"

  Additional properties are NOT allowed.

  Examples

  Payload

  {
    "action": "libraryRequest"
  }
  

  This example has been generated automatically.

• #2playlistRequestAll (publish)playlistRequestAll__pub

  Get Playlists

  Will return all presentation playlists.

  • Presentation playlists and Audio playlists have a similar format
  • A playlist may be a playlistTypePlaylist or a playlistTypeGroup
  • playlistTypePlaylist will contain a list of playlistItemTypePresentation (or playlistItemTypeAudio for audio playlists)
  • playlistTypeGroup may contain both playlistTypePlaylist and playlistTypeGroup

  RELATED RESPONSE: playlistRequestAll (subscribe)

  Payload

  object

  action

  required

  string

  Const:"playlistRequestAll"

  Additional properties are NOT allowed.

  Examples

  Payload

  {
    "action": "playlistRequestAll"
  }
  

  This example has been generated automatically.

• #3presentationRequest (publish)presentationRequest__pub

  Request a Playlist by Location

  NOTE: even though the requested action is presentationRequest Pro6 responds with a presentationCurrent but it will be different. See below.

  RELATED RESPONSE: presentationRequest (subscribe)

  Payload

  object

  action

  required

  string

  Const:"presentationRequest"

  presentationPath

  required

  string

  uid: itemLocation

  A slash-escaped full pathname, file basename, or playlist location.

  Pathname locations need to escape the slashes BEFORE they are encoded to JSON.

  \/Path\/To\/ProPresenter\/Library\/Song 1 Title.pro6
  

  Playlist locations are specified by a zero-based index of the playlist and playlist group in which the item may be found.

  The first item in the first playlist would be "0:0".

  If the first playlist item is a playlist group, then the first item in the first playlist in the first playlist group would be "0.0:0".

  That is, the generalized location is this:

  playlist_index[.child_playlist_index[.deeper_child_index[...]]]:item

  NOTE: Pro6 supports full pathnames or basenames.

  Examples values:
  • "\/Path\/To\/ProPresenter\/Library\/Song 1 Title.pro6"

  presentationSlideQuality

  integer

  Additional properties are NOT allowed.

  Examples

  Payload

  • #1 Example

    {
      "action": "presentationRequest",
      "presentationPath": "\\/Path\\/To\\/ProPresenter\\/Library\\/Song 1 Title.pro6",
      "presentationSlideQuality": 25
    }
    

• #4presentationCurrent (publish)presentationCurrent__pub

  Request Current Presentation

  Requests the currently active presentation if there is one. If no presentation has a slide active, then nothing will be returned.

  NOTE: You can distinguish this response from a presentationRequest request because this response will include presentationPath as a field at the root level of the response.

  RELATED RESPONSE: presentationCurrent (subscribe)

  Payload

  object

  action

  required

  string

  Const:"presentationCurrent"

  presentationSlideQuality

  integer

  Additional properties are NOT allowed.

  Examples

  Payload

  {
    "action": "presentationCurrent",
    "presentationSlideQuality": 0
  }
  

  This example has been generated automatically.

• #5presentationSlideIndex (publish)presentationSlideIndex__pub

  Get the Index of the Current Slide

  • Slides are indexed from 0
  • This response always sends the slideIndex as a string value
  • The ProPresenter remote issues this action every time it does a presentationRequest

  RELATED RESPONSE: presentationSlideIndex (subscribe)

  Payload

  object

  action

  required

  string

  Const:"presentationSlideIndex"

  Additional properties are NOT allowed.

  Examples

  Payload

  {
    "action": "presentationSlideIndex"
  }
  

  This example has been generated automatically.

• #6presentationTriggerIndex (publish)presentationTriggerIndex__pub

  Activate a Slide

  Works just like clicking on a slide

  RELATED RESPONSE: presentationTriggerIndex (subscribe)

  Payload

  object

  action

  required

  string

  Const:"presentationTriggerIndex"

  slideIndex

  required

  integer

  presentationPath

  required

  string

  A slash-escaped full pathname, file basename, or playlist location.

  Pathname locations need to escape the slashes BEFORE they are encoded to JSON.

  \/Path\/To\/ProPresenter\/Library\/Song 1 Title.pro6
  

  Playlist locations are specified by a zero-based index of the playlist and playlist group in which the item may be found.

  The first item in the first playlist would be "0:0".

  If the first playlist item is a playlist group, then the first item in the first playlist in the first playlist group would be "0.0:0".

  That is, the generalized location is this:

  playlist_index[.child_playlist_index[.deeper_child_index[...]]]:item

  NOTE: Pro6 supports full pathnames or basenames.

  Examples values:
  • "\/Path\/To\/ProPresenter\/Library\/Song 1 Title.pro6"

  Additional properties are NOT allowed.

  Examples

  Payload

  {
    "action": "presentationTriggerIndex",
    "slideIndex": 0,
    "presentationPath": "\\/Path\\/To\\/ProPresenter\\/Library\\/Song 1 Title.pro6"
  }
  

  This example has been generated automatically.

• #7presentationTriggerNext (publish)presentationTriggerNext__pub

  Activate the Next Slide

  Works just like hitting the right arrow or spacebar.

  RELATED RESPONSE: presentationTriggerNext (subscribe)

  Payload

  object

  action

  required

  string

  Const:"presentationTriggerNext"

  Additional properties are NOT allowed.

  Examples

  Payload

  {
    "action": "presentationTriggerNext"
  }
  

  This example has been generated automatically.

• #8presentationTriggerPrevious (publish)presentationTriggerPrevious__pub

  Activate the Previous Slide

  Works just like hitting the left arrow.

  RELATED RESPONSE: presentationTriggerPrevious (subscribe)

  Payload

  object

  action

  required

  string

  Const:"presentationTriggerPrevious"

  Additional properties are NOT allowed.

  Examples

  Payload

  {
    "action": "presentationTriggerPrevious"
  }
  

  This example has been generated automatically.

• #9audioRequest (publish)audioRequest__pub

  Get Audio Library

  Will return all the items in the audio library

  RELATED RESPONSE: audioRequest (subscribe)

  Payload

  object

  action

  required

  string

  Const:"audioRequest"

  Additional properties are NOT allowed.

  Examples

  Payload

  {
    "action": "audioRequest"
  }
  

  This example has been generated automatically.

• #10audioCurrentSong (publish)audioCurrentSong__pub

  Get the Current Song

  Will return the data for the currently playing song, if there is one.

  RELATED RESPONSE: audioCurrentSong (subscribe)

  Payload

  object

  action

  required

  string

  Const:"audioCurrentSong"

  Additional properties are NOT allowed.

  Examples

  Payload

  {
    "action": "audioCurrentSong"
  }
  

  This example has been generated automatically.

• #11audioIsPlaying (publish)audioIsPlaying__pub

  Is Audio Playing (BROKEN)

  This api request exists, but it always reports false

  RELATED RESPONSE: audioIsPlaying (subscribe)

  Payload

  object

  action

  required

  string

  Const:"audioIsPlaying"

  Additional properties are NOT allowed.

  Examples

  Payload

  {
    "action": "audioIsPlaying"
  }
  

  This example has been generated automatically.

• #12audioStartCue (publish)audioStartCue__pub

  Start Audio Cue

  This command will result in an audioTriggered message, but since the play/pause status has changed, ProPresenter will also send an audioPlayPause message.

  RELATED RESPONSE: audioStartCue (subscribe)

  Payload

  object

  action

  required

  string

  Const:"audioStartCue"

  audioChildPath

  required

  string

  uid: itemLocation

  A slash-escaped full pathname, file basename, or playlist location.

  Pathname locations need to escape the slashes BEFORE they are encoded to JSON.

  \/Path\/To\/ProPresenter\/Library\/Song 1 Title.pro6
  

  Playlist locations are specified by a zero-based index of the playlist and playlist group in which the item may be found.

  The first item in the first playlist would be "0:0".

  If the first playlist item is a playlist group, then the first item in the first playlist in the first playlist group would be "0.0:0".

  That is, the generalized location is this:

  playlist_index[.child_playlist_index[.deeper_child_index[...]]]:item

  NOTE: Pro6 supports full pathnames or basenames.

  Examples values:
  • "\/Path\/To\/ProPresenter\/Library\/Song 1 Title.pro6"

  Additional properties are NOT allowed.

  Examples

  Payload

  {
    "action": "audioStartCue",
    "audioChildPath": "\\/Path\\/To\\/ProPresenter\\/Library\\/Song 1 Title.pro6"
  }
  

  This example has been generated automatically.

• #13audioPlayPause (publish)audioPlayPause__pub

  Toggle the Audio Play State

  RELATED RESPONSE: audioPlayPause (subscribe)

  Payload

  object

  action

  required

  string

  Const:"audioPlayPause"

  Additional properties are NOT allowed.

  Examples

  Payload

  {
    "action": "audioPlayPause"
  }
  

  This example has been generated automatically.

• #14timelinePlayPause (publish)timelinePlayPause__pub

  Toggle the Timeline Play State

  If presentationPath is missing, Pro6 will crash.

  NO RESPONSE

  Payload

  object

  action

  required

  string

  Const:"timelinePlayPause"

  presentationPath

  required

  string

  uid: itemLocation

  A slash-escaped full pathname, file basename, or playlist location.

  Pathname locations need to escape the slashes BEFORE they are encoded to JSON.

  \/Path\/To\/ProPresenter\/Library\/Song 1 Title.pro6
  

  Playlist locations are specified by a zero-based index of the playlist and playlist group in which the item may be found.

  The first item in the first playlist would be "0:0".

  If the first playlist item is a playlist group, then the first item in the first playlist in the first playlist group would be "0.0:0".

  That is, the generalized location is this:

  playlist_index[.child_playlist_index[.deeper_child_index[...]]]:item

  NOTE: Pro6 supports full pathnames or basenames.

  Examples values:
  • "\/Path\/To\/ProPresenter\/Library\/Song 1 Title.pro6"

  Additional properties are NOT allowed.

  Examples

  Payload

  {
    "action": "timelinePlayPause",
    "presentationPath": "\\/Path\\/To\\/ProPresenter\\/Library\\/Song 1 Title.pro6"
  }
  

  This example has been generated automatically.

• #15timelineRewind (publish)timelineRewind__pub

  Reset the Timeline for a Presentation

  If presentationPath is missing, Pro6 will crash.

  NO RESPONSE

  Payload

  object

  action

  required

  string

  Const:"timelineRewind"

  presentationPath

  required

  string

  uid: itemLocation

  A slash-escaped full pathname, file basename, or playlist location.

  Pathname locations need to escape the slashes BEFORE they are encoded to JSON.

  \/Path\/To\/ProPresenter\/Library\/Song 1 Title.pro6
  

  Playlist locations are specified by a zero-based index of the playlist and playlist group in which the item may be found.

  The first item in the first playlist would be "0:0".

  If the first playlist item is a playlist group, then the first item in the first playlist in the first playlist group would be "0.0:0".

  That is, the generalized location is this:

  playlist_index[.child_playlist_index[.deeper_child_index[...]]]:item

  NOTE: Pro6 supports full pathnames or basenames.

  Examples values:
  • "\/Path\/To\/ProPresenter\/Library\/Song 1 Title.pro6"

  Additional properties are NOT allowed.

  Examples

  Payload

  {
    "action": "timelineRewind",
    "presentationPath": "\\/Path\\/To\\/ProPresenter\\/Library\\/Song 1 Title.pro6"
  }
  

  This example has been generated automatically.

• #16clockRequest (publish)clockRequest__pub

  Request all Clock data

  RELATED RESPONSE: clockRequest (subscribe)

  Payload

  object

  action

  required

  string

  Const:"clockRequest"

  Additional properties are NOT allowed.

  Examples

  Payload

  {
    "action": "clockRequest"
  }
  

  This example has been generated automatically.

• #17clockCurrentTimes (publish)clockCurrentTimes__pub

  Get Current Times for All Clocks

  RELATED RESPONSE: clockCurrentTimes (subscribe)

  Payload

  object

  action

  required

  string

  Const:"clockCurrentTimes"

  Additional properties are NOT allowed.

  Examples

  Payload

  {
    "action": "clockCurrentTimes"
  }
  

  This example has been generated automatically.

• #18clockStartSendingCurrentTime (publish)clockStartSendingCurrentTime__pub

  Subscribe to Clock Updates

  ProPresenter will send one clock update every second even if no clock values have changed.

  The response payload is exactly the same as clockCurrentTimes

  RELATED RESPONSE: clockStartSendingCurrentTime (subscribe)

  Payload

  object

  action

  required

  string

  Const:"clockStartSendingCurrentTime"

  Additional properties are NOT allowed.

  Examples

  Payload

  {
    "action": "clockStartSendingCurrentTime"
  }
  

  This example has been generated automatically.

• #19clockStopSendingCurrentTime (publish)clockStopSendingCurrentTime__pub

  Unsubscribe from Clock Updates

  NO RESPONSE

  Payload

  object

  action

  required

  string

  Const:"clockStopSendingCurrentTime"

  Additional properties are NOT allowed.

  Examples

  Payload

  {
    "action": "clockStopSendingCurrentTime"
  }
  

  This example has been generated automatically.

• #20clockStart (publish)clockStart__pub

  Start a Specific Clock

  RELATED RESPONSE: clockStart (subscribe)

  Payload

  object

  action

  required

  string

  Const:"clockStart"

  clockIndex

  required

  integer

  Additional properties are NOT allowed.

  Examples

  Payload

  {
    "action": "clockStart",
    "clockIndex": 0
  }
  

  This example has been generated automatically.

• #21clockStop (publish)clockStop__pub

  Stop a Specific Clock

  RELATED RESPONSE: clockStop (subscribe)

  Payload

  object

  action

  required

  string

  Const:"clockStop"

  clockIndex

  required

  integer

  Additional properties are NOT allowed.

  Examples

  Payload

  {
    "action": "clockStop",
    "clockIndex": 0
  }
  

  This example has been generated automatically.

• #22clockReset (publish)clockReset__pub

  Reset a clock back to initial settings

  RELATED RESPONSE: clockReset (subscribe)

  Payload

  object

  action

  required

  string

  Const:"clockReset"

  clockIndex

  required

  integer

  Additional properties are NOT allowed.

  Examples

  Payload

  {
    "action": "clockReset",
    "clockIndex": 0
  }
  

  This example has been generated automatically.

• #23clockUpdate (publish)clockUpdate__pub

  Update a Clock (Timer) (eg edit time)

  • Clocks are referenced by index. See reply from "clockRequest" action above to learn indexes.
  • Not all parameters are required for each clock type.
    • Countdown clocks only need "clockTime".
    • Elapsed Time Clocks need "clockTime" and optionally will use "clockElapsedTime" if you send it (to set the End Time).
    • You can rename a clock by optionally including the clockName.
    • Type 0 is Countdown
    • Type 1 is CountDown to Time
    • Type 2 is Elapsed Time.
    • Overrun can be modified if you choose to include that as well.

  NO RESPONSE

  Payload

  object

  action

  required

  string

  Const:"clockUpdate"

  clockIndex

  required

  integer

  Examples values:
  • 1

  clockType

  required

  integer

  Examples values:
  • 0

  clockTime

  required

  string

  Examples values:
  • "09:04:00"

  clockOverrun

  required

  integer

  Examples values:
  • 0

  clockIsPM

  required

  integer

  Examples values:
  • 1

  clocksummary

  required

  string

  Examples values:
  • "Countdown 2"

  clockElapsedTime

  required

  string

  Examples values:
  • "0:02:00"

  Additional properties are NOT allowed.

  Examples

  Payload

  • #1 Example

    {
      "action": "clockUpdate",
      "clockIndex": 1,
      "clockType": 0,
      "clockTime": "09:04:00",
      "clockOverrun": false,
      "clockIsPM": 1,
      "clockName": "Countdown 2",
      "clockElapsedTime": "0:02:00"
    }
    

• #24clockResetAll (publish)clockResetAll__pub

  NO RESPONSE

  Payload

  object

  action

  required

  string

  Const:"clockResetAll"

  Additional properties are NOT allowed.

  Examples

  Payload

  • #1 Example

    {
      "action": "clockResetAll"
    }
    

• #25clockStopAll (publish)clockStopAll__pub

  NO RESPONSE

  Payload

  object

  action

  required

  string

  Const:"clockStopAll"

  Additional properties are NOT allowed.

  Examples

  Payload

  • #1 Example

    {
      "action": "clockStopAll"
    }
    

• #26clockStartAll (publish)clockStartAll__pub

  NO RESPONSE

  Payload

  object

  action

  required

  string

  Const:"clockStartAll"

  Additional properties are NOT allowed.

  Examples

  Payload

  • #1 Example

    {
      "action": "clockStartAll"
    }
    

• #27messageRequest (publish)messageRequest__pub

  Get all Messages

  • The key is everything inside the curly braces ${} so that the key for a countdown looks like this Countdown 1: H:MM:SS.
  • If the key refers to a countdown, the value is used to update the duration field of the countdown timer, but will not perform a "reset".
  • If the key refers to a countdown and the countdown is not running, this will resume it from its current value.

  RELATED RESPONSE: messageRequest (subscribe)

  Payload

  object

  action

  required

  string

  Const:"messageRequest"

  Additional properties are NOT allowed.

  Examples

  Payload

  • #1 Example

    {
      "action": "messageRequest"
    }
    

• #28messageSend (publish)messageSend__pub

  Display a Message

  Display a message identified by its index. Add as many key, value pairs as you like.

  See messageRequest for more information about keys.

  NO RESPONSE

  Payload

  object

  action

  required

  string

  Const:"messageSend"

  messageIndex

  required

  integer

  messageKeys

  required

  tuple<string, ...optional<any>>

  1 item:

  string

  Additional items are allowed.

  messageValues

  required

  tuple<string, ...optional<any>>

  1 item:

  string

  Additional items are allowed.

  Additional properties are NOT allowed.

  Examples

  Payload

  {
    "action": "messageSend",
    "messageIndex": 0,
    "messageKeys": [
      "string"
    ],
    "messageValues": [
      "string"
    ]
  }
  

  This example has been generated automatically.

• #29messageHide (publish)messageHide__pub

  Hide a Message

  Hide a message identified by its index

  NO RESPONSE

  Payload

  object

  action

  required

  string

  Const:"messageHide"

  messageIndex

  required

  integer

  Additional properties are NOT allowed.

  Examples

  Payload

  {
    "action": "messageHide",
    "messageIndex": 0
  }
  

  This example has been generated automatically.

• #30stageDisplaySendMessage (publish)stageDisplaySendMessage__pub

  Show Stage Display Message

  NO RESPONSE

  Payload

  object

  action

  required

  string

  Const:"stageDisplaySendMessage"

  stageDisplayMessage

  required

  string

  Examples values:
  • "Type a Message Here"

  Additional properties are NOT allowed.

  Examples

  Payload

  • #1 Example

    {
      "action": "stageDisplaySendMessage",
      "stageDisplayMessage": "Type a Message Here"
    }
    

• #31stageDisplayHideMessage (publish)stageDisplayHideMessage__pub

  Hide Stage Display Message

  NO RESPONSE

  Payload

  object

  action

  required

  string

  Const:"stageDisplayHideMessage"

  Additional properties are NOT allowed.

  Examples

  Payload

  • #1 Example

    {
      "action": "stageDisplayHideMessage"
    }
    

• #32stageDisplaySetIndex (publish)stageDisplaySetIndex__pub

  Select Stage Display Layout

  EXPECTED RESPONSE IS THE SAME AS THE SENT COMMAND

  RELATED RESPONSE: stageDisplaySetIndex (subscribe)

  Payload

  object

  action

  required

  string

  Const:"stageDisplaySetIndex"

  stageDisplayIndex

  required

  integer

  Examples values:
  • 0

  Additional properties are NOT allowed.

  Examples

  Payload

  • #1 Example

    {
      "action": "stageDisplaySetIndex",
      "stageDisplayIndex": 0
    }
    

• #33stageDisplaySets (publish)stageDisplaySets__pub

  Get Stage Display Layouts

  RELATED RESPONSE: stageDisplaySets (subscribe)

  Payload

  object

  action

  required

  string

  Const:"stageDisplaySets"

  Additional properties are NOT allowed.

  Examples

  Payload

  • #1 Example

    {
      "action": "stageDisplaySets"
    }
    

• #34clearAll (publish)clearAll__pub

  Clear All

  NO RESPONSE

  Payload

  object

  action

  required

  string

  Const:"clearAll"

  Additional properties are NOT allowed.

  Examples

  Payload

  • #1 Example

    {
      "action": "clearAll"
    }
    

• #35clearText (publish)clearText__pub

  Clear Slide

  NO RESPONSE

  Payload

  object

  action

  required

  string

  Const:"clearText"

  Additional properties are NOT allowed.

  Examples

  Payload

  • #1 Example

    {
      "action": "clearText"
    }
    

• #36clearProps (publish)clearProps__pub

  Clear Props

  NO RESPONSE

  Payload

  object

  action

  required

  string

  Const:"clearProps"

  Additional properties are NOT allowed.

  Examples

  Payload

  • #1 Example

    {
      "action": "clearProps"
    }
    

• #37clearAudio (publish)clearAudio__pub

  Clear Audio

  NO RESPONSE

  Payload

  object

  action

  required

  string

  Const:"clearAudio"

  Additional properties are NOT allowed.

  Examples

  Payload

  • #1 Example

    {
      "action": "clearAudio"
    }
    

• #38clearVideo (publish)clearVideo__pub

  Clear Video

  NO RESPONSE

  Payload

  object

  action

  required

  string

  Const:"clearVideo"

  Additional properties are NOT allowed.

  Examples

  Payload

  • #1 Example

    {
      "action": "clearVideo"
    }
    

• #39clearTelestrator (publish)clearTelestrator__pub

  Clear Telestrator

  NO RESPONSE

  Payload

  object

  action

  required

  string

  Const:"clearTelestrator"

  Additional properties are NOT allowed.

  Examples

  Payload

  • #1 Example

    {
      "action": "clearTelestrator"
    }
    

• #40clearToLogo (publish)clearToLogo__pub

  Clear To Logo

  NO RESPONSE

  Payload

  object

  action

  required

  string

  Const:"clearToLogo"

  Additional properties are NOT allowed.

  Examples

  Payload

  • #1 Example

    {
      "action": "clearToLogo"
    }
    

Accepts one of the following messages:

• #0authenticate (subscribe)authenticate__sub

  RemoteAuthentication

  This is the first command ProPresenter expects to receive over the websocket. This command requests authentication.

  For ProPresenter 6, the protocol must be 600

  RELATED COMMAND: authenticate (publish)

  Payload

  object

  action

  required

  string

  Const:"authenticate"

  error

  required

  string

  empty if there is no error, otherwise error message

  authenticated

  required

  integer

  0 for false, 1 for true, (in Pro6, these sometimes show up as strings)

  controller

  required

  integer

  0 for false, 1 for true, (in Pro6, these sometimes show up as strings)

  Additional properties are NOT allowed.

  Examples

  Payload

  • #1 Example

    {
      "controller": 1,
      "authenticated": 1,
      "error": "",
      "action": "authenticate"
    }
    

• #1libraryRequest (subscribe)libraryRequest__sub

  Get Library (all presentations)

  Will return all items in the ProPresenter library.

  • Note that the response will include escaped slashes in path names.

  RELATED COMMAND: libraryRequest (publish)

  Payload

  object

  action

  required

  string

  Const:"libraryRequest"

  library

  required

  tuple<string, ...optional<any>>

  This will be a list of full pathnames for all items in the Presentation library.

  Note the use of slashes in the response. ProPresenter expects library requests to follow this pattern exactly.

  1 item:

  string

  uid: itemLocation

  A slash-escaped full pathname, file basename, or playlist location.

  Pathname locations need to escape the slashes BEFORE they are encoded to JSON.

  \/Path\/To\/ProPresenter\/Library\/Song 1 Title.pro6
  

  Playlist locations are specified by a zero-based index of the playlist and playlist group in which the item may be found.

  The first item in the first playlist would be "0:0".

  If the first playlist item is a playlist group, then the first item in the first playlist in the first playlist group would be "0.0:0".

  That is, the generalized location is this:

  playlist_index[.child_playlist_index[.deeper_child_index[...]]]:item

  NOTE: Pro6 supports full pathnames or basenames.

  Examples values:
  • "\/Path\/To\/ProPresenter\/Library\/Song 1 Title.pro6"

  Additional items are allowed.

  Additional properties are NOT allowed.

  Examples

  Payload

  • #1 Example

    {
      "library": [
        "/Path/To/ProPresenter/Library/Come Alive (Dry Bones).pro6",
        "/Path/To/ProPresenter/Library/Pour Out My Heart.pro6",
        "/Path/To/ProPresenter/Library/Away in a manger.pro6",
        "... ALL PRESENTATIONS IN THE LIBRARY ..."
      ],
      "action": "libraryRequest"
    }
    

• #2playlistRequestAll (subscribe)playlistRequestAll__sub

  Get Playlists

  Will return all presentation playlists.

  • Presentation playlists and Audio playlists have a similar format
  • A playlist may be a playlistTypePlaylist or a playlistTypeGroup
  • playlistTypePlaylist will contain a list of playlistItemTypePresentation (or playlistItemTypeAudio for audio playlists)
  • playlistTypeGroup may contain both playlistTypePlaylist and playlistTypeGroup

  RELATED COMMAND: playlistRequestAll (publish)

  Payload

  object

  action

  required

  string

  Const:"playlistRequestAll"

  playlistAll

  required

  tuple<oneOf, ...optional<any>>

  1 item:

  oneOf

  uid: playlistUnionType

  Adheres to:

  object

  uid: playlistTypeGroup

  playlistType

  required

  string

  Const:"playlistTypeGroup"

  playlistsummary

  required

  string

  playlistLocation

  required

  string

  uid: itemLocation

  A slash-escaped full pathname, file basename, or playlist location.

  Pathname locations need to escape the slashes BEFORE they are encoded to JSON.

  \/Path\/To\/ProPresenter\/Library\/Song 1 Title.pro6
  

  Playlist locations are specified by a zero-based index of the playlist and playlist group in which the item may be found.

  The first item in the first playlist would be "0:0".

  If the first playlist item is a playlist group, then the first item in the first playlist in the first playlist group would be "0.0:0".

  That is, the generalized location is this:

  playlist_index[.child_playlist_index[.deeper_child_index[...]]]:item

  NOTE: Pro6 supports full pathnames or basenames.

  Examples values:
  • "\/Path\/To\/ProPresenter\/Library\/Song 1 Title.pro6"

  playlist

  required

  tuple<oneOf, ...optional<any>> [CIRCULAR]

  Additional properties are NOT allowed.

  Or to:

  object

  uid: playlistTypePlaylist

  playlistLocation

  required

  string

  uid: itemLocation

  A slash-escaped full pathname, file basename, or playlist location.

  Pathname locations need to escape the slashes BEFORE they are encoded to JSON.

  \/Path\/To\/ProPresenter\/Library\/Song 1 Title.pro6
  

  Playlist locations are specified by a zero-based index of the playlist and playlist group in which the item may be found.

  The first item in the first playlist would be "0:0".

  If the first playlist item is a playlist group, then the first item in the first playlist in the first playlist group would be "0.0:0".

  That is, the generalized location is this:

  playlist_index[.child_playlist_index[.deeper_child_index[...]]]:item

  NOTE: Pro6 supports full pathnames or basenames.

  Examples values:
  • "\/Path\/To\/ProPresenter\/Library\/Song 1 Title.pro6"

  playlistType

  required

  string

  Const:"playlistTypePlaylist"

  playlistsummary

  required

  string

  playlist

  required

  tuple<object, ...optional<any>>

  1 item:

  object

  uid: playlistItemType

  playlistItemType

  required

  string

  Allowed values:
  • "playlistItemTypeAudio"
  • "playlistItemTypePresentation"

  playlistItemLocation

  required

  string

  uid: itemLocation

  A slash-escaped full pathname, file basename, or playlist location.

  Pathname locations need to escape the slashes BEFORE they are encoded to JSON.

  \/Path\/To\/ProPresenter\/Library\/Song 1 Title.pro6
  

  Playlist locations are specified by a zero-based index of the playlist and playlist group in which the item may be found.

  The first item in the first playlist would be "0:0".

  If the first playlist item is a playlist group, then the first item in the first playlist in the first playlist group would be "0.0:0".

  That is, the generalized location is this:

  playlist_index[.child_playlist_index[.deeper_child_index[...]]]:item

  NOTE: Pro6 supports full pathnames or basenames.

  Examples values:
  • "\/Path\/To\/ProPresenter\/Library\/Song 1 Title.pro6"

  playlistItemsummary

  required

  string

  playlistItemArtist

  required

  string

  only present for playlistItemTypeAudio

  Additional properties are NOT allowed.

  Additional items are allowed.

  Additional properties are NOT allowed.

  Additional items are allowed.

  Additional properties are NOT allowed.

  Examples

  Payload

  • #1 Example

    {
      "playlistAll": [
        {
          "playlistLocation": "0",
          "playlistType": "playlistTypePlaylist",
          "playlistName": "Default",
          "playlist": [
            {
              "playlistItemName": "!~ PRE-SERVICE",
              "playlistItemLocation": "0:0",
              "playlistItemType": "playlistItemTypePresentation"
            }
          ]
        },
        {
          "playlistLocation": "1",
          "playlistType": "playlistTypeGroup",
          "playlistName": "2017",
          "playlist": [
            {
              "playlistLocation": "1.0",
              "playlistType": "playlistTypePlaylist",
              "playlistName": "2017-01-28-Vision Dinner",
              "playlist": [
                {
                  "playlistItemName": "!MISC2",
                  "playlistItemLocation": "1.0:0",
                  "playlistItemType": "playlistItemTypePresentation"
                },
                {
                  "playlistItemName": "!MISC1",
                  "playlistItemLocation": "1.0:1",
                  "playlistItemType": "playlistItemTypePresentation"
                }
              ]
            }
          ]
        }
      ],
      "action": "playlistRequestAll"
    }
    

• #3presentationRequest (subscribe)presentationRequest__sub

  Request a Playlist by Location

  NOTE: even though the requested action is presentationRequest Pro6 responds with a presentationCurrent but it will be different. See below.

  RELATED COMMAND: presentationRequest (publish)

  Payload

  object

  action

  required

  string

  Const:"presentationCurrent"

  presentation

  required

  object

  uid: presentation

  presentationSlideGroups

  required

  tuple<object, ...optional<any>>

  1 item:

  object

  uid: presentationSlideGroup

  groupsummary

  required

  string

  groupColor

  required

  string

  uid: color

  four space-delimited doubles describing the r,g,b,a values of a color from 0-1

  Examples values:
  • "0.5 0.8 1 0.5"

  groupSlides

  required

  tuple<object, ...optional<any>>

  1 item:

  object

  uid: presentationSlide

  slideEnabled

  required

  boolean

  slideNotes

  required

  string

  slideAttachmentMask

  required

  integer

  unknown

  slideText

  required

  string

  slideImage

  required

  string

  base64 encoded jpeg image

  slideIndex

  required

  integer

  it is the zero-based index of the slide in a presentation

  NOTE: it is sometimes transmitted as a JSON string and sometimes a JSON number

  slideTransitionType

  required

  integer

  -1 for default transition or another number for a different transition

  slideLabel

  required

  string

  slideColor

  required

  string

  uid: color

  four space-delimited doubles describing the r,g,b,a values of a color from 0-1

  Examples values:
  • "0.5 0.8 1 0.5"

  Additional properties are NOT allowed.

  Additional items are allowed.

  Additional properties are NOT allowed.

  Additional items are allowed.

  presentationsummary

  required

  string

  presentationHasTimeline

  required

  integer

  uid: boolint

  0 for false, 1 for true, (in Pro6, these sometimes show up as strings)

  presentationCurrentLocation

  required

  string

  This field contains the location of the currently active presentation if there is one.

  It only refers to the location of this presentation if we asked for presentationCurrent

  Examples values:
  • "\/Path\/To\/ProPresenter\/Library\/Song 1 Title.pro6"

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  Examples

  Payload

  • #1 Example

    {
      "action": "presentationCurrent",
      "presentation": {
        "presentationSlideGroups": [
          {
            "groupName": "[SLIDE GROUP NAME]",
            "groupColor": "0 0 0 1",
            "groupSlides": [
              {
                "slideEnabled": true,
                "slideNotes": "",
                "slideAttachmentMask": 0,
                "slideText": "[SLIDE TEXT HERE]",
                "slideImage": "[BASE64 ENCODED IMAGE]",
                "slideIndex": "0",
                "slideTransitionType": -1,
                "slideLabel": "[SLIDE LABEL]",
                "slideColor": "0 0 0 1"
              }
            ]
          }
        ],
        "presentationName": "[PRESENTATION TITLE]",
        "presentationHasTimeline": 0,
        "presentationCurrentLocation": "[PRESENTATION PATH OF CURRENTLY ACTIVE SLIDE]"
      }
    }
    

• #4presentationCurrent (subscribe)presentationCurrent__sub

  Request Current Presentation

  Requests the currently active presentation if there is one. If no presentation has a slide active, then nothing will be returned.

  NOTE: You can distinguish this response from a presentationRequest request because this response will include presentationPath as a field at the root level of the response.

  RELATED COMMAND: presentationCurrent (publish)

  Payload

  object

  action

  required

  string

  Const:"presentationCurrent"

  presentationPath

  required

  string

  uid: itemLocation

  A slash-escaped full pathname, file basename, or playlist location.

  Pathname locations need to escape the slashes BEFORE they are encoded to JSON.

  \/Path\/To\/ProPresenter\/Library\/Song 1 Title.pro6
  

  Playlist locations are specified by a zero-based index of the playlist and playlist group in which the item may be found.

  The first item in the first playlist would be "0:0".

  If the first playlist item is a playlist group, then the first item in the first playlist in the first playlist group would be "0.0:0".

  That is, the generalized location is this:

  playlist_index[.child_playlist_index[.deeper_child_index[...]]]:item

  NOTE: Pro6 supports full pathnames or basenames.

  Examples values:
  • "\/Path\/To\/ProPresenter\/Library\/Song 1 Title.pro6"

  presentation

  required

  object

  uid: presentation

  presentationSlideGroups

  required

  tuple<object, ...optional<any>>

  1 item:

  object

  uid: presentationSlideGroup

  groupsummary

  required

  string

  groupColor

  required

  string

  uid: color

  four space-delimited doubles describing the r,g,b,a values of a color from 0-1

  Examples values:
  • "0.5 0.8 1 0.5"

  groupSlides

  required

  tuple<object, ...optional<any>>

  1 item:

  object

  uid: presentationSlide

  slideEnabled

  required

  boolean

  slideNotes

  required

  string

  slideAttachmentMask

  required

  integer

  unknown

  slideText

  required

  string

  slideImage

  required

  string

  base64 encoded jpeg image

  slideIndex

  required

  integer

  it is the zero-based index of the slide in a presentation

  NOTE: it is sometimes transmitted as a JSON string and sometimes a JSON number

  slideTransitionType

  required

  integer

  -1 for default transition or another number for a different transition

  slideLabel

  required

  string

  slideColor

  required

  string

  uid: color

  four space-delimited doubles describing the r,g,b,a values of a color from 0-1

  Examples values:
  • "0.5 0.8 1 0.5"

  Additional properties are NOT allowed.

  Additional items are allowed.

  Additional properties are NOT allowed.

  Additional items are allowed.

  presentationsummary

  required

  string

  presentationHasTimeline

  required

  integer

  uid: boolint

  0 for false, 1 for true, (in Pro6, these sometimes show up as strings)

  presentationCurrentLocation

  required

  string

  This field contains the location of the currently active presentation if there is one.

  It only refers to the location of this presentation if we asked for presentationCurrent

  Examples values:
  • "\/Path\/To\/ProPresenter\/Library\/Song 1 Title.pro6"

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  Examples

  Payload

  {
    "action": "presentationCurrent",
    "presentationPath": "\\/Path\\/To\\/ProPresenter\\/Library\\/Song 1 Title.pro6",
    "presentation": {
      "presentationSlideGroups": [
        {
          "groupsummary": "string",
          "groupColor": "0.5 0.8 1 0.5",
          "groupSlides": [
            {
              "slideEnabled": true,
              "slideNotes": "string",
              "slideAttachmentMask": 0,
              "slideText": "string",
              "slideImage": "string",
              "slideIndex": 0,
              "slideTransitionType": 0,
              "slideLabel": "string",
              "slideColor": "0.5 0.8 1 0.5"
            }
          ]
        }
      ],
      "presentationsummary": "string",
      "presentationHasTimeline": 0,
      "presentationCurrentLocation": "\\/Path\\/To\\/ProPresenter\\/Library\\/Song 1 Title.pro6"
    }
  }
  

  This example has been generated automatically.

• #5presentationSlideIndex (subscribe)presentationSlideIndex__sub

  Get the Index of the Current Slide

  • Slides are indexed from 0
  • This response always sends the slideIndex as a string value
  • The ProPresenter remote issues this action every time it does a presentationRequest

  RELATED COMMAND: presentationSlideIndex (publish)

  Payload

  object

  action

  required

  string

  Const:"presentationSlideIndex"

  slideIndex

  required

  string

  Examples values:
  • 0

  Additional properties are NOT allowed.

  Examples

  Payload

  {
    "action": "presentationSlideIndex",
    "slideIndex": 0
  }
  

  This example has been generated automatically.

• #6presentationTriggerIndex (subscribe)presentationTriggerIndex__sub

  Activate a Slide

  Works just like clicking on a slide

  RELATED COMMAND: presentationTriggerIndex (publish)

  Payload

  object

  uid: presentationTriggerMessage

  action

  required

  string

  Const:"presentationTriggerIndex"

  slideIndex

  required

  integer

  presentationPath

  required

  string

  If the current presentation was selected from a playlist, it will report the playlist location (i.e. 0:0), but if it was selected from the Library directly, the path value will always be the basename only.

  Examples values:
  • "\/Path\/To\/ProPresenter\/Library\/Song 1 Title.pro6"

  Additional properties are NOT allowed.

  Examples

  Payload

  {
    "action": "presentationTriggerIndex",
    "slideIndex": 0,
    "presentationPath": "\\/Path\\/To\\/ProPresenter\\/Library\\/Song 1 Title.pro6"
  }
  

  This example has been generated automatically.

• #7presentationTriggerNext (subscribe)presentationTriggerNext__sub

  Activate the Next Slide

  Works just like hitting the right arrow or spacebar.

  RELATED COMMAND: presentationTriggerNext (publish)

  Payload

  object

  uid: presentationTriggerMessage

  action

  required

  string

  Const:"presentationTriggerIndex"

  slideIndex

  required

  integer

  presentationPath

  required

  string

  If the current presentation was selected from a playlist, it will report the playlist location (i.e. 0:0), but if it was selected from the Library directly, the path value will always be the basename only.

  Examples values:
  • "\/Path\/To\/ProPresenter\/Library\/Song 1 Title.pro6"

  Additional properties are NOT allowed.

  Examples

  Payload

  {
    "action": "presentationTriggerIndex",
    "slideIndex": 0,
    "presentationPath": "\\/Path\\/To\\/ProPresenter\\/Library\\/Song 1 Title.pro6"
  }
  

  This example has been generated automatically.

• #8presentationTriggerPrevious (subscribe)presentationTriggerPrevious__sub

  Activate the Previous Slide

  Works just like hitting the left arrow.

  RELATED COMMAND: presentationTriggerPrevious (publish)

  Payload

  object

  uid: presentationTriggerMessage

  action

  required

  string

  Const:"presentationTriggerIndex"

  slideIndex

  required

  integer

  presentationPath

  required

  string

  If the current presentation was selected from a playlist, it will report the playlist location (i.e. 0:0), but if it was selected from the Library directly, the path value will always be the basename only.

  Examples values:
  • "\/Path\/To\/ProPresenter\/Library\/Song 1 Title.pro6"

  Additional properties are NOT allowed.

  Examples

  Payload

  {
    "action": "presentationTriggerIndex",
    "slideIndex": 0,
    "presentationPath": "\\/Path\\/To\\/ProPresenter\\/Library\\/Song 1 Title.pro6"
  }
  

  This example has been generated automatically.

• #9audioRequest (subscribe)audioRequest__sub

  Get Audio Library

  Will return all the items in the audio library

  RELATED COMMAND: audioRequest (publish)

  Payload

  object

  action

  required

  string

  Const:"audioRequest"

  audioPlaylist

  required

  tuple<oneOf, ...optional<any>>

  1 item:

  oneOf

  uid: playlistUnionType

  Adheres to:

  object

  uid: playlistTypeGroup

  playlistType

  required

  string

  Const:"playlistTypeGroup"

  playlistsummary

  required

  string

  playlistLocation

  required

  string

  uid: itemLocation

  A slash-escaped full pathname, file basename, or playlist location.

  Pathname locations need to escape the slashes BEFORE they are encoded to JSON.

  \/Path\/To\/ProPresenter\/Library\/Song 1 Title.pro6
  

  Playlist locations are specified by a zero-based index of the playlist and playlist group in which the item may be found.

  The first item in the first playlist would be "0:0".

  If the first playlist item is a playlist group, then the first item in the first playlist in the first playlist group would be "0.0:0".

  That is, the generalized location is this:

  playlist_index[.child_playlist_index[.deeper_child_index[...]]]:item

  NOTE: Pro6 supports full pathnames or basenames.

  Examples values:
  • "\/Path\/To\/ProPresenter\/Library\/Song 1 Title.pro6"

  playlist

  required

  tuple<oneOf, ...optional<any>> [CIRCULAR]

  Additional properties are NOT allowed.

  Or to:

  object

  uid: playlistTypePlaylist

  playlistLocation

  required

  string

  uid: itemLocation

  A slash-escaped full pathname, file basename, or playlist location.

  Pathname locations need to escape the slashes BEFORE they are encoded to JSON.

  \/Path\/To\/ProPresenter\/Library\/Song 1 Title.pro6
  

  Playlist locations are specified by a zero-based index of the playlist and playlist group in which the item may be found.

  The first item in the first playlist would be "0:0".

  If the first playlist item is a playlist group, then the first item in the first playlist in the first playlist group would be "0.0:0".

  That is, the generalized location is this:

  playlist_index[.child_playlist_index[.deeper_child_index[...]]]:item

  NOTE: Pro6 supports full pathnames or basenames.

  Examples values:
  • "\/Path\/To\/ProPresenter\/Library\/Song 1 Title.pro6"

  playlistType

  required

  string

  Const:"playlistTypePlaylist"

  playlistsummary

  required

  string

  playlist

  required

  tuple<object, ...optional<any>>

  1 item:

  object

  uid: playlistItemType

  playlistItemType

  required

  string

  Allowed values:
  • "playlistItemTypeAudio"
  • "playlistItemTypePresentation"

  playlistItemLocation

  required

  string

  uid: itemLocation

  A slash-escaped full pathname, file basename, or playlist location.

  Pathname locations need to escape the slashes BEFORE they are encoded to JSON.

  \/Path\/To\/ProPresenter\/Library\/Song 1 Title.pro6
  

  Playlist locations are specified by a zero-based index of the playlist and playlist group in which the item may be found.

  The first item in the first playlist would be "0:0".

  If the first playlist item is a playlist group, then the first item in the first playlist in the first playlist group would be "0.0:0".

  That is, the generalized location is this:

  playlist_index[.child_playlist_index[.deeper_child_index[...]]]:item

  NOTE: Pro6 supports full pathnames or basenames.

  Examples values:
  • "\/Path\/To\/ProPresenter\/Library\/Song 1 Title.pro6"

  playlistItemsummary

  required

  string

  playlistItemArtist

  required

  string

  only present for playlistItemTypeAudio

  Additional properties are NOT allowed.

  Additional items are allowed.

  Additional properties are NOT allowed.

  Additional items are allowed.

  Additional properties are NOT allowed.

  Examples

  Payload

  {
    "action": "audioRequest",
    "audioPlaylist": [
      {
        "playlistType": "playlistTypeGroup",
        "playlistsummary": "string",
        "playlistLocation": "\\/Path\\/To\\/ProPresenter\\/Library\\/Song 1 Title.pro6",
        "playlist": [
          {}
        ]
      }
    ]
  }
  

  This example has been generated automatically.

• #10audioCurrentSong (subscribe)audioCurrentSong__sub

  Get the Current Song

  Will return the data for the currently playing song, if there is one.

  RELATED COMMAND: audioCurrentSong (publish)

  Payload

  object

  action

  required

  string

  Const:"audioCurrentSong"

  audioArtist

  required

  string

  audiosummary

  required

  string

  Additional properties are NOT allowed.

  Examples

  Payload

  • #1 Example

    {
      "audioArtist": "",
      "action": "audioCurrentSong",
      "audioName": "Peaceful Instrumental - C"
    }
    

• #11audioIsPlaying (subscribe)audioIsPlaying__sub

  Is Audio Playing (BROKEN)

  This api request exists, but it always reports false

  RELATED COMMAND: audioIsPlaying (publish)

  Payload

  object

  action

  required

  string

  Const:"audioIsPlaying"

  audioIsPlaying

  required

  boolean

  Const:

  Additional properties are NOT allowed.

  Examples

  Payload

  {
    "action": "audioIsPlaying",
    "audioIsPlaying": false
  }
  

  This example has been generated automatically.

• #12audioStartCue (subscribe)audioStartCue__sub

  Start Audio Cue

  This command will result in an audioTriggered message, but since the play/pause status has changed, ProPresenter will also send an audioPlayPause message.

  RELATED COMMAND: audioStartCue (publish)

  Payload

  object

  action

  required

  string

  Const:"audioTriggered"

  audioArtist

  required

  string

  audiosummary

  required

  string

  Additional properties are NOT allowed.

  Examples

  Payload

  • #1 Example

    {
      "audioArtist": "",
      "action": "audioTriggered",
      "audioName": "Peaceful Instrumental - C"
    }
    

• #13audioPlayPause (subscribe)audioPlayPause__sub

  Toggle the Audio Play State

  RELATED COMMAND: audioPlayPause (publish)

  Payload

  object

  action

  required

  string

  Const:"audioPlayPause"

  audioPlayPause

  required

  string

  Allowed values:
  • "Play"
  • "Pause"

  Additional properties are NOT allowed.

  Examples

  Payload

  {
    "action": "audioPlayPause",
    "audioPlayPause": "Play"
  }
  

  This example has been generated automatically.

• #14clockRequest (subscribe)clockRequest__sub

  Request all Clock data

  RELATED COMMAND: clockRequest (publish)

  Payload

  object

  action

  required

  string

  Const:"clockRequest"

  clockInfo

  required

  tuple<object, ...optional<any>>

  1 item:

  object

  uid: clockDetail

  clockType

  required

  integer

  uid: clockType

  0 is Countdown, 1 is Countdown to Time, 2 is Elapsed Time

  Allowed values:
  • 0
  • 1
  • 2

  clockState

  required

  boolean

  running is true, not running is false

  clocksummary

  required

  string

  clockIsPM

  required

  integer

  uid: boolint

  0 for false, 1 for true, (in Pro6, these sometimes show up as strings)

  clockTime

  required

  string

  uid: clockTimeString

  • real times are formatted as "H:MM:SS" (no padding on the leading H)
  • negative times are possible with a leading -.
  • empty times are "--:--:--"

  clockEndTime

  required

  string

  uid: clockTimeString

  • real times are formatted as "H:MM:SS" (no padding on the leading H)
  • negative times are possible with a leading -.
  • empty times are "--:--:--"

  clockDuration

  required

  string

  uid: clockTimeString

  • real times are formatted as "H:MM:SS" (no padding on the leading H)
  • negative times are possible with a leading -.
  • empty times are "--:--:--"

  clockOverrun

  required

  boolean

  indicates if clock should keep running after it hits the endtime.

  Additional properties are NOT allowed.

  Additional items are allowed.

  Additional properties are NOT allowed.

  Examples

  Payload

  {
    "action": "clockRequest",
    "clockInfo": [
      {
        "clockType": 0,
        "clockState": true,
        "clocksummary": "string",
        "clockIsPM": 0,
        "clockTime": "string",
        "clockEndTime": "string",
        "clockDuration": "string",
        "clockOverrun": true
      }
    ]
  }
  

  This example has been generated automatically.

• #15clockCurrentTimes (subscribe)clockCurrentTimes__sub

  Get Current Times for All Clocks

  RELATED COMMAND: clockCurrentTimes (publish)

  Payload

  object

  uid: clockCurrentTimesMessage

  Examples values:
  • {"action":"clockCurrentTimes","clockTimes":["0:10:00","--:--:--","13:52:23"]}

  action

  required

  string

  Const:"clockCurrentTimes"

  clockTimes

  required

  tuple<string, ...optional<any>>

  1 item:

  string

  uid: clockTimeString

  • real times are formatted as "H:MM:SS" (no padding on the leading H)
  • negative times are possible with a leading -.
  • empty times are "--:--:--"

  Additional items are allowed.

  Additional properties are NOT allowed.

  Examples

  Payload

  • #1 Example

    {
      "action": "clockCurrentTimes",
      "clockTimes": [
        "0:10:00",
        "--:--:--",
        "13:52:23"
      ]
    }
    

• #16clockStartSendingCurrentTime (subscribe)clockStartSendingCurrentTime__sub

  Subscribe to Clock Updates

  ProPresenter will send one clock update every second even if no clock values have changed.

  The response payload is exactly the same as clockCurrentTimes

  RELATED COMMAND: clockStartSendingCurrentTime (publish)

  Payload

  object

  uid: clockCurrentTimesMessage

  Examples values:
  • {"action":"clockCurrentTimes","clockTimes":["0:10:00","--:--:--","13:52:23"]}

  action

  required

  string

  Const:"clockCurrentTimes"

  clockTimes

  required

  tuple<string, ...optional<any>>

  1 item:

  string

  uid: clockTimeString

  • real times are formatted as "H:MM:SS" (no padding on the leading H)
  • negative times are possible with a leading -.
  • empty times are "--:--:--"

  Additional items are allowed.

  Additional properties are NOT allowed.

  Examples

  Payload

  • #1 Example

    {
      "action": "clockCurrentTimes",
      "clockTimes": [
        "0:10:00",
        "--:--:--",
        "13:52:23"
      ]
    }
    

• #17clockStart (subscribe)clockStart__sub

  Start a Specific Clock

  RELATED COMMAND: clockStart (publish)

  Payload

  object

  uid: clockStartStopMessage

  action

  required

  string

  Const:"clockStartStop"

  clockTime

  required

  string

  uid: clockTimeString

  • real times are formatted as "H:MM:SS" (no padding on the leading H)
  • negative times are possible with a leading -.
  • empty times are "--:--:--"

  clockState

  required

  integer

  0 for false, 1 for true, (in Pro6, these sometimes show up as strings)

  clockIndex

  required

  integer

  zero-based clock index, clock lists are in a stable order

  clockInfo

  required

  array<any>

  uid: clockQuickInfo

  Additional properties are NOT allowed.

  Examples

  Payload

  {
    "action": "clockStartStop",
    "clockTime": "string",
    "clockState": 0,
    "clockIndex": 0,
    "clockInfo": []
  }
  

  This example has been generated automatically.

• #18clockStop (subscribe)clockStop__sub

  Stop a Specific Clock

  RELATED COMMAND: clockStop (publish)

  Payload

  object

  uid: clockStartStopMessage

  action

  required

  string

  Const:"clockStartStop"

  clockTime

  required

  string

  uid: clockTimeString

  • real times are formatted as "H:MM:SS" (no padding on the leading H)
  • negative times are possible with a leading -.
  • empty times are "--:--:--"

  clockState

  required

  integer

  0 for false, 1 for true, (in Pro6, these sometimes show up as strings)

  clockIndex

  required

  integer

  zero-based clock index, clock lists are in a stable order

  clockInfo

  required

  array<any>

  uid: clockQuickInfo

  Additional properties are NOT allowed.

  Examples

  Payload

  {
    "action": "clockStartStop",
    "clockTime": "string",
    "clockState": 0,
    "clockIndex": 0,
    "clockInfo": []
  }
  

  This example has been generated automatically.

• #19clockReset (subscribe)clockReset__sub

  Reset a clock back to initial settings

  RELATED COMMAND: clockReset (publish)

  Payload

  object

  action

  required

  string

  Const:"clockResetIndex"

  Additional properties are NOT allowed.

  Examples

  Payload

  {
    "action": "clockResetIndex"
  }
  

  This example has been generated automatically.

• #20messageRequest (subscribe)messageRequest__sub

  Get all Messages

  • The key is everything inside the curly braces ${} so that the key for a countdown looks like this Countdown 1: H:MM:SS.
  • If the key refers to a countdown, the value is used to update the duration field of the countdown timer, but will not perform a "reset".
  • If the key refers to a countdown and the countdown is not running, this will resume it from its current value.

  RELATED COMMAND: messageRequest (publish)

  Payload

  object

  action

  required

  string

  Const:"messageRequest"

  messages

  required

  tuple<object, ...optional<any>>

  1 item:

  object

  uid: screenMessage

  Examples values:
  • {"messageComponents":["Session will begin in: ","${Countdown 1: H:MM:SS}","."],"messageTitle":"Countdown"}

  messageComponents

  required

  tuple<string, ...optional<any>>

  Each string is either a literal string or a variable expansion, which will be concatenated together to make the final on screen message.

  The content inside a ${} is referred to as a messageKey in later commands

  1 item:

  string

  Additional items are allowed.

  messageTitle

  required

  string

  Additional properties are NOT allowed.

  Additional items are allowed.

  Additional properties are NOT allowed.

  Examples

  Payload

  • #1 Example

    {
      "action": "messageRequest",
      "messages": [
        {
          "messageComponents": [
            "message:",
            "${Message}"
          ],
          "messageTitle": "Message"
        },
        {
          "messageComponents": [
            "Session will begin in: ",
            "${Countdown 1: H:MM:SS}"
          ],
          "messageTitle": "Countdown"
        },
        {
          "messageComponents": [
            "${Message}"
          ],
          "messageTitle": "Message"
        },
        {
          "messageComponents": [
            "Service starts in ",
            "${countDownTimerName_1: H:MM:SS}"
          ],
          "messageTitle": "Countdown"
        }
      ]
    }
    

• #21stageDisplaySetIndex (subscribe)stageDisplaySetIndex__sub

  Select Stage Display Layout

  EXPECTED RESPONSE IS THE SAME AS THE SENT COMMAND

  RELATED COMMAND: stageDisplaySetIndex (publish)

  Payload

  object

  action

  required

  string

  Const:"stageDisplaySetIndex"

  stageDisplayIndex

  required

  integer

  Examples values:
  • 0

  Additional properties are NOT allowed.

  Examples

  Payload

  • #1 Example

    {
      "action": "stageDisplaySetIndex",
      "stageDisplayIndex": 0
    }
    

• #22stageDisplaySets (subscribe)stageDisplaySets__sub

  Get Stage Display Layouts

  RELATED COMMAND: stageDisplaySets (publish)

  Payload

  object

  action

  required

  string

  Const:"stageDisplaySets"

  stageDisplayIndex

  required

  integer

  Examples values:
  • 4

  stageDisplaySets

  required

  tuple<string, ...optional<any>>

  1 item:

  string

  Additional items are allowed.

  Additional properties are NOT allowed.

  Examples

  Payload

  • #1 Example

    {
      "stageDisplayIndex": 4,
      "action": "stageDisplaySets",
      "stageDisplaySets": [
        "Default",
        "Easter Closer",
        "Live Current - Static Next - no borders",
        "Static Current - Static Next",
        "Songs",
        "Slides"
      ]
    }
    

Accepts one of the following messages:

• #0ath (publish)ath__pub

  StageDisplayAuthentication

  RELATED RESPONSE: ath (subscribe)

  Payload

  object

  acn

  required

  string

  Const:"ath"

  ptl

  required

  number

  Const:610

  pwd

  required

  string

  Additional properties are NOT allowed.

  Examples

  Payload

  • #1 Example

    {
      "pwd": "PASSWORD",
      "ptl": 610,
      "acn": "ath"
    }
    

• #1asl (publish)asl__pub

  Get All Stage Display Layouts

  • acn of asl means "all stage layouts"
  • ary indicates array of stage layouts

  RELATED RESPONSE: asl (subscribe)

  Payload

  object

  acn

  required

  string

  Const:"asl"

  Additional properties are NOT allowed.

  Examples

  Payload

  • #1 Example

    {
      "acn": "asl"
    }
    

• #2psl (publish)psl__pub

  Request Current Stage Display Layout

  RELATED RESPONSE: psl (subscribe)

  Payload

  object

  acn

  required

  string

  Const:"psl"

  Additional properties are NOT allowed.

  Examples

  Payload

  • #1 Example

    {
      "acn": "psl"
    }
    

• #3fv (publish)fv__pub

  Request Frame Values for Stage Display

  When the frame value is pushed as a result of a slide trigger event, only cs, ns, csn, nsn will be sent.

  Applications should listen for all the other acn values separately.

  RELATED RESPONSE: fv (subscribe)

  Payload

  object

  acn

  required

  string

  Const:"fv"

  uid

  required

  string

  Additional properties are NOT allowed.

  Examples

  Payload

  • #1 Example

    {
      "acn": "fv",
      "uid": "F8260B13-9C5B-4D2C-80F1-C72346759F11"
    }
    

Accepts one of the following messages:

• #0ath (subscribe)ath__sub

  StageDisplayAuthentication

  RELATED COMMAND: ath (publish)

  Payload

  object

  acn

  required

  string

  Const:"ath"

  ath

  required

  boolean

  err

  required

  string

  Additional properties are NOT allowed.

  Examples

  Payload

  • #1 Example

    {
      "acn": "ath",
      "ath": true,
      "err": ""
    }
    

• #1asl (subscribe)asl__sub

  Get All Stage Display Layouts

  • acn of asl means "all stage layouts"
  • ary indicates array of stage layouts

  RELATED COMMAND: asl (publish)

  Payload

  object

  acn

  required

  string

  Const:"asl"

  ary

  required

  tuple<object, ...optional<any>>

  1 item:

  object

  uid: stageDisplayLayout

  • nme indicates layout name
  • ovr indicates if overrun color should be used
  • oCl indicates color for timer overruns
  • brd indicates if borders and labels should be used
  • uid indicates layout uid
  • zro indicates if zeroes should be removed from times
  • fme indicates array of frame layout specifications

  nme

  required

  string

  indicates layout name

  brd

  required

  boolean

  indicates if borders and labels should be used

  uid

  required

  string

  indicates layout uid

  zro

  required

  integer

  0 for false, 1 for true, (in Pro6, these sometimes show up as strings)

  ovr

  required

  boolean

  indicates if overrun color should be used

  oCl

  required

  string

  indicates color for timer overruns

  Examples values:
  • "1.000000 1.000000 1.000000 1.000000"

  fme

  required

  tuple<object, ...optional<any>>

  1 item:

  object

  uid: stageDisplayFrame

  A Stage Display Frame is a box of stage display information.

  ufr

  required

  string

  uid: stageDisplayFrameGeometry

  Frame Geometry is delivered in x,y coordinates based on screen percentages in the following format:

  {{upper_left_x_pct, upper_left_y_pct}, {lower_right_x_pct, lower_right_y_pct}}

  Examples values:
  • "{{0.025000000000000001, 0.37418655097613884}, {0.40000000000000002, 0.50108459869848154}}"

  mde

  required

  integer

  • frame mode is indicated by mde
    • mode 0: static image
    • mode 1: text
    • mode 2: live slide

  Allowed values:
  • 0
  • 1
  • 2

  tAl

  required

  integer

  Always seems to be 2

  tCl

  required

  string

  frame text color

  Examples values:
  • "1.000000 1.000000 1.000000 1.000000"

  tSz

  required

  integer

  Frame font size

  nme

  required

  string

  Name of this frame

  typ

  required

  integer

  • frame type is indicated by typ and determines what content goes in this frame
    • type 1: current slide
    • type 2: next slide
    • type 3: current slide notes
    • type 4: next slide notes
    • type 5: Stage Message (uses message flash values)
    • type 6: Clock
    • type 7: Timer Display (uses uid to specify timer)
    • type 8: Video Countdown
    • type 9: Chord Chart

  Allowed values:
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9

  fCl

  required

  string

  (message frames only) frame message flash color

  Examples values:
  • "1.000000 1.000000 1.000000 1.000000"

  fCh

  required

  boolean

  (message frames only) frame use message flash

  uid

  required

  string

  (timer frames only) frame timer uid

  Additional properties are NOT allowed.

  Additional items are allowed.

  acn

  required

  string

  Const:"sl"

  Additional properties are NOT allowed.

  Additional items are allowed.

  Additional properties are NOT allowed.

  Examples

  Payload

  • #1 Example

    {
      "acn": "asl",
      "ary": [
        {
          "brd": true,
          "uid": "753B184F-CCCD-42F9-A883-D1DF86E1FFB8",
          "zro": 0,
          "oCl": "1.000000 0.000000 0.000000",
          "fme": [
            {
              "ufr": "{{0.025000000000000001, 0.37418655097613884}, {0.40000000000000002, 0.50108459869848154}}",
              "mde": 1,
              "tCl": "1.000000 1.000000 1.000000",
              "tAl": 2,
              "tSz": 60,
              "nme": "Current Slide",
              "typ": 1
            }
          ],
          "ovr": true,
          "acn": "sl",
          "nme": "Default"
        }
      ]
    }
    

• #2psl (subscribe)psl__sub

  Request Current Stage Display Layout

  RELATED COMMAND: psl (publish)

  Payload

  object

  acn

  required

  string

  Const:"psl"

  uid

  required

  string

  Additional properties are NOT allowed.

  Examples

  Payload

  • #1 Example

    {
      "acn": "psl",
      "uid": "F8260B13-9C5B-4D2C-80F1-C72346759F11"
    }
    

• #3fv (subscribe)fv__sub

  Request Frame Values for Stage Display

  When the frame value is pushed as a result of a slide trigger event, only cs, ns, csn, nsn will be sent.

  Applications should listen for all the other acn values separately.

  RELATED COMMAND: fv (publish)

  Payload

  object

  acn

  required

  string

  Const:"fv"

  ary

  required

  tuple<object, ...optional<any>>

  1 item:

  object

  uid: stageDisplayFrameValue

  Examples values:
  • {"acn":"cs","uid":"FAFCA1CB-8CB8-4E53-8B7C-8D61154516D0","txt":""}

  uid

  string

  (only for slides and timers) uid of the object in this frame

  txt

  string

  the text content of this frame, if any

  acn

  string

  • cs = current slide text
  • csn = current slide notes
  • ns = next slide text
  • nsn = next slide text
  • msg = stage display message text
  • sys = system clock time
  • vid = video countdown value
  • tmr = timer value
  • cc = chord chart

  Allowed values:
  • "cs"
  • "csn"
  • "ns"
  • "nsn"
  • "msg"
  • "sys"
  • "vid"
  • "tmr"
  • "cc"

  Additional properties are NOT allowed.

  Additional items are allowed.

  Additional properties are NOT allowed.

  Examples

  Payload

  • #1 Example

    {
      "acn": "fv",
      "ary": [
        {
          "acn": "cs",
          "uid": "FAFCA1CB-8CB8-4E53-8B7C-8D61154516D0",
          "txt": ""
        },
        {
          "acn": "ns",
          "uid": "95D16968-589A-11EB-8D62-FCAA147AEF2F",
          "txt": ""
        },
        {
          "acn": "csn",
          "txt": "[sermon_start]\nevent[2888]\nvmixoverlay[1,Out]\nlive[1]"
        },
        {
          "acn": "nsn",
          "txt": "vmixoverlay[2,Out]"
        },
        {
          "acn": "msg",
          "txt": ""
        },
        {
          "acn": "sys",
          "txt": " 9:57 AM"
        },
        {
          "acn": "tmr",
          "uid": "47E8B48C-0D61-4EFC-9517-BF9FB894C8E2",
          "txt": "0:09:59"
        },
        {
          "acn": "vid",
          "txt": ""
        },
        {
          "acn": "cc",
          "uid": ""
        }
      ]
    }
    

• #4sl (subscribe)sl__sub

  On New Stage Display Selected

  • acn of sl indicates this is a single stage layout

  THIS IS A SUBSCRIBE-ONLY MESSAGE

  Payload

  object

  uid: stageDisplayLayout

  • nme indicates layout name
  • ovr indicates if overrun color should be used
  • oCl indicates color for timer overruns
  • brd indicates if borders and labels should be used
  • uid indicates layout uid
  • zro indicates if zeroes should be removed from times
  • fme indicates array of frame layout specifications

  nme

  required

  string

  indicates layout name

  brd

  required

  boolean

  indicates if borders and labels should be used

  uid

  required

  string

  indicates layout uid

  zro

  required

  integer

  0 for false, 1 for true, (in Pro6, these sometimes show up as strings)

  ovr

  required

  boolean

  indicates if overrun color should be used

  oCl

  required

  string

  indicates color for timer overruns

  Examples values:
  • "1.000000 1.000000 1.000000 1.000000"

  fme

  required

  tuple<object, ...optional<any>>

  1 item:

  object

  uid: stageDisplayFrame

  A Stage Display Frame is a box of stage display information.

  ufr

  required

  string

  uid: stageDisplayFrameGeometry

  Frame Geometry is delivered in x,y coordinates based on screen percentages in the following format:

  {{upper_left_x_pct, upper_left_y_pct}, {lower_right_x_pct, lower_right_y_pct}}

  Examples values:
  • "{{0.025000000000000001, 0.37418655097613884}, {0.40000000000000002, 0.50108459869848154}}"

  mde

  required

  integer

  • frame mode is indicated by mde
    • mode 0: static image
    • mode 1: text
    • mode 2: live slide

  Allowed values:
  • 0
  • 1
  • 2

  tAl

  required

  integer

  Always seems to be 2

  tCl

  required

  string

  frame text color

  Examples values:
  • "1.000000 1.000000 1.000000 1.000000"

  tSz

  required

  integer

  Frame font size

  nme

  required

  string

  Name of this frame

  typ

  required

  integer

  • frame type is indicated by typ and determines what content goes in this frame
    • type 1: current slide
    • type 2: next slide
    • type 3: current slide notes
    • type 4: next slide notes
    • type 5: Stage Message (uses message flash values)
    • type 6: Clock
    • type 7: Timer Display (uses uid to specify timer)
    • type 8: Video Countdown
    • type 9: Chord Chart

  Allowed values:
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9

  fCl

  required

  string

  (message frames only) frame message flash color

  Examples values:
  • "1.000000 1.000000 1.000000 1.000000"

  fCh

  required

  boolean

  (message frames only) frame use message flash

  uid

  required

  string

  (timer frames only) frame timer uid

  Additional properties are NOT allowed.

  Additional items are allowed.

  acn

  required

  string

  Const:"sl"

  Additional properties are NOT allowed.

  Examples

  Payload

  {
    "nme": "string",
    "brd": true,
    "uid": "string",
    "zro": 0,
    "ovr": true,
    "oCl": "1.000000 1.000000 1.000000 1.000000",
    "fme": [
      {
        "ufr": "{{0.025000000000000001, 0.37418655097613884}, {0.40000000000000002, 0.50108459869848154}}",
        "mde": 0,
        "tAl": 0,
        "tCl": "1.000000 1.000000 1.000000 1.000000",
        "tSz": 0,
        "nme": "string",
        "typ": 1,
        "fCl": "1.000000 1.000000 1.000000 1.000000",
        "fCh": true,
        "uid": "string"
      }
    ],
    "acn": "sl"
  }
  

  This example has been generated automatically.

• #5sys (subscribe)sys__sub

  On New System Time

  THIS IS A SUBSCRIBE-ONLY MESSAGE

  Payload

  object

  acn

  required

  string

  Const:"sys"

  txt

  required

  string

  Examples values:
  • " 11:17 AM"

  Additional properties are NOT allowed.

  Examples

  Payload

  • #1 Example

    {
      "acn": "sys",
      "txt": " 11:17 AM"
    }
    

• #6vid (subscribe)vid__sub

  On New Video Countdown Time

  Time follows the same H:MM:SS format as the remote protocol.

  THIS IS A SUBSCRIBE-ONLY MESSAGE

  Payload

  object

  acn

  required

  string

  Const:"vid"

  txt

  required

  string

  Examples values:
  • "--:--:--"

  Additional properties are NOT allowed.

  Examples

  Payload

  • #1 Example

    {
      "acn": "vid",
      "txt": "0:00:18"
    }
    

• #7cc (subscribe)cc__sub

  On New Chord Chart

  Chord chart images can be downloaded in the same way as slide preview images

  http://PROPRESENTER_IP:PROPRESENTER_PORT/stage/image/UID

  THIS IS A SUBSCRIBE-ONLY MESSAGE

  Payload

  object

  acn

  required

  string

  Const:"cc"

  uid

  required

  string

  Examples values:
  • "E65DF4DF-960D-4CF5-ADF5-60F200F6AFF7"

  Additional properties are NOT allowed.

  Examples

  Payload

  • #1 Example

    {
      "acn": "cc",
      "uid": "E65DF4DF-960D-4CF5-ADF5-60F200F6AFF7"
    }
    

• #8tmr (subscribe)tmr__sub

  On Timer Update

  THIS IS A SUBSCRIBE-ONLY MESSAGE

  Payload

  object

  acn

  required

  string

  Const:"tmr"

  uid

  required

  string

  timer uid

  txt

  required

  string

  timer text

  Additional properties are NOT allowed.

  Examples

  Payload

  • #1 Example

    {
      "acn": "tmr",
      "uid": "[TIMER UID]",
      "txt": "--:--:--"
    }