PP6RemoteAPI Client

A client for the ProPresenter6 Remote Websocket API.

Index

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

Getting started

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()

Client

Functions

authenticate()

Authenticates server with given credentials

async_send(command, expect_response)

Send command asynchronously and waits if expect_response is True

clear_all()

Clears all elements on live screen

clear_background()

Clears only background on live screen

clear_to_logo()

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

clear_text()

Clears text layer on live screen

clear_audio()

Clears audio from player

clear_props()

Clears props on live screen

stage_display_sets()

Returns all available StageDisplay sets

stage_display_set_display_by_name(name)

Sets as current StageDisplay the one corresponding to name

stage_display_set_display(index)

Sets as current StageDisplay the one corresponding to index

telestrator_settings()

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

Properties

current_presentation

Returns current Presentation

current_audio

Returns current audio

current_stage_display

Returns current StageDisplay

library

Returns Library

playlists

Returns all available Playlists

audio_playlists

Returns all available audio Playlists

front_messages

Returns all available FrontMessages

clocks

Returns all available Clocks

stage_displays

Returns all available StageDisplays

Available items

Audio

play()

Start playing the selected song

play_pause()

Play/Pause the current song

Clock

settings

Returns the current settings of the clock

update(settings)

Updates (partially or totally) the settings of the clock

set_time(time)

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

start()

Starts the clock timer

stop()

Stops the clock timer

reset()

Resets the clock timer

Library

presentations

All available Presentations

paths

All paths from current available Presentations

find_presentation_by_name(name)

Returns the Presentation in the Library with name name

FrontMessage

send(values)

Sends message with the expected ordered values

hide()

Hides current message

template

Representation of the message with expected [keys]

Playlist

items

PlaylistItems of the Playlist

PlaylistItem

path

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

child_path

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

linked_element

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

type

Type of PlaylistItem

Presentation

to_slide(n)

Goes to slide n

next_slide()

Goes to next slide

previous_slide()

Goes to previous slide

current_slide()

Returns current slide index

StageDisplay

send_message(message)

Send message to the StageDisplay message panel

hide_message()

Hide message from StageDisplay message panel