ProApiClient class

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.

The generated code in ProApiGeneratedWrapper wraps those commands and returns responses of the correct type either Future<Map<String, dynamic>> or Future<Uint8List> when not using the "subscription" methods or streamed responses when using the "subscription" methods.

This class further wraps those functions to make using those methods more convenient. In particular, this class allows easy subscriptions, will maintain an internal state object to track the current state of the ProPresenter instance, and will reduce complexity when calling endpoints that accept large blocks of data.

Mixed in types

• ProEventEmitter<Object>

Constructors

ProApiClient(ProSettings settings)

Creates new ProApiClient instance.

Properties

callbacks ↔ Map<String, List<void Function(ProEvent<Object> event)>>

getter/setter pair, inherited

eventStream ↔ StreamController<ProEvent<Object>>

getter/setter pair, inherited

hashCode → int

The hash code for this object.

no setter, inherited

host → String

no setter

port → int

no setter

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

settings ↔ ProSettings

getter/setter pair

state ↔ ProState

getter/setter pair

statusSubscriptions ↔ Set<String>

getter/setter pair

updateListeners ↔ Map<String, StreamSubscription>

getter/setter pair

Methods

annoucementActiveTimelineOperation(String operation) → Future<bool>

annoucementActiveTimelineOperation -> /v1/announcement/active/timeline/{operation}

inherited

announcementActiveTimelineStatus() → Future<Map<String, dynamic>>

announcementActiveTimelineStatus -> /v1/announcement/active/timeline

inherited

announcementActiveTimelineStatusStream() → Future<Stream<Map<String, dynamic>>?>

Streaming version of announcementActiveTimelineStatus

inherited

audienceScreensStatusGet() → Future<Map<String, dynamic>>

audienceScreensStatusGet -> /v1/status/audience_screens

inherited

audienceScreensStatusGetStream() → Future<Stream<Map<String, dynamic>>?>

Streaming version of audienceScreensStatusGet

inherited

audienceScreensStatusSet(bool postBody) → Future<bool>

audienceScreensStatusSet -> /v1/status/audience_screens

inherited

audioPlaylistGet(String playlistId, {int? start}) → Future<Map<String, dynamic>>

audioPlaylistGet -> /v1/audio/playlist/{playlist_id}

inherited

audioPlaylistsGet() → Future<Map<String, dynamic>>

audioPlaylistsGet -> /v1/audio/playlists

inherited

audioPlaylistUpdateGet(String playlistId) → Future<Map<String, dynamic>>

audioPlaylistUpdateGet -> /v1/audio/playlist/{playlist_id}/updates

inherited

audioPlaylistUpdateGetStream(String playlistId) → Future<Stream<Map<String, dynamic>>?>

Streaming version of audioPlaylistUpdateGet

inherited

call(String verb, String path, {Map<String, dynamic>? params, Object? data, String? httpAccept}) → Future

call will use the response content-type to automatically determine if the response should be decoded from json or returned as Uint8List directly.

inherited

callStream(String verb, String path, {Map<String, dynamic>? params, Object? data}) → Future<Stream<Map<String, dynamic>>?>

callStream acts exactly like call, but it responds with a stream of Json Objects

inherited

captureModesGet(String type) → Future<Map<String, dynamic>>

captureModesGet -> /v1/capture/encodings/{type}

inherited

captureOperation(String operation) → Future<bool>

captureOperation -> /v1/capture/{operation}

inherited

captureSettingsGet() → Future<Map<String, dynamic>>

captureSettingsGet -> /v1/capture/settings

inherited

captureStatusGet() → Future<Map<String, dynamic>>

captureStatusGet -> /v1/capture/status

inherited

captureStatusGetStream() → Future<Stream<Map<String, dynamic>>?>

Streaming version of captureStatusGet

inherited

clear() → void

inherited

clearGroupCreate(Map postBody) → Future<Map<String, dynamic>>

clearGroupCreate -> /v1/clear/groups

inherited

clearGroupDelete(String id) → Future<bool>

clearGroupDelete -> /v1/clear/group/{id}

inherited

clearGroupGet(String id) → Future<Map<String, dynamic>>

clearGroupGet -> /v1/clear/group/{id}

inherited

clearGroupIconGet(String id) → Future<Uint8List>

clearGroupIconGet -> /v1/clear/group/{id}/icon

inherited

clearGroupIconSet(String id, String postBody) → Future<bool>

clearGroupIconSet -> /v1/clear/group/{id}/icon

inherited

clearGroupSet(String id, Map postBody) → Future<Map<String, dynamic>>

clearGroupSet -> /v1/clear/group/{id}

inherited

clearGroupsGet() → Future<Map<String, dynamic>>

clearGroupsGet -> /v1/clear/groups

inherited

clearGroupTrigger(String id) → Future<bool>

clearGroupTrigger -> /v1/clear/group/{id}/trigger

inherited

clearLayer(String layer) → Future<bool>

clearLayer -> /v1/clear/layer/{layer}

inherited

dispose() → void

override

emit(String event, [Object? data]) → void

emit will always emit twice... first, by the name of the event submitted, and secondly, by the name of the special event 'all'

inherited

findMyMouse() → Future<bool>

findMyMouse -> /v1/find_my_mouse

inherited

globalGroupsGet() → Future<Map<String, dynamic>>

globalGroupsGet -> /v1/groups

inherited

globalGroupTrigger(String id) → Future<bool>

globalGroupTrigger -> /v1/group/{id}

inherited

layerStatusGet() → Future<Map<String, dynamic>>

layerStatusGet -> /v1/status/layers

inherited

layerStatusGetStream() → Future<Stream<Map<String, dynamic>>?>

Streaming version of layerStatusGet

inherited

libraryGet(String libraryId) → Future<Map<String, dynamic>>

libraryGet -> /v1/library/{library_id}

inherited

libraryGetStream(String libraryId) → Future<Stream<Map<String, dynamic>>?>

Streaming version of libraryGet

inherited

libraryListGet() → Future<Map<String, dynamic>>

libraryListGet -> /v1/libraries

inherited

lookCreate(Map postBody) → Future<Map<String, dynamic>>

lookCreate -> /v1/looks

inherited

lookDelete(String id) → Future<bool>

lookDelete -> /v1/look/{id}

inherited

lookGet(String id) → Future<Map<String, dynamic>>

lookGet -> /v1/look/{id}

inherited

lookGetAll() → Future<Map<String, dynamic>>

lookGetAll -> /v1/looks

inherited

lookGetCurrent() → Future<Map<String, dynamic>>

lookGetCurrent -> /v1/look/current

inherited

lookGetCurrentStream() → Future<Stream<Map<String, dynamic>>?>

Streaming version of lookGetCurrent

inherited

lookPut(String id, Map postBody) → Future<Map<String, dynamic>>

lookPut -> /v1/look/{id}

inherited

lookSetCurrent(Map postBody) → Future<bool>

lookSetCurrent -> /v1/look/current

inherited

lookTrigger(String id) → Future<bool>

lookTrigger -> /v1/look/{id}/trigger

inherited

macroDelete(String id) → Future<bool>

macroDelete -> /v1/macro/{id}

inherited

macroGet(String id) → Future<Map<String, dynamic>>

macroGet -> /v1/macro/{id}

inherited

macroGetAll() → Future<Map<String, dynamic>>

macroGetAll -> /v1/macros

inherited

macroSet(String id, Map postBody) → Future<Map<String, dynamic>>

macroSet -> /v1/macro/{id}

inherited

macroTrigger(String id) → Future<bool>

macroTrigger -> /v1/macro/{id}/trigger

inherited

maskGet(String id) → Future<Map<String, dynamic>>

maskGet -> /v1/mask/{id}

inherited

maskGetAll() → Future<Map<String, dynamic>>

maskGetAll -> /v1/masks

inherited

maskThumbnailGet(String id, {int? quality}) → Future<Uint8List>

maskThumbnailGet -> /v1/mask/{id}/thumbnail

inherited

mediaPlaylistGet(String playlistId, {int? start}) → Future<Map<String, dynamic>>

mediaPlaylistGet -> /v1/media/playlist/{playlist_id}

inherited

mediaPlaylistsGet() → Future<Map<String, dynamic>>

mediaPlaylistsGet -> /v1/media/playlists

inherited

mediaPlaylistUpdateGet(String playlistId) → Future<Map<String, dynamic>>

mediaPlaylistUpdateGet -> /v1/media/playlist/{playlist_id}/updates

inherited

mediaPlaylistUpdateGetStream(String playlistId) → Future<Stream<Map<String, dynamic>>?>

Streaming version of mediaPlaylistUpdateGet

inherited

mediaThumbnailGet(String uuid, {int? quality}) → Future<Uint8List>

mediaThumbnailGet -> /v1/media/{uuid}/thumbnail

inherited

messaageDelete(String id) → Future<bool>

messaageDelete -> /v1/message/{id}

inherited

messageClear(String id) → Future<bool>

messageClear -> /v1/message/{id}/clear

inherited

messageCreate(Map postBody) → Future<Map<String, dynamic>>

messageCreate -> /v1/messages

inherited

messageGet(String id) → Future<Map<String, dynamic>>

messageGet -> /v1/message/{id}

inherited

messageGetAll() → Future<Map<String, dynamic>>

messageGetAll -> /v1/messages

inherited

messageGetAllStream() → Future<Stream<Map<String, dynamic>>?>

Streaming version of messageGetAll

inherited

messageSet(String id, Map postBody) → Future<Map<String, dynamic>>

messageSet -> /v1/message/{id}

inherited

messageTrigger(String id, List postBody) → Future<bool>

messageTrigger -> /v1/message/{id}/trigger

inherited

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

on(String event, void callback(ProEvent<Object> event)) → ProEventObserver

set a callback for events of this type.

inherited

playlistActiveGet() → Future<Map<String, dynamic>>

playlistActiveGet -> /v1/playlist/active

inherited

playlistActiveGetStream() → Future<Stream<Map<String, dynamic>>?>

Streaming version of playlistActiveGet

inherited

playlistCreate(String playlistId, Map postBody) → Future<Map<String, dynamic>>

playlistCreate -> /v1/playlist/{playlist_id}

inherited

playlistCreateTopLevel(Map postBody) → Future<Map<String, dynamic>>

playlistCreateTopLevel -> /v1/playlists

inherited

playlistGet(String playlistId) → Future<Map<String, dynamic>>

playlistGet -> /v1/playlist/{playlist_id}

inherited

playlistGetAll() → Future<Map<String, dynamic>>

playlistGetAll -> /v1/playlists

inherited

playlistPut(String playlistId, List postBody) → Future<bool>

playlistPut -> /v1/playlist/{playlist_id}

inherited

presentationActiveTimelineOperation(String operation) → Future<bool>

presentationActiveTimelineOperation -> /v1/presentation/active/timeline/{operation}

inherited

presentationActiveTimelineStatus() → Future<Map<String, dynamic>>

presentationActiveTimelineStatus -> /v1/presentation/active/timeline

inherited

presentationActiveTimelineStatusStream() → Future<Stream<Map<String, dynamic>>?>

Streaming version of presentationActiveTimelineStatus

inherited

presentationFocusedTimelineOperation(String operation) → Future<bool>

presentationFocusedTimelineOperation -> /v1/presentation/focused/timeline/{operation}

inherited

presentationFocusedTimelineStatus() → Future<Map<String, dynamic>>

presentationFocusedTimelineStatus -> /v1/presentation/focused/timeline

inherited

presentationFocusedTimelineStatusStream() → Future<Stream<Map<String, dynamic>>?>

Streaming version of presentationFocusedTimelineStatus

inherited

presentationGet(String uuid) → Future<Map<String, dynamic>>

presentationGet -> /v1/presentation/{uuid}

inherited

presentationGetActive() → Future<Map<String, dynamic>>

presentationGetActive -> /v1/presentation/current

inherited

presentationGetActiveStream() → Future<Stream<Map<String, dynamic>>?>

Streaming version of presentationGetActive

inherited

presentationGetChordChart({int? quality}) → Future<Uint8List>

presentationGetChordChart -> /v1/presentation/chord_chart

inherited

presentationGetChordChartUpdates() → Future<Map<String, dynamic>>

presentationGetChordChartUpdates -> /v1/presentation/chord_chart/updates

inherited

presentationGetChordChartUpdatesStream() → Future<Stream<Map<String, dynamic>>?>

Streaming version of presentationGetChordChartUpdates

inherited

presentationGetSlideIndex() → Future<Map<String, dynamic>>

presentationGetSlideIndex -> /v1/presentation/slide_index

inherited

presentationGetSlideIndexStream() → Future<Stream<Map<String, dynamic>>?>

Streaming version of presentationGetSlideIndex

inherited

presentationThumbnailGet(String uuid, int index, {int? quality}) → Future<Uint8List>

presentationThumbnailGet -> /v1/presentation/{uuid}/thumbnail/{index}

inherited

presentationTimelineOperation(String uuid, String operation) → Future<bool>

presentationTimelineOperation -> /v1/presentation/{uuid}/timeline/{operation}

inherited

presentationTrigger(String uuid) → Future<bool>

presentationTrigger -> /v1/presentation/{uuid}/trigger

inherited

presentationTriggerCue(String uuid, int index) → Future<bool>

presentationTriggerCue -> /v1/presentation/{uuid}/trigger/{index}

inherited

propClear(String id) → Future<bool>

propClear -> /v1/prop/{id}/clear

inherited

propDelete(String id) → Future<bool>

propDelete -> /v1/prop/{id}

inherited

propGet(String id) → Future<Map<String, dynamic>>

propGet -> /v1/prop/{id}

inherited

propGetAll() → Future<Map<String, dynamic>>

propGetAll -> /v1/props

inherited

propGetAllStream() → Future<Stream<Map<String, dynamic>>?>

Streaming version of propGetAll

inherited

propThumbnailGet(String id, {int? quality}) → Future<Uint8List>

propThumbnailGet -> /v1/prop/{id}/thumbnail

inherited

propTrigger(String id) → Future<bool>

propTrigger -> /v1/prop/{id}/trigger

inherited

slideStatusGet() → Future<Map<String, dynamic>>

slideStatusGet -> /v1/status/slide

inherited

slideStatusGetStream() → Future<Stream<Map<String, dynamic>>?>

Streaming version of slideStatusGet

inherited

stageLayoutDelete(String layoutId) → Future<bool>

stageLayoutDelete -> /v1/stage/layout/{layout_id}

inherited

stageLayoutMapGet() → Future<Map<String, dynamic>>

stageLayoutMapGet -> /v1/stage/layout_map

inherited

stageLayoutMapSet(List postBody) → Future<bool>

stageLayoutMapSet -> /v1/stage/layout_map

inherited

stageLayoutsGet() → Future<Map<String, dynamic>>

stageLayoutsGet -> /v1/stage/layouts

inherited

stageLayoutThumbnailGet(String layoutId, {int? quality}) → Future<Uint8List>

stageLayoutThumbnailGet -> /v1/stage/layout/{layout_id}/thumbnail

inherited

stageMessageGet() → Future<Map<String, dynamic>>

stageMessageGet -> /v1/stage/message

inherited

stageMessageGetStream() → Future<Stream<Map<String, dynamic>>?>

Streaming version of stageMessageGet

inherited

stageMessageHide() → Future<bool>

stageMessageHide -> /v1/stage/message

inherited

stageMessageShow(String postBody) → Future<bool>

stageMessageShow -> /v1/stage/message

inherited

stageScreenLayoutGet(String id) → Future<Map<String, dynamic>>

stageScreenLayoutGet -> /v1/stage/screen/{id}/layout

inherited

stageScreenLayoutSet(String id, String layoutId) → Future<bool>

stageScreenLayoutSet -> /v1/stage/screen/{id}/layout/{layout_id}

inherited

stageScreensGet() → Future<Map<String, dynamic>>

stageScreensGet -> /v1/stage/screens

inherited

stageScreensStatusGet() → Future<Map<String, dynamic>>

stageScreensStatusGet -> /v1/status/stage_screens

inherited

stageScreensStatusGetStream() → Future<Stream<Map<String, dynamic>>?>

Streaming version of stageScreensStatusGet

inherited

stageScreensStatusSet(bool postBody) → Future<bool>

stageScreensStatusSet -> /v1/status/stage_screens

inherited

statusScreensGet() → Future<Map<String, dynamic>>

statusScreensGet -> /v1/status/screens

inherited

statusScreensGetStream() → Future<Stream<Map<String, dynamic>>?>

Streaming version of statusScreensGet

inherited

statusUpdatesGet(List postBody) → Future<Stream<Map<String, dynamic>>?>

statusUpdatesGet -> /v1/status/updates

inherited

stream(String event) → Stream<ProEvent<Object>>

listen to an event on this ProEventEmitter as a stream. An ProEvent will be emitted whenever the event by this name is emitted.

inherited

subscribeAll({dynamic withoutSysTime = false, dynamic withoutVideoCountdown = false}) → Future<ProEventObserver?>

will automatically call subscribeMulti with all available endpoints except for the endpoints that require specific ids:

subscribeMulti(List<String> subs) → Future<ProEventObserver?>

will subscribe to chunked updates using the /status endpoint.

themeGet(String id) → Future<Map<String, dynamic>>

themeGet -> /v1/theme/{id}

inherited

themeGetAll() → Future<Map<String, dynamic>>

themeGetAll -> /v1/themes

inherited

themeSlideGet(String id, {String? themeSlide}) → Future<Map<String, dynamic>>

themeSlideGet -> /v1/theme/{id}/slides/{theme_slide}

inherited

themeSlideSet(String id, Map postBody, {String? themeSlide}) → Future<bool>

themeSlideSet -> /v1/theme/{id}/slides/{theme_slide}

inherited

themeSlideThumbnailGet(String id, {String? themeSlide, int? quality}) → Future<Uint8List>

themeSlideThumbnailGet -> /v1/theme/{id}/slides/{theme_slide}/thumbnail

inherited

timerCreate(String postBody) → Future<Map<String, dynamic>>

timerCreate -> /v1/timers

inherited

timerDelete(String id) → Future<bool>

timerDelete -> /v1/timer/{id}

inherited

timerGet(String id) → Future<Map<String, dynamic>>

timerGet -> /v1/timer/{id}

inherited

timerGetAll() → Future<Map<String, dynamic>>

timerGetAll -> /v1/timers

inherited

timerGetAllStream() → Future<Stream<Map<String, dynamic>>?>

Streaming version of timerGetAll

inherited

timerGetCurrentTimes() → Future<Map<String, dynamic>>

timerGetCurrentTimes -> /v1/timers/current

inherited

timerGetCurrentTimesStream() → Future<Stream<Map<String, dynamic>>?>

Streaming version of timerGetCurrentTimes

inherited

timerGetSystemTime() → Future<Map<String, dynamic>>

timerGetSystemTime -> /v1/timer/system_time

inherited

timerGetSystemTimeStream() → Future<Stream<Map<String, dynamic>>?>

Streaming version of timerGetSystemTime

inherited

timerGetVideoCountdown() → Future<Map<String, dynamic>>

timerGetVideoCountdown -> /v1/timer/video_countdown

inherited

timerGetVideoCountdownStream() → Future<Stream<Map<String, dynamic>>?>

Streaming version of timerGetVideoCountdown

inherited

timerOperation(String id, String operation) → Future<bool>

timerOperation -> /v1/timer/{id}/{operation}

inherited

timerOperationAll(String operation) → Future<Uint8List>

timerOperationAll -> /v1/timers/{operation}

inherited

timerSet(String id, String postBody) → Future<Map<String, dynamic>>

timerSet -> /v1/timer/{id}

inherited

toString() → String

A string representation of this object.

inherited

transportAutoAdvanceCancel(String layer) → Future<bool>

transportAutoAdvanceCancel -> /v1/transport/{layer}/auto_advance

inherited

transportAutoAdvanceGet(String layer) → Future<Map<String, dynamic>>

transportAutoAdvanceGet -> /v1/transport/{layer}/auto_advance

inherited

transportCurrentMediaGet(String layer) → Future<Map<String, dynamic>>

transportCurrentMediaGet -> /v1/transport/{layer}/current

inherited

transportCurrentMediaGetStream(String layer) → Future<Stream<Map<String, dynamic>>?>

Streaming version of transportCurrentMediaGet

inherited

transportGoToEnd(String layer, {int? time}) → Future<bool>

transportGoToEnd -> /v1/transport/{layer}/go_to_end

inherited

transportPause(String layer) → Future<bool>

transportPause -> /v1/transport/{layer}/pause

inherited

transportPlay(String layer) → Future<bool>

transportPlay -> /v1/transport/{layer}/play

inherited

transportSkipBackward(String layer, int time) → Future<bool>

transportSkipBackward -> /v1/transport/{layer}/skip_backward/{time}

inherited

transportSkipForward(String layer, int time) → Future<bool>

transportSkipForward -> /v1/transport/{layer}/skip_forward/{time}

inherited

transportTimeGet(String layer) → Future<Map<String, dynamic>>

transportTimeGet -> /v1/transport/{layer}/time

inherited

transportTimeGetStream(String layer) → Future<Stream<Map<String, dynamic>>?>

Streaming version of transportTimeGet

inherited

transportTimeSet(String layer, double postBody) → Future<bool>

transportTimeSet -> /v1/transport/{layer}/time

inherited

triggerAudio(String playlistId, String itemId) → Future<bool>

triggerAudio -> /v1/trigger/audio/{playlist_id}/{item_id}

inherited

triggerAudioNext() → Future<bool>

triggerAudioNext -> /v1/trigger/audio/next

inherited

triggerAudioPrevious() → Future<bool>

triggerAudioPrevious -> /v1/trigger/audio/previous

inherited

triggerCue(int index) → Future<bool>

triggerCue -> /v1/trigger/cue/{index}

inherited

triggerLibrary(String libraryId, String presentationId, int index) → Future<bool>

triggerLibrary -> /v1/trigger/library/{library_id}/{presentation_id}/{index}

inherited

triggerMedia(String playlistId, String itemId) → Future<bool>

triggerMedia -> /v1/trigger/media/{playlist_id}/{item_id}

inherited

triggerMediaNext() → Future<bool>

triggerMediaNext -> /v1/trigger/media/next

inherited

triggerMediaPrevious() → Future<bool>

triggerMediaPrevious -> /v1/trigger/media/previous

inherited

triggerNext() → Future<bool>

triggerNext -> /v1/trigger/next

inherited

triggerPlaylist(String playlistId, String itemId, int cueIndex) → Future<bool>

triggerPlaylist -> /v1/trigger/playlist/{playlist_id}/{item_id}/{cue_index}

inherited

triggerPrevious() → Future<bool>

triggerPrevious -> /v1/trigger/previous

inherited

triggerVideoInput(String id) → Future<bool>

triggerVideoInput -> /v1/trigger/video_input/{id}

inherited

versionGet() → Future<Map<String, dynamic>>

versionGet -> /version

inherited

videoInputsGet() → Future<Map<String, dynamic>>

videoInputsGet -> /v1/video_inputs

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited