Module for using ProPresenter 6 with the Elgato Stream Deck and Companion. Requires a network connection to ProPresenter via it's Remote network port.
Optionally, you can also configure a connection to the Stage Display App port if you want to track the Video CountDown Timer for any video that is playing.
- Open ProPresenter and then open the "ProPresenter 6" Menu.
- Select "Preferences..." to open the ProPresenter Preferences window.
- Select the Network tab to configure ProPresenter network preferences.
- Check the "Enable Network" option (if it is not already enabled).
- Check the "Enable ProPresenter Remote" option (if it is not already enabled).
- Check the "Controller" option (if it is not already enabled).
- Enter a controller password (or take note of the existing controller password).
- Take a note of the Port number (to the right of the Network Name) - this is typically 4-5 digits.
- If you would like your StreamDeck to be able to display "Video CountDown" timers, then you will also need to check the option for "Enable Stage Display App" and enter a new password (or take note of the existing password).
- Close ProPresenter preferences window.
You can control ProPresenter on any computer within the same network, you just need to know the ProPresenter computer IP address. Use your knowledge of networking (or Google how) to get the IP address of the computer running ProPresenter.
If you want to connect to ProPresenter on the same computer that you are running Companion on, you can use the special looback IP address of 127.0.0.1 (which is the default setting)
If the computers running ProPresenter and Companion are separate computers and they have the option of using either a wireless or a wired network connection, then it is recommended to use a wired network connection whenever possible. This is because a wired network connection is typically more reliable and has better latency - which is good for remote control.
Now you have all the info you need to go to the ProPresenter Companion module configuration and enter the IP address of the computer running ProPresenter as well as the ProPresenter port number and controller password that you took note of from ProPresenter network preferences.
If you chose to also enable the stage display app option in ProPresenter preferences (so your StreamDeck can display "Video Countdown" timers) then you can also select "Yes" for the configuration field "Connect to StageDisplay (Only required for video countdown timer)" and enter the stage display password.
N.B. At the time of writing this module, there is a bug in ProPresenter 6 where if you choose to enter a Port number for the stage display app - it will actually ingore it and use the "main" network port you recorded in step 8 above.
| Command | Description |
|---|---|
| Next Slide | Advances to the next slide in the current document. If at the end of a document, will advance to the start of the next document in the playlist. |
| Previous Slide | Moves to the previous slide in the current document. If at the start of a document, will move to the start of the previous document in the playlist. |
| Specific Slide | Moves to that presentation/slide number. See the Specific Slide section below. |
This action has two parameters:
Slide Number: Moves to the slide number specified.
A whole number greater than 0 will move the presentation to that slide number.
A slide number of 0 will trigger the current slide, which can be used to bring back a slide that was cleared using Clear All or Clear Slide.
A relative number (prefixed with + or -) will move the presentation +/- that many slides. +3 will jump ahead three slides, and -2 will jump back two slides. Try to avoid using -1 or +1 relative numbers; use the Next Slide and Previous Slide actions instead, as they perform better.
Presentation Path: Lets you trigger a slide in a different presentation, even from a different playlist.
Important: Presentation path numbering starts at 0, meaning 0 will trigger a slide in the first presentation in the playlist.
A single number, like 3, will let you trigger a slide in the fourth presentation in the current playlist.
A path like 1:3 will trigger presentation #4 in playlist #2.
Playlists in groups (or nested groups) are identified using periods. 1.1.0:2 means "The second playlist is a group. The second item in that group is another group. Select the first playlist in that group. Choose the third presentation in the playlist."
The below image may make this more clear:
| Command | Description |
|---|---|
| Audio Start Cue | Start a specific audio cue in an audio-bin playlist. Uses the same numerical format to specify the path of the audio item (see Presentation Path explanation above) |
| Audio Play/Pause | Pause (or resume playing) the currently playing (or paused) audio. |
| Command | Description |
|---|---|
| Clear All | Clears all the layers |
| Clear Audio | Clears the audio track |
| Clear Background | Clears only the background layer |
| Clear Slide | Clears the current slide (foreground and background) |
| Clear Telestrator | Clears all annotations drawn with the telestrator |
| Clear to Logo | Clears all the layers and shows the logo image set in ProPresenter |
Note: When the Clear All action is triggered against ProPresenter for Windows, the current slide will be lost but on Mac it's preserved.
For example, if you're on slide #5, trigger Clear All, and then trigger Next Slide:
- On Mac you'll be on slide #6
- On Windows, you'll be on slide #1
You can work around this PC limitation by using the Specific Slide action with a relative slide number of +1 to move to the next slide. This would move you to slide #6 after the Clear All action.
| Command | Description |
|---|---|
| Show Message | Shows the message on the stage display output. You can pass values for message tokens, but you must do so very carefully - a typo here can crash ProPresenter. Crashes can cause data loss, and ruin your setup. Learn how to correctly enter message tokens by reading below. Always type carefully and double-check. Get it right on a test machine first! The correct way to pass values for message tokens is as two lists. The two lists work together to form token NAME and token VALUE pairs. The first list is a comma-separated list of token NAMES and the second is a comma-separated list of token VALUES. The number of items in eash list should match - e.g. if you supply two token NAMES, then you should supply two token VALUES to make matching pairs. All token names in your list MUST match the token names defined in the message within ProPresenter (or else Pro6 will likely crash). The token values can be any text. You don't have to pass all the token names/values pairs - any name/values that you don't include will be treated as and displayed as blank. You don't have to pass any token names/values if you don't need to. Static messages without any tokens are safe - you can't make a typo if you leave the token names and token values list blank! If one of your token names or token values needs to have a comma in it, you can type a double comma (,,) to insert a literal comma - this works in either a token name or a token value. Again, make certain that your list of token NAMES perfectly match the names of the tokens defined in the message within Pro6 - Pro6 won't crash if they match perfectly - so be carefull! |
| Hide Message | Removes a message from output screen. |
Messages are identified by Index. Index is a 0-based, where the first message is 0, and then count up through the messages in the order shown in the list of ProPresenter messages.
| Command | Description |
|---|---|
| Stage Display Message | Shows the message on the stage display output |
| Stage Display Hide Message | Removes the stage display message |
| Stage Display Layout | Sets the stage display layout. |
Stage Displays are indentified by index. Index is a 0-based number, where the first layout is 0 and then count up through the stage display layouts in the order shown in ProPresenters list of stage display layouts.
| Command | Description |
|---|---|
| Start Clock | Starts clock (timer) - identified by index (0 based) |
| Stop Clock | Stops clock (timer) - identified by index (0 based) |
| Reset Clock | Resets clock (timer) - identified by index (0 based) |
| Update Clock | Update clock/timer with a new duration - identified by index (0 based). You must specify the type of clock as either Count Down Timer, Count Down To Time or Elapsed Time. (Note that any clock you update will be changed to the the selected type.) "Duration" is the new duration value for the count-down timer in the format HH:MM:SS. (It is also the starting time for Elapsed Time clocks. You may also use a shorthand format if you like. You can, if you want, leave out the HH and/or the MM values and they will default to zero - you can also leave out one or both of the ":" to enter just mins and/or seconds. You can control overrun for all clock types. AM/PM is only needed for Count Down To Time clocks. |
Tip: One-Touch Preset CountDown Timers. If you use a lot of timers with commonly used values for duration, you might like to setup a few buttons that automatically reset and restart a count-down timer for your most commonly used durations. To make a single button do that for you, you can chain together the following three actions:
- Update CountDown Clock - Set new duration value of the count-down timer. This new value will be used when the timer is next reset.
- Reset Clock - Stop the count-down timer if running and reset current value back to duration. You might like to add a little delay (say 100-300ms) to ensure ProPresenter has time to process previous action.
- Start Clock - Start the count-down timer running. You might like to add a little delay (say 100-300ms) to ensure ProPresenter has time to process previous action.
Use relative delays, to ensure these three action arrive in the correct order (or if you prefer absolute delays, make sure the second action has less delay than the third)
| Command | Description |
|---|---|
| Timeline Play/Pause | Toggle play/paused state of timeline for a specific presentation (See PresenationPath explanation above) |
| Timeline Rewind | Rewind timeline for a specific presentation (See PresenationPath explanation above) |
Please Note: There is NO direct feedback from ProPresenter for when a timeline is playing or paused - so this cannot be shown to users on the StreamDeck!
| Variable | Description |
|---|---|
| $(propresenter:current_slide) | The number of the active slide (>= 1), or "N/A" if unknown. |
| $(propresenter:total_slides) | The total number of slides in the current document, or "N/A" if unknown. |
| $(propresenter:presentation_name) | The name of the current presentation, or "N/A" if unknown. |
| $(propresenter:connection_status) | The current connection status to ProPresenter ("Disconnected" or "Connected"). |
| $(propresenter:watched_clock_current_time) | In the config of this module, you can specify the index of a clock (timer) that you want to "watch". This dynamic variable will be updated once per second to the current value of the clock specified. You could use this to display a live timer value on a button! |
| $(propresenter:current_stage_display_index) | Index of the currently selected stage display layout (This is updated whenever a new layout is selected.) |
| $(propresenter:current_stage_display_name) | Name of the currently selected stage display layout (This is updated whenever a new layout is selected.) |
| $(propresenter:video_countdown_timer) | Current value of video countdown timer - automatically updated when a video is playing. (This one variable is only updated when the module is configured to also connect to the Stage Display App port) |