A client for the ProPresenter6 Remote Websocket API.

• Getting started
• Client
  • Functions
  • Properties
• Available items
  • Audio
  • Clock
  • Library
  • FrontMessage
  • Playlist
  • PlaylistItem
  • Presentation
  • StageDisplay

Install with pip:

$ pip install PP6RemoteAPI

Then:

from PP6RemoteAPI import PP6RemoteAPIClient as PP6
client = PP6(host='192.168.0.100', port=54321, password='password')

# Get first presentation in the library
presentation = client.library.presentations[0]
# Go to the first slide
presentation.to_slide(0)

# Get first clocks
clock = client.clocks[0]
# Set time to 5 minutes
clock.set_time('00:05:00')
# Start timer
clock.start()

Authenticates server with given credentials

Send command asynchronously and waits if expect_response is True

Clears all elements on live screen

Clears only background on live screen

Clears all elements on live screen and goes to logo if set

Clears text layer on live screen

Clears audio from player

Clears props on live screen

Returns all available StageDisplay sets

Sets as current StageDisplay the one corresponding to name

Sets as current StageDisplay the one corresponding to index

Returns current telestrator settings (Telestrator is not implemented in the current version).

Returns current Presentation

Returns current audio

Returns current StageDisplay

Returns Library

Returns all available Playlists

Returns all available audio Playlists

Returns all available FrontMessages

Returns all available Clocks

Returns all available StageDisplays

Start playing the selected song

Play/Pause the current song

Returns the current settings of the clock

Updates (partially or totally) the settings of the clock

Sets the time of the clock. Must be of format: HH:MM:SS

Starts the clock timer

Stops the clock timer

Resets the clock timer

All available Presentations

All paths from current available Presentations

Returns the Presentation in the Library with name name

Sends message with the expected ordered values

Hides current message

Representation of the message with expected [keys]

PlaylistItems of the Playlist

Parent path of the PlaylistItem based on the Playlists present on ProPresenter

Full path of the PlaylistItem based on the Playlists present on ProPresenter

Expected element that is represented by the PlaylistItem. For now, only Presentations and Audios are available.

Type of PlaylistItem

Goes to slide n

Goes to next slide

Goes to previous slide

Returns current slide index

Send message to the StageDisplay message panel

Hide message from StageDisplay message panel