propresenter_api library
Support for doing something awesome.
More dartdocs go here.
Classes
- ProApiClient
-
This class gives full access to the completely new ProPresenter API available in 7.9+
This API uses basic HTTP clients. For normal commands, a standard request/response method
is employed, but the API also allows for "subscriptions" to certain events which will result
in a persistent HTTP connection that receives streamed JSON data in
chunks. - ProApiSubbable
-
this class stores the string constants representing
ProPresenter endpoints that can be subscribed to
using the
/status/updatesendpoint - ProClock
- a ProClock is the version of a clock reported by the Remote Control API
- ProConnectedComponent
- this class manages a number of data streams for ProPresenter clients.
-
ProEvent<
T extends Object> -
ProEventEmitter<
T extends Object> - ProEventEmitters provide two ways for an object to listen to changes. Either by providing a callback, or by listening to an event stream.
- ProEventObserver
- Allow a listener to cancel a callback registered with an ProEventEmitter
- ProInstance
- ProLegacyClient
- the ProLegacyClient class wraps and combines the two Websocket APIs
- ProLibrary
- ProPresenter 7+ has the idea of multiple libraries
- ProLibraryItem
- ProMessage
- ProPlaylist
- ProPlaylistItem
- ProPresentation
- ProRemoteClient
- the ProRemoteClient represents the Remote Control Websocket API.
- ProSDClient
- listens to ProPresenter as a stage display client.
- ProSDLayout
- ProSDLayout describes a Stage Display layout
- ProSDSlide
- the SD API only sends a limited amount of slide data
- ProSettings
- ProSettings contains all the data needed to connect to a ProPresenter instance over one or more of the API methods.
- ProSlide
- The Stage Display protocol is different enough, that it maintains its own ProSDSlide class.
- ProSlideGroup
- ProSlideImage
- Represents the data used for a slide image that may come from a url or a B64 encoded String. The SD api passes a UID with a slide that can be used to generate a url to a full resolution version of the slide image. The Remote api passes the slide data as a Base 64 encoded string
- ProState
- contains all the data exposed by the various API methods
- ProTimer
- the remote api sends "Clocks" but the Stage Display sends "Timers"
Enums
- ConnectionStatus
- ProClockType
-
can be
countdown,countto, orelapsed - ProConnectionStatus
- ProVersion
Constants
- PRO6_CONTROL_PROTOCOL → const int
- PRO6_SD_PROTOCOL → const int
- PRO7_CONTROL_PROTOCOL → const int
- PRO7_SD_PROTOCOL → const int
- SLIDE_HIGHQ → const int
- SLIDE_LOWQ → const int