Typescript wrapper for Node.js.
yarn add renewedvision-propresenterimport { ProPresenter } from 'renewedvision-propresenter'
// Change IP and Port to the values from ProPresenter; settings... > Network (enable network)
// timeout is optional (and )
this.ProPresenter = new ProPresenter('10.0.0.1', 1025, 1000)
// Example request
this.ProPresenter.version().then((result) => {
console.log(result);
/*
Example result;
{
"data":{"name":"MacBook-Pro","platform":"mac","os_version":"13.2.1","host_description":"ProPresenter 7.11","api_version":"v1"},
"ok":true,
"status":200,
"path":"/version"}
*/
})
// Example of registering multiple callbacks for status feedback from multiple streaming endpoints. Once registered, the module will maintain a single persistant status connection and call your callbacks each time a specific status endpoint sends an update.
// You need to provide a dictionary of 'GET' status endpoints and callback function pairs.
// You can register as many endpoints/callbacks pairs as you like. Supported endpoints are those that support chunked requests.
// The last (optional) parameter is network timeout (use this to timeout faster than the default 30s)
// In this example, we register TWO status 'GET' endpoints that support chunked responses - one for when the active slide changes and one for when any of the timers change.
// The callbacks will be passed JSON response data from the endpoints.
this.ProPresenter.registerCallbacksForStatusUpdates(
{ 'status/slide': this.statusSlideUpdate, 'timers/current': this.timersCurrentUpdate },
2000
)
// If you define your status callback functions using arrow notation this will create property functions that capture the parent 'this' instance - which can be useful if you want to refer to 'this' in the callback functions themselves
statusSlideUpdate = (statusJSONObject: StatusJSON) => {
// StatusJSON is the JSON sent when a status/slide sends an update
this.doSomethingWithSlideStatus(statusJSONObject)
}
timersCurrentUpdate = (statusJSONObject: StatusJSON) => {
// StatusJSON is the JSON sent when a timers/current sends an update
this.doSomethingWithTimersStatus(statusJSONObject)
}'path' result will return the requested action's endpoint path in the API. This way you can see where the data is returning from.
- announcementActiveFocus
- announcementActiveIndexTrigger
- announcementActiveTimelineOperation
- announcementGetActive
- announcementGetActiveTimelineOperation
- announcementGetSlideIndex
- announcementNextTrigger
- announcementPreviousTrigger
- announcementTrigger
- audioGetPlaylists
- audioGetPlaylistsActive
- audioGetPlaylistsByPlaylistId
- audioGetPlaylistsByPlaylistIdUpdates
- audioGetPlaylistsFocused
- audioPlaylistsActiveFocus
- audioPlaylistsActiveIdTrigger
- audioPlaylistsActiveNextTrigger
- audioPlaylistsActiveTrigger
- audioPlaylistsActivePreviousTrigger
- audioPlaylistsByPlaylistIdFocus
- audioPlaylistsByPlaylistIdNextTrigger
- audioPlaylistsByPlaylistIdPreviousTrigger
- audioPlaylistsByPlaylistIdTrigger
- audioPlaylistsFocusedIdTrigger
- audioPlaylistsFocusedNextTrigger
- audioPlaylistsFocusedPreviousTrigger
- audioPlaylistsFocusedTrigger
- audioPlaylistsNextFocus
- audioPlaylistsPreviousFocus
- captureEncodingsType
- captureGetStatus
- captureGetsettings
- captureOperation
- clearCreateGroup
- clearDeleteGroupId
- clearGetGroup
- clearGetGroupId
- clearGetGroupIdIcon
- clearGroupIdTrigger
- clearLayer
- clearSetGroupId
- clearSetGroupIdIcon
- findMyMouse
- getDataFromProPresenter
- groupsGet
- libraryByIdPresentationIdCueTrigger
- libraryByIdPresentationIdTrigger
- libraryGet
- libraryGetById
- lookDeleteId
- lookGet
- lookGetCurrent
- lookGetId
- lookIdTrigger
- lookSetCurrent
- lookSetId
- marcosGet
- marcosIdDelete
- marcosIdGet
- marcosIdSet
- marcosIdTriggerGet
- masksGet
- masksIdGet
- masksIdThumbnailGet
- mediaByUUIDThumbnailsGet
- mediaPlaylistActiveFocus
- mediaPlaylistActiveGet
- mediaPlaylistActiveMediaIdTrigger
- mediaPlaylistActiveNextTrigger
- mediaPlaylistActivePreviousTrigger
- mediaPlaylistActiveTrigger
- mediaPlaylistByPlaylistIdGet
- mediaPlaylistByPlaylistIdUpdatesGet
- mediaPlaylistFocusedGet
- mediaPlaylistFocusedMediaIdTrigger
- mediaPlaylistFocusedNextTrigger
- mediaPlaylistFocusedPreviousTrigger
- mediaPlaylistFocusedTrigger
- mediaPlaylistNextFocus
- mediaPlaylistPlaylistIdFocus
- mediaPlaylistPlaylistIdMediaIdTrigger
- mediaPlaylistPlaylistIdNextTrigger
- mediaPlaylistPlaylistIdPreviousTrigger
- mediaPlaylistPlaylistIdTrigger
- mediaPlaylistPreviousFocus
- mediaPlaylistsGet
- messagesGet
- messagesIdClear
- messagesIdDelete
- messagesIdGet
- messagesIdSet
- playlistActiveAnnouncementFocus
- playlistActiveAnnouncementIndexTrigger
- playlistActiveAnnouncementTrigger
- playlistActiveGet
- playlistActivePresentationFocus
- playlistActivePresentationIndexTrigger
- playlistActivePresentationTrigger
- playlistFocusedGet
- playlistFocusedIndexTrigger
- playlistFocusedNextTrigger
- playlistFocusedPreviousTrigger
- playlistFocusedTrigger
- playlistIdentifierFocus
- playlistIdentifierIndexTrigger
- playlistIdentifierNextTrigger
- playlistIdentifierPreviousTrigger
- playlistIdentifierTrigger
- playlistIdentifierUpdates
- playlistNextFocus
- playlistPlaylistIdGet
- playlistPlaylistIdSet
- playlistPreviousFocus
- playlistsGet
- presentationActiveFocus
- presentationActiveGet
- presentationActiveGroupGroup_IdTrigger
- presentationActiveIndexTrigger
- presentationActiveNextTrigger
- presentationActivePreviousTrigger
- presentationActiveTimeline
- presentationActiveTimelineOperation
- presentationActiveTrigger
- presentationChordChartGet
- presentationChordChartUpdates
- presentationFocusedGet
- presentationFocusedGroupGroup_IdTrigger
- presentationFocusedIndexTrigger
- presentationFocusedNextTrigger
- presentationFocusedPreviousTrigger
- presentationFocusedTimeline
- presentationFocusedTimelineOperation
- presentationFocusedTrigger
- presentationNextFocus
- presentationPreviousFocus
- presentationSlideIndexGet
- presentationUUIDFocus
- presentationUUIDFocusedTimelineOperation
- presentationUUIDGet
- presentationUUIDGroupGroup_IdTrigger
- presentationUUIDIndexTrigger
- presentationUUIDNextTrigger
- presentationUUIDPreviousTrigger
- presentationUUIDThumbnailIndex
- presentationUUIDTrigger
- propGet
- propId
- propIdClear
- propIdDelete
- propIdThumbnail
- propIdTrigger
- stageLayoutIdDelete
- stageLayoutIdThumbnail
- stageLayoutMap
- stageLayoutMapSet
- stageLayoutsGet
- stageMessage
- stageMessageGet
- stageMessageHide
- stageScreenIdLayout
- stageScreenIdLayoutId
- stageScreensGet
- statusAudienceScreens
- statusAudienceScreensSet
- statusLayers
- statusScreens
- statusSlide
- statusStageScreens
- statusStageScreensSet
- statusUpdate
- themesGet
- themesIdGet
- themesIdSlidesThemeSlide
- themesIdSlidesThemeSlideSet
- themesIdSlidesThemeSlideThumbnail
- timerCreate
- timerIdDelete
- timerIdGet
- timerIdOperation
- timerIdSet
- timerSystemTime
- timerVideoCountdown
- timersCurrent
- timersGet
- timersOperation
- transportLayerAutoAdvance
- transportLayerAutoAdvanceDelete
- transportLayerCurrent
- transportLayerGoToEnd
- transportLayerPause
- transportLayerPlay
- transportLayerSkipBackwardTime
- transportLayerSkipForwardTime
- transportLayerTime
- transportLayerTimeSet
- triggerAudioNext
- triggerAudioPrevious
- triggerMediaNext
- triggerMediaPrevious
- triggerNext
- triggerPrevious
- version
- videoInputs
- videoInputsIdTrigger
• new ProPresenter(ip, port)
| Name | Type |
|---|---|
ip |
string |
port |
number |
• ip: string
• port: number
▸ announcementActiveFocus(): Promise<{ command: string ; data: any ; status: number }>
Focuses the currently active announcement presentation.
Promise<{ command: string ; data: any ; status: number }>
▸ announcementActiveIndexTrigger(index): Promise<{ command: string ; data: any ; status: number }>
Triggers the specified cue in the currently active announcement presentation.
| Name | Type |
|---|---|
index |
string | number |
Promise<{ command: string ; data: any ; status: number }>
▸ announcementActiveTimelineOperation(operation): Promise<{ command: string ; data: any ; status: number }>
Performs the requested timeline operation for the active announcment presentation.
| Name | Type |
|---|---|
operation |
any |
Promise<{ command: string ; data: any ; status: number }>
▸ announcementGetActive(): Promise<{ command: string ; data: any ; status: number }>
Requests the currently active announcement presentation.
Promise<{ command: string ; data: any ; status: number }>
the currently active announcement presentation.
▸ announcementGetActiveTimelineOperation(): Promise<{ command: string ; data: any ; status: number }>
Requests the current state of the active announcement timeline.
Promise<{ command: string ; data: any ; status: number }>
The current state of the active announcement timeline.
▸ announcementGetSlideIndex(): Promise<{ command: string ; data: any ; status: number }>
Requests the index of the current slide/cue within the currently active announcement.
Promise<{ command: string ; data: any ; status: number }>
The index of the current slide/cue within the currently active announcement.
▸ announcementNextTrigger(): Promise<{ command: string ; data: any ; status: number }>
Triggers the next cue in the active announcement presentation (if there is one).
Promise<{ command: string ; data: any ; status: number }>
▸ announcementPreviousTrigger(): Promise<{ command: string ; data: any ; status: number }>
Triggers the previous cue in the currently active announcement presentation (if there is one).
Promise<{ command: string ; data: any ; status: number }>
▸ announcementTrigger(): Promise<{ command: string ; data: any ; status: number }>
Retriggers the currently active announcement presentation (starts from the beginning).
Promise<{ command: string ; data: any ; status: number }>
▸ audioGetPlaylists(): Promise<{ command: string ; data: any ; status: number }>
Requests a list with all the configured audio playlists.
Promise<{ command: string ; data: any ; status: number }>
a list with all the configured audio playlists.
▸ audioGetPlaylistsActive(): Promise<{ command: string ; data: any ; status: number }>
Requests the currently active audio playlist
Promise<{ command: string ; data: any ; status: number }>
The currently active audio playlist
▸ audioGetPlaylistsByPlaylistId(playlist_id): Promise<{ command: string ; data: any ; status: number }>
Requests a list of all the audio items in the specified audio playlist.
| Name | Type |
|---|---|
playlist_id |
any |
Promise<{ command: string ; data: any ; status: number }>
a list of all the audio items in the specified audio playlist.
▸ audioGetPlaylistsByPlaylistIdUpdates(playlist_id): Promise<{ command: string ; data: any ; status: number }>
Requests a chunked data update every time the specified audio playlist changes.
| Name | Type |
|---|---|
playlist_id |
any |
Promise<{ command: string ; data: any ; status: number }>
a chunked data update every time the specified audio playlist changes.
▸ audioGetPlaylistsFocused(): Promise<{ command: string ; data: any ; status: number }>
Requests the currently focused audio playlist
Promise<{ command: string ; data: any ; status: number }>
The currently focused audio playlist
▸ audioPlaylistsActiveFocus(): Promise<{ command: string ; data: any ; status: number }>
Focuses the active audio playlist.
Promise<{ command: string ; data: any ; status: number }>
▸ audioPlaylistsActiveIdTrigger(id): Promise<{ command: string ; data: any ; status: number }>
Triggers the specified item in the active audio playlist.
Params
id
| Name | Type |
|---|---|
id |
any |
Promise<{ command: string ; data: any ; status: number }>
▸ audioPlaylistsActiveNextTrigger(): Promise<{ command: string ; data: any ; status: number }>
Triggers the next item in the active audio playlist.
Promise<{ command: string ; data: any ; status: number }>
▸ audioPlaylistsActiveTrigger(): Promise<{ command: string ; data: any ; status: number }>
Triggers the active audio playlist (restarts from the beginning).
Promise<{ command: string ; data: any ; status: number }>
▸ audioPlaylistsActivePreviousTrigger(): Promise<{ command: string ; data: any ; status: number }>
Triggers the previous item in the active audio playlist.
Promise<{ command: string ; data: any ; status: number }>
▸ audioPlaylistsByPlaylistIdFocus(playlist_id): Promise<{ command: string ; data: any ; status: number }>
Focuses the specified audio playlist.
| Name | Type |
|---|---|
playlist_id |
any |
Promise<{ command: string ; data: any ; status: number }>
▸ audioPlaylistsByPlaylistIdNextTrigger(playlist_id): Promise<{ command: string ; data: any ; status: number }>
Triggers the next item in the specified audio playlist.
| Name | Type |
|---|---|
playlist_id |
any |
Promise<{ command: string ; data: any ; status: number }>
▸ audioPlaylistsByPlaylistIdPreviousTrigger(playlist_id): Promise<{ command: string ; data: any ; status: number }>
Triggers the previous item in the specified audio playlist.
| Name | Type |
|---|---|
playlist_id |
any |
Promise<{ command: string ; data: any ; status: number }>
▸ audioPlaylistsByPlaylistIdTrigger(playlist_id): Promise<{ command: string ; data: any ; status: number }>
Triggers the specified audio playlist.
| Name | Type |
|---|---|
playlist_id |
any |
Promise<{ command: string ; data: any ; status: number }>
▸ audioPlaylistsFocusedIdTrigger(id): Promise<{ command: string ; data: any ; status: number }>
Triggers the specified item in the focused audio playlist.
Params
id
| Name | Type |
|---|---|
id |
any |
Promise<{ command: string ; data: any ; status: number }>
▸ audioPlaylistsFocusedNextTrigger(): Promise<{ command: string ; data: any ; status: number }>
Triggers the next item in the focused audio playlist.
Promise<{ command: string ; data: any ; status: number }>
▸ audioPlaylistsFocusedPreviousTrigger(): Promise<{ command: string ; data: any ; status: number }>
Triggers the previous item in the focused audio playlist.
Promise<{ command: string ; data: any ; status: number }>
▸ audioPlaylistsFocusedTrigger(): Promise<{ command: string ; data: any ; status: number }>
Triggers the focused audio playlist.
Promise<{ command: string ; data: any ; status: number }>
▸ audioPlaylistsNextFocus(): Promise<{ command: string ; data: any ; status: number }>
Focuses the next audio playlist.
Promise<{ command: string ; data: any ; status: number }>
▸ audioPlaylistsPreviousFocus(): Promise<{ command: string ; data: any ; status: number }>
Focuses the previous audio playlist.
Promise<{ command: string ; data: any ; status: number }>
▸ captureEncodingsType(type): Promise<{ command: string ; data: any ; status: number }>
Requests a list of all available capture modes for the capture type (disk, rtmp, resi).
| Name | Type | Description |
|---|---|---|
type |
"disk" | "rtmp" | "resi" |
(disk, rtmp, resi) |
Promise<{ command: string ; data: any ; status: number }>
A list of all available capture modes for the capture type (disk, rtmp, resi).
▸ captureGetStatus(): Promise<{ command: string ; data: any ; status: number }>
Requests the current capture status and capture time.
Promise<{ command: string ; data: any ; status: number }>
The current capture status and capture time.
▸ captureGetsettings(): Promise<{ command: string ; data: any ; status: number }>
Requests the current capture settings.
Promise<{ command: string ; data: any ; status: number }>
The current capture settings.
▸ captureOperation(operation): Promise<{ command: string ; data: any ; status: number }>
Performs the requested capture operation (start, stop).
| Name | Type | Description |
|---|---|---|
operation |
"stop" | "start" |
(start, stop) |
Promise<{ command: string ; data: any ; status: number }>
▸ clearCreateGroup(name, layers, stop_timeline_announcements, stop_timeline_presentation, clear_next_presentation): Promise<{ command: string ; data: any ; status: number }>
DOUBLE CHECK THIS FOR MISSING PARAMS Create a clear group with the details specified.
| Name | Type |
|---|---|
name |
string |
layers |
string[] |
stop_timeline_announcements |
boolean |
stop_timeline_presentation |
boolean |
clear_next_presentation |
boolean |
Promise<{ command: string ; data: any ; status: number }>
The created group.
▸ clearDeleteGroupId(id): Promise<{ command: string ; data: any ; status: number }>
Deletes the specified clear group.
| Name | Type | Description |
|---|---|---|
id |
string |
(name, index or UUID) |
Promise<{ command: string ; data: any ; status: number }>
▸ clearGetGroup(): Promise<{ command: string ; data: any ; status: number }>
Requests a list of all the configured clear groups.
Promise<{ command: string ; data: any ; status: number }>
A list of all the configured clear groups.
▸ clearGetGroupId(id): Promise<{ command: string ; data: any ; status: number }>
Requests the details of the specified clear group.
| Name | Type | Description |
|---|---|---|
id |
string |
(name, index or UUID) |
Promise<{ command: string ; data: any ; status: number }>
The details of the specified clear group.
▸ clearGetGroupIdIcon(id): Promise<{ command: string ; data: any ; status: number }>
Requests the image data for the icon of the specified clear group.
| Name | Type | Description |
|---|---|---|
id |
string |
(name, index or UUID) |
Promise<{ command: string ; data: any ; status: number }>
The image data for the icon of the specified clear group.
▸ clearGroupIdTrigger(id): Promise<{ command: string ; data: any ; status: number }>
Triggers the specified clear group.
| Name | Type | Description |
|---|---|---|
id |
string |
(name, index or UUID) |
Promise<{ command: string ; data: any ; status: number }>
▸ clearLayer(layer): Promise<{ command: string ; data: any ; status: number }>
Clears the specified layer (audio, props, messages, announcements, slide, media, video_input).
| Name | Type | Description |
|---|---|---|
layer |
"media" | "audio" | "props" | "messages" | "announcements" | "slide" | "video_input" |
(audio, props, messages, announcements, slide, media, video_input) |
Promise<{ command: string ; data: any ; status: number }>
▸ clearSetGroupId(id): Promise<{ command: string ; data: any ; status: number }>
Sets the details of the specified clear group.
| Name | Type | Description |
|---|---|---|
id |
string |
(name, index or UUID) |
Promise<{ command: string ; data: any ; status: number }>
The details of the specified clear group.
▸ clearSetGroupIdIcon(id): Promise<{ command: string ; data: any ; status: number }>
Sets the custom icon of the specified clear group.
| Name | Type | Description |
|---|---|---|
id |
string |
(name, index or UUID) |
Promise<{ command: string ; data: any ; status: number }>
▸ findMyMouse(): Promise<{ command: string ; data: any ; status: number }>
Executes the "Find My Mouse" operation.
Promise<{ command: string ; data: any ; status: number }>
▸ Private getDataFromProPresenter(path, userOptions?): Promise<{ command: string ; data: any ; status: number }>
API wrapper function, use fetch to send/retrieve the data from ProPresenter
| Name | Type | Description |
|---|---|---|
path |
string |
|
userOptions? |
any |
(optional) |
Promise<{ command: string ; data: any ; status: number }>
Promise from fetch
▸ groupsGet(): Promise<{ command: string ; data: any ; status: number }>
Requests a list of all the configured global groups.
Promise<{ command: string ; data: any ; status: number }>
A list of all the configured global groups.
▸ libraryByIdPresentationIdCueTrigger(library_id, presentation_id, cue): Promise<{ command: string ; data: any ; status: number }>
Triggers the specified cue of the specified presentation in the specified library.
| Name | Type |
|---|---|
library_id |
string |
presentation_id |
string |
cue |
string |
Promise<{ command: string ; data: any ; status: number }>
▸ libraryByIdPresentationIdTrigger(library_id, presentation_id): Promise<{ command: string ; data: any ; status: number }>
Triggers the first cue of the specified presentation in the specified library.
| Name | Type |
|---|---|
library_id |
string |
presentation_id |
string |
Promise<{ command: string ; data: any ; status: number }>
▸ libraryGet(): Promise<{ command: string ; data: any ; status: number }>
Requests a list of all the configured libraries.
Promise<{ command: string ; data: any ; status: number }>
A list of all the configured libraries.
▸ libraryGetById(id): Promise<{ command: string ; data: any ; status: number }>
Requests an array of all items in the specified library.
Params
id (UUID, name, or index)
| Name | Type |
|---|---|
id |
string |
Promise<{ command: string ; data: any ; status: number }>
An array of all items in the specified library.
▸ lookDeleteId(id): Promise<{ command: string ; data: any ; status: number }>
Deletes the specified audience look from the saved looks.
| Name | Type |
|---|---|
id |
string |
Promise<{ command: string ; data: any ; status: number }>
▸ lookGet(): Promise<{ command: string ; data: any ; status: number }>
Requests a list of all configured audience looks, except the live look.
Promise<{ command: string ; data: any ; status: number }>
A list of all configured audience looks, except the live look.
▸ lookGetCurrent(): Promise<{ command: string ; data: any ; status: number }>
Requests the details of the currently live audience look.
Promise<{ command: string ; data: any ; status: number }>
The details of the currently live audience look.
▸ lookGetId(id): Promise<{ command: string ; data: any ; status: number }>
Requests the details of the specified audience look.
| Name | Type |
|---|---|
id |
string |
Promise<{ command: string ; data: any ; status: number }>
The details of the specified audience look.
▸ lookIdTrigger(id): Promise<{ command: string ; data: any ; status: number }>
Triggers the specified audience look to make it the live/current look.
| Name | Type |
|---|---|
id |
string |
Promise<{ command: string ; data: any ; status: number }>
▸ lookSetCurrent(): Promise<{ command: string ; data: any ; status: number }>
Requests the details of the currently live audience look.
Promise<{ command: string ; data: any ; status: number }>
The details of the currently live audience look.
▸ lookSetId(id): Promise<{ command: string ; data: any ; status: number }>
Sets the details of the specified audience look.
| Name | Type |
|---|---|
id |
string |
Promise<{ command: string ; data: any ; status: number }>
▸ marcosGet(): Promise<{ command: string ; data: any ; status: number }>
Requests a list of all the configured macros.
Promise<{ command: string ; data: any ; status: number }>
A list of all the configured macros.
▸ marcosIdDelete(id): Promise<{ command: string ; data: any ; status: number }>
Deletes the specified macro.
| Name | Type |
|---|---|
id |
string |
Promise<{ command: string ; data: any ; status: number }>
▸ marcosIdGet(id): Promise<{ command: string ; data: any ; status: number }>
Requests the details of the specified macro.
| Name | Type |
|---|---|
id |
string |
Promise<{ command: string ; data: any ; status: number }>
The details of the specified macro.
▸ marcosIdSet(id): Promise<{ command: string ; data: any ; status: number }>
Sets the details of the specified macro.
| Name | Type |
|---|---|
id |
string |
Promise<{ command: string ; data: any ; status: number }>
▸ marcosIdTriggerGet(id): Promise<{ command: string ; data: any ; status: number }>
Triggers the specified macro.
| Name | Type |
|---|---|
id |
string |
Promise<{ command: string ; data: any ; status: number }>
▸ masksGet(): Promise<{ command: string ; data: any ; status: number }>
Requests a list of all configured masks.
Promise<{ command: string ; data: any ; status: number }>
A list of all configured masks.
▸ masksIdGet(id): Promise<{ command: string ; data: any ; status: number }>
Requests the details of the specified mask.
| Name | Type |
|---|---|
id |
string |
Promise<{ command: string ; data: any ; status: number }>
The details of the specified mask.
▸ masksIdThumbnailGet(id): Promise<{ command: string ; data: any ; status: number }>
Requests a thumbnail image of the specified mask at the given quality value.
| Name | Type |
|---|---|
id |
string |
Promise<{ command: string ; data: any ; status: number }>
A thumbnail image of the specified mask at the given quality value.
▸ mediaByUUIDThumbnailsGet(uuid): Promise<{ command: string ; data: any ; status: number }>
Requests a thumbnail image of the specified media item at the given quality value.
| Name | Type |
|---|---|
uuid |
string |
Promise<{ command: string ; data: any ; status: number }>
A thumbnail image of the specified media item at the given quality value.
▸ mediaPlaylistActiveFocus(): Promise<{ command: string ; data: any ; status: number }>
Sets the focus to the active media playlist.
Promise<{ command: string ; data: any ; status: number }>
▸ mediaPlaylistActiveGet(): Promise<{ command: string ; data: any ; status: number }>
Returns the identifier of the currently active media playlist.
Promise<{ command: string ; data: any ; status: number }>
The identifier of the currently active media playlist
▸ mediaPlaylistActiveMediaIdTrigger(media_id): Promise<{ command: string ; data: any ; status: number }>
Triggers the specified item in the active media playlist.
| Name | Type |
|---|---|
media_id |
string |
Promise<{ command: string ; data: any ; status: number }>
▸ mediaPlaylistActiveNextTrigger(): Promise<{ command: string ; data: any ; status: number }>
Triggers the next item in the active media playlist.
Promise<{ command: string ; data: any ; status: number }>
▸ mediaPlaylistActivePreviousTrigger(): Promise<{ command: string ; data: any ; status: number }>
Triggers the previous item in the active media playlist.
Promise<{ command: string ; data: any ; status: number }>
▸ mediaPlaylistActiveTrigger(): Promise<{ command: string ; data: any ; status: number }>
Triggers the first item in the active media playlist.
Promise<{ command: string ; data: any ; status: number }>
▸ mediaPlaylistByPlaylistIdGet(playlist_id): Promise<{ command: string ; data: any ; status: number }>
Requests a list of all the media items in the specified media playlist.
| Name | Type |
|---|---|
playlist_id |
string |
Promise<{ command: string ; data: any ; status: number }>
A list of all the media items in the specified media playlist.
▸ mediaPlaylistByPlaylistIdUpdatesGet(playlist_id): Promise<{ command: string ; data: any ; status: number }>
Requests a chunked data update every time the specified media playlist changes.
| Name | Type |
|---|---|
playlist_id |
string |
Promise<{ command: string ; data: any ; status: number }>
A chunked data update every time the specified media playlist changes.
▸ mediaPlaylistFocusedGet(): Promise<{ command: string ; data: any ; status: number }>
Returns the identifier of the currently focused media playlist
Promise<{ command: string ; data: any ; status: number }>
The identifier of the currently focused media playlist
▸ mediaPlaylistFocusedMediaIdTrigger(media_id): Promise<{ command: string ; data: any ; status: number }>
Triggers the specified item in the focused media playlist.
| Name | Type |
|---|---|
media_id |
string |
Promise<{ command: string ; data: any ; status: number }>
▸ mediaPlaylistFocusedNextTrigger(): Promise<{ command: string ; data: any ; status: number }>
Triggers the next item in the focused media playlist.
Promise<{ command: string ; data: any ; status: number }>
▸ mediaPlaylistFocusedPreviousTrigger(): Promise<{ command: string ; data: any ; status: number }>
Triggers the previous item in the focused media playlist.
Promise<{ command: string ; data: any ; status: number }>
▸ mediaPlaylistFocusedTrigger(): Promise<{ command: string ; data: any ; status: number }>
Triggers the first item in the focused media playlist.
Promise<{ command: string ; data: any ; status: number }>
▸ mediaPlaylistNextFocus(): Promise<{ command: string ; data: any ; status: number }>
Sets the focus to the next media playlist.
Promise<{ command: string ; data: any ; status: number }>
▸ mediaPlaylistPlaylistIdFocus(playlist_id): Promise<{ command: string ; data: any ; status: number }>
Sets the focus to the specified media playlist.
| Name | Type |
|---|---|
playlist_id |
string |
Promise<{ command: string ; data: any ; status: number }>
▸ mediaPlaylistPlaylistIdMediaIdTrigger(playlist_id, media_id): Promise<{ command: string ; data: any ; status: number }>
Triggers the previous item in the specified media playlist.
| Name | Type |
|---|---|
playlist_id |
string |
media_id |
string |
Promise<{ command: string ; data: any ; status: number }>
▸ mediaPlaylistPlaylistIdNextTrigger(playlist_id): Promise<{ command: string ; data: any ; status: number }>
Triggers the next item in the specified media playlist.
| Name | Type |
|---|---|
playlist_id |
string |
Promise<{ command: string ; data: any ; status: number }>
▸ mediaPlaylistPlaylistIdPreviousTrigger(playlist_id): Promise<{ command: string ; data: any ; status: number }>
Triggers the previous item in the specified media playlist.
| Name | Type |
|---|---|
playlist_id |
string |
Promise<{ command: string ; data: any ; status: number }>
▸ mediaPlaylistPlaylistIdTrigger(playlist_id): Promise<{ command: string ; data: any ; status: number }>
Triggers the first item in the specified media playlist.
| Name | Type |
|---|---|
playlist_id |
string |
Promise<{ command: string ; data: any ; status: number }>
▸ mediaPlaylistPreviousFocus(): Promise<{ command: string ; data: any ; status: number }>
Sets the focus to the previous media playlist.
Promise<{ command: string ; data: any ; status: number }>
▸ mediaPlaylistsGet(): Promise<{ command: string ; data: any ; status: number }>
Requests a list of all the configured media playlists.
Promise<{ command: string ; data: any ; status: number }>
A list of all the configured media playlists.
▸ messagesGet(): Promise<{ command: string ; data: any ; status: number }>
Requests a list of all configured messages.
Promise<{ command: string ; data: any ; status: number }>
A list of all configured messages.
▸ messagesIdClear(id): Promise<{ command: string ; data: any ; status: number }>
Clears / Hides the specified message.
| Name | Type |
|---|---|
id |
string |
Promise<{ command: string ; data: any ; status: number }>
▸ messagesIdDelete(id): Promise<{ command: string ; data: any ; status: number }>
Deletes the specified message.
| Name | Type |
|---|---|
id |
string |
Promise<{ command: string ; data: any ; status: number }>
▸ messagesIdGet(id): Promise<{ command: string ; data: any ; status: number }>
Requests the details of the specified message.
| Name | Type |
|---|---|
id |
string |
Promise<{ command: string ; data: any ; status: number }>
The details of the specified message.
▸ messagesIdSet(id): Promise<{ command: string ; data: any ; status: number }>
Sets the details of the specified message.
| Name | Type |
|---|---|
id |
string |
Promise<{ command: string ; data: any ; status: number }>
▸ playlistActiveAnnouncementFocus(): Promise<{ command: string ; data: any ; status: number }>
Moves the focus to the currently active playlist for the announcement destination.
Promise<{ command: string ; data: any ; status: number }>
▸ playlistActiveAnnouncementIndexTrigger(index): Promise<{ command: string ; data: any ; status: number }>
Triggers the specified item in the currently active playlist for the announcement destination.
| Name | Type |
|---|---|
index |
string |
Promise<{ command: string ; data: any ; status: number }>
▸ playlistActiveAnnouncementTrigger(): Promise<{ command: string ; data: any ; status: number }>
Triggers the first item in the currently active playlist for the announcement destination.
Promise<{ command: string ; data: any ; status: number }>
▸ playlistActiveGet(): Promise<{ command: string ; data: any ; status: number }>
Requests the details of the active playlist.
Promise<{ command: string ; data: any ; status: number }>
The details of the active playlist.
▸ playlistActivePresentationFocus(): Promise<{ command: string ; data: any ; status: number }>
Moves the focus to the currently active playlist for the presentation destination.
Promise<{ command: string ; data: any ; status: number }>
▸ playlistActivePresentationIndexTrigger(index): Promise<{ command: string ; data: any ; status: number }>
Triggers the specified item in the currently active playlist for the presentation destination.
| Name | Type |
|---|---|
index |
string |
Promise<{ command: string ; data: any ; status: number }>
▸ playlistActivePresentationTrigger(): Promise<{ command: string ; data: any ; status: number }>
Triggers the first item in the currently active playlist for the presentation destination.
Promise<{ command: string ; data: any ; status: number }>
▸ playlistFocusedGet(): Promise<{ command: string ; data: any ; status: number }>
Requests the details of the currently focused playlist.
Promise<{ command: string ; data: any ; status: number }>
The details of the currently focused playlist.
▸ playlistFocusedIndexTrigger(index): Promise<{ command: string ; data: any ; status: number }>
Triggers the specified item in the focused playlist.
| Name | Type |
|---|---|
index |
string |
Promise<{ command: string ; data: any ; status: number }>
▸ playlistFocusedNextTrigger(): Promise<{ command: string ; data: any ; status: number }>
Triggers the next item in the currently focused playlist.
Promise<{ command: string ; data: any ; status: number }>
▸ playlistFocusedPreviousTrigger(): Promise<{ command: string ; data: any ; status: number }>
Triggers the previous item in the currently focused playlist.
Promise<{ command: string ; data: any ; status: number }>
▸ playlistFocusedTrigger(): Promise<{ command: string ; data: any ; status: number }>
Triggers the first item in the currently focused playlist.
Promise<{ command: string ; data: any ; status: number }>
▸ playlistIdentifierFocus(identifier): Promise<{ command: string ; data: any ; status: number }>
Moves the focus to the specified playlist.
| Name | Type |
|---|---|
identifier |
string |
Promise<{ command: string ; data: any ; status: number }>
▸ playlistIdentifierIndexTrigger(identifier, index): Promise<{ command: string ; data: any ; status: number }>
Triggers the specified item in the specified playlist.
| Name | Type |
|---|---|
identifier |
string |
index |
string |
Promise<{ command: string ; data: any ; status: number }>
▸ playlistIdentifierNextTrigger(identifier): Promise<{ command: string ; data: any ; status: number }>
Triggers the next item in the specified playlist.
| Name | Type |
|---|---|
identifier |
string |
Promise<{ command: string ; data: any ; status: number }>
▸ playlistIdentifierPreviousTrigger(identifier): Promise<{ command: string ; data: any ; status: number }>
Triggers the previous item in the specified playlist.
| Name | Type |
|---|---|
identifier |
string |
Promise<{ command: string ; data: any ; status: number }>
▸ playlistIdentifierTrigger(identifier): Promise<{ command: string ; data: any ; status: number }>
Triggers the first item in the specified playlist.
| Name | Type |
|---|---|
identifier |
string |
Promise<{ command: string ; data: any ; status: number }>
▸ playlistIdentifierUpdates(identifier): Promise<{ command: string ; data: any ; status: number }>
Requests a chunked data update every time the specified audio playlist changes.
| Name | Type |
|---|---|
identifier |
string |
Promise<{ command: string ; data: any ; status: number }>
A chunked data update every time the specified audio playlist changes.
▸ playlistNextFocus(): Promise<{ command: string ; data: any ; status: number }>
Moves the focus to the next playlist.
Promise<{ command: string ; data: any ; status: number }>
▸ playlistPlaylistIdGet(playlist_id): Promise<{ command: string ; data: any ; status: number }>
Requests a list of the items in the specified playlist.
| Name | Type |
|---|---|
playlist_id |
string |
Promise<{ command: string ; data: any ; status: number }>
Alist of the items in the specified playlist.
▸ playlistPlaylistIdSet(playlist_id): Promise<{ command: string ; data: any ; status: number }>
Sets the contents of the specified playlist.
| Name | Type |
|---|---|
playlist_id |
string |
Promise<{ command: string ; data: any ; status: number }>
▸ playlistPreviousFocus(): Promise<{ command: string ; data: any ; status: number }>
Moves the focus to the previous playlist.
Promise<{ command: string ; data: any ; status: number }>
▸ playlistsGet(): Promise<{ command: string ; data: any ; status: number }>
Requests a list of all configured playlists.
Promise<{ command: string ; data: any ; status: number }>
A list of all configured playlists.
▸ presentationActiveFocus(): Promise<{ command: string ; data: any ; status: number }>
Sets the focus to the active presentation.
Promise<{ command: string ; data: any ; status: number }>
▸ presentationActiveGet(): Promise<{ command: string ; data: any ; status: number }>
Requests the details of the currently active presentation.
Promise<{ command: string ; data: any ; status: number }>
The details of the currently active presentation.
▸ presentationActiveGroupGroup_IdTrigger(group_id): Promise<{ command: string ; data: any ; status: number }>
Triggers the specified group of the active presentation.
| Name | Type |
|---|---|
group_id |
string |
Promise<{ command: string ; data: any ; status: number }>
▸ presentationActiveIndexTrigger(index): Promise<{ command: string ; data: any ; status: number }>
Triggers the specified cue of the active presentation.
| Name | Type |
|---|---|
index |
string |
Promise<{ command: string ; data: any ; status: number }>
▸ presentationActiveNextTrigger(): Promise<{ command: string ; data: any ; status: number }>
Triggers the next cue of the active presentation.
Promise<{ command: string ; data: any ; status: number }>
▸ presentationActivePreviousTrigger(): Promise<{ command: string ; data: any ; status: number }>
Triggers the previous cue of the active presentation.
Promise<{ command: string ; data: any ; status: number }>
▸ presentationActiveTimeline(): Promise<{ command: string ; data: any ; status: number }>
Requests the current state of the active presentation timeline.
Promise<{ command: string ; data: any ; status: number }>
The current state of the active presentation timeline.
▸ presentationActiveTimelineOperation(operation): Promise<{ command: string ; data: any ; status: number }>
Performs the requested timeline operation for the currently active presentation (play, pause, rewind).
| Name | Type | Description |
|---|---|---|
operation |
"pause" | "play" | "rewind" |
(play, pause, rewind) |
Promise<{ command: string ; data: any ; status: number }>
▸ presentationActiveTrigger(): Promise<{ command: string ; data: any ; status: number }>
Retriggers the active presentation from the start.
Promise<{ command: string ; data: any ; status: number }>
▸ presentationChordChartGet(): Promise<{ command: string ; data: any ; status: number }>
Requests the current chord chart image (if available) at the given quality value.
Promise<{ command: string ; data: any ; status: number }>
The current chord chart image (if available) at the given quality value.
▸ presentationChordChartUpdates(): Promise<{ command: string ; data: any ; status: number }>
Requests a chunked data update every time the chord chart changes.
Promise<{ command: string ; data: any ; status: number }>
A chunked data update every time the chord chart changes.
▸ presentationFocusedGet(): Promise<{ command: string ; data: any ; status: number }>
Gets the currently focused presentation.
Promise<{ command: string ; data: any ; status: number }>
The currently focused presentation.
▸ presentationFocusedGroupGroup_IdTrigger(group_id): Promise<{ command: string ; data: any ; status: number }>
Triggers the specified group of the focused presentation.
| Name | Type |
|---|---|
group_id |
string |
Promise<{ command: string ; data: any ; status: number }>
▸ presentationFocusedIndexTrigger(index): Promise<{ command: string ; data: any ; status: number }>
Triggers the specified cue of the focused presentation.
| Name | Type |
|---|---|
index |
string |
Promise<{ command: string ; data: any ; status: number }>
▸ presentationFocusedNextTrigger(): Promise<{ command: string ; data: any ; status: number }>
Triggers the next cue of the focused presentation.
Promise<{ command: string ; data: any ; status: number }>
▸ presentationFocusedPreviousTrigger(): Promise<{ command: string ; data: any ; status: number }>
Triggers the previous cue of the focused presentation.
Promise<{ command: string ; data: any ; status: number }>
▸ presentationFocusedTimeline(): Promise<{ command: string ; data: any ; status: number }>
Requests the current state of the focused presentation timeline.
Promise<{ command: string ; data: any ; status: number }>
The current state of the focused presentation timeline.
▸ presentationFocusedTimelineOperation(operation): Promise<{ command: string ; data: any ; status: number }>
Performs the requested timeline operation for the currently focused presentation (play, pause, rewind).
| Name | Type | Description |
|---|---|---|
operation |
"pause" | "play" | "rewind" |
(play, pause, rewind) |
Promise<{ command: string ; data: any ; status: number }>
▸ presentationFocusedTrigger(): Promise<{ command: string ; data: any ; status: number }>
Triggers the focused presentation.
Promise<{ command: string ; data: any ; status: number }>
▸ presentationNextFocus(): Promise<{ command: string ; data: any ; status: number }>
Sets the focus to the next presentation.
Promise<{ command: string ; data: any ; status: number }>
▸ presentationPreviousFocus(): Promise<{ command: string ; data: any ; status: number }>
Sets the focus to the previous presentation.
Promise<{ command: string ; data: any ; status: number }>
▸ presentationSlideIndexGet(): Promise<{ command: string ; data: any ; status: number }>
Requests the index of the current slide/cue within the currently active presentation.
Promise<{ command: string ; data: any ; status: number }>
The index of the current slide/cue within the currently active presentation.
▸ presentationUUIDFocus(uuid): Promise<{ command: string ; data: any ; status: number }>
Sets the focus to the specified presentation.
| Name | Type |
|---|---|
uuid |
string |
Promise<{ command: string ; data: any ; status: number }>
▸ presentationUUIDFocusedTimelineOperation(uuid, operation): Promise<{ command: string ; data: any ; status: number }>
Performs the requested timeline operation for the specified presentation (play, pause, rewind).
| Name | Type | Description |
|---|---|---|
uuid |
string |
|
operation |
"pause" | "play" | "rewind" |
(play, pause, rewind) |
Promise<{ command: string ; data: any ; status: number }>
▸ presentationUUIDGet(uuid): Promise<{ command: string ; data: any ; status: number }>
Requests the details of the specified presentation.
| Name | Type |
|---|---|
uuid |
string |
Promise<{ command: string ; data: any ; status: number }>
The details of the specified presentation.
▸ presentationUUIDGroupGroup_IdTrigger(uuid, group_id): Promise<{ command: string ; data: any ; status: number }>
Triggers the specified group of the specified presentation.
| Name | Type |
|---|---|
uuid |
string |
group_id |
string |
Promise<{ command: string ; data: any ; status: number }>
▸ presentationUUIDIndexTrigger(uuid, index): Promise<{ command: string ; data: any ; status: number }>
Triggers the specified cue of the specified presentation.
| Name | Type |
|---|---|
uuid |
string |
index |
string |
Promise<{ command: string ; data: any ; status: number }>
▸ presentationUUIDNextTrigger(uuid): Promise<{ command: string ; data: any ; status: number }>
Triggers the next cue of the specified presentation.
| Name | Type |
|---|---|
uuid |
string |
Promise<{ command: string ; data: any ; status: number }>
▸ presentationUUIDPreviousTrigger(uuid): Promise<{ command: string ; data: any ; status: number }>
Triggers the previous cue of the specified presentation.
| Name | Type |
|---|---|
uuid |
string |
Promise<{ command: string ; data: any ; status: number }>
▸ presentationUUIDThumbnailIndex(uuid, index): Promise<{ command: string ; data: any ; status: number }>
Requests a thumbnail image of the specified cue inside the specified presentation at the given quality value.
Retuns
A thumbnail image of the specified cue inside the specified presentation at the given quality value.
| Name | Type |
|---|---|
uuid |
string |
index |
string |
Promise<{ command: string ; data: any ; status: number }>
▸ presentationUUIDTrigger(uuid): Promise<{ command: string ; data: any ; status: number }>
Triggers the specified presentation.
| Name | Type |
|---|---|
uuid |
string |
Promise<{ command: string ; data: any ; status: number }>
▸ propGet(): Promise<{ command: string ; data: any ; status: number }>
Gets a list of all the props.
Promise<{ command: string ; data: any ; status: number }>
A list of all the props.
▸ propId(id): Promise<{ command: string ; data: any ; status: number }>
Requests the details of the specified prop.
| Name | Type |
|---|---|
id |
string |
Promise<{ command: string ; data: any ; status: number }>
The details of the specified prop.
▸ propIdClear(id): Promise<{ command: string ; data: any ; status: number }>
Clears the specified prop.
| Name | Type |
|---|---|
id |
string |
Promise<{ command: string ; data: any ; status: number }>
▸ propIdDelete(id): Promise<{ command: string ; data: any ; status: number }>
Deletes the specified prop.
| Name | Type |
|---|---|
id |
string |
Promise<{ command: string ; data: any ; status: number }>
▸ propIdThumbnail(id): Promise<{ command: string ; data: any ; status: number }>
Requests a thumbnail image of the specified prop at the given quality value.
| Name | Type |
|---|---|
id |
string |
Promise<{ command: string ; data: any ; status: number }>
A thumbnail image of the specified prop at the given quality value.
▸ propIdTrigger(id): Promise<{ command: string ; data: any ; status: number }>
Triggers the specified prop.
| Name | Type |
|---|---|
id |
string |
Promise<{ command: string ; data: any ; status: number }>
▸ stageLayoutIdDelete(id): Promise<{ command: string ; data: any ; status: number }>
Deletes the specified stage layout.
| Name | Type |
|---|---|
id |
string |
Promise<{ command: string ; data: any ; status: number }>
▸ stageLayoutIdThumbnail(id): Promise<{ command: string ; data: any ; status: number }>
Requests a thumbnail image of the specified stage layout at the given quality value.
| Name | Type |
|---|---|
id |
string |
Promise<{ command: string ; data: any ; status: number }>
A thumbnail image of the specified stage layout at the given quality value.
▸ stageLayoutMap(): Promise<{ command: string ; data: any ; status: number }>
Requests the currently selected stage layout for each configured stage screen.
Promise<{ command: string ; data: any ; status: number }>
The currently selected stage layout for each configured stage screen.
▸ stageLayoutMapSet(): Promise<{ command: string ; data: any ; status: number }>
Sets the specified stage message to the corresponding stage screens. NOT READY
Promise<{ command: string ; data: any ; status: number }>
▸ stageLayoutsGet(): Promise<{ command: string ; data: any ; status: number }>
Requests a list of the configured stage layouts.
Promise<{ command: string ; data: any ; status: number }>
A list of the configured stage layouts.
▸ stageMessage(): Promise<{ command: string ; data: any ; status: number }>
Shows the specified stage message on the configured stage screen.
Promise<{ command: string ; data: any ; status: number }>
▸ stageMessageGet(): Promise<{ command: string ; data: any ; status: number }>
Requests the currently active stage message.
Promise<{ command: string ; data: any ; status: number }>
The currently active stage message.
▸ stageMessageHide(): Promise<{ command: string ; data: any ; status: number }>
Hides the currently displayed stage message from the configured stage screen.
Promise<{ command: string ; data: any ; status: number }>
▸ stageScreenIdLayout(id): Promise<{ command: string ; data: any ; status: number }>
Requests the current stage layout for the specified stage screen.
| Name | Type |
|---|---|
id |
string |
Promise<{ command: string ; data: any ; status: number }>
The current stage layout for the specified stage screen.
▸ stageScreenIdLayoutId(id, layout_id): Promise<{ command: string ; data: any ; status: number }>
Sets the specified stage layout for the specified stage screen.
| Name | Type |
|---|---|
id |
string |
layout_id |
string |
Promise<{ command: string ; data: any ; status: number }>
▸ stageScreensGet(): Promise<{ command: string ; data: any ; status: number }>
Requests a list of the configured stage screens.
Promise<{ command: string ; data: any ; status: number }>
A list of the configured stage screens.
▸ statusAudienceScreens(): Promise<{ command: string ; data: any ; status: number }>
Requests the status of the audience screens.
Promise<{ command: string ; data: any ; status: number }>
The status of the audience screens.
▸ statusAudienceScreensSet(): Promise<{ command: string ; data: any ; status: number }>
Sets the status of the audience screens. NOT READY
Promise<{ command: string ; data: any ; status: number }>
▸ statusLayers(): Promise<{ command: string ; data: any ; status: number }>
Requests the status of all available layers.
Promise<{ command: string ; data: any ; status: number }>
The status of all available layers.
▸ statusScreens(): Promise<{ command: string ; data: any ; status: number }>
Requests the details of all configured screens.
Promise<{ command: string ; data: any ; status: number }>
The details of all configured screens.
▸ statusSlide(): Promise<{ command: string ; data: any ; status: number }>
Requests the current/next slide text and image UUIDs.
Promise<{ command: string ; data: any ; status: number }>
The Requests the current/next slide text and image UUIDs.
▸ statusStageScreens(): Promise<{ command: string ; data: any ; status: number }>
Requests the status of the stage screens.
Promise<{ command: string ; data: any ; status: number }>
The status of the stage screens.
▸ statusStageScreensSet(): Promise<{ command: string ; data: any ; status: number }>
Sets the status of the stage screens. NOT READY
Promise<{ command: string ; data: any ; status: number }>
▸ statusUpdate(): Promise<{ command: string ; data: any ; status: number }>
Aggregates the data from one or more streaming endpoints into a single streaming endpoint. NOT READY
Promise<{ command: string ; data: any ; status: number }>
▸ themesGet(): Promise<{ command: string ; data: any ; status: number }>
Requests a list of all configured themes and theme slides.
Promise<{ command: string ; data: any ; status: number }>
A list of all configured themes and theme slides.
▸ themesIdGet(id): Promise<{ command: string ; data: any ; status: number }>
Requests the details of the theme and theme slides.
| Name | Type |
|---|---|
id |
string |
Promise<{ command: string ; data: any ; status: number }>
The details of the theme and theme slides.
▸ themesIdSlidesThemeSlide(id, theme_slide): Promise<{ command: string ; data: any ; status: number }>
Requests the details of the specified theme slide within the specified theme.
| Name | Type |
|---|---|
id |
string |
theme_slide |
string |
Promise<{ command: string ; data: any ; status: number }>
The details of the specified theme slide within the specified theme.
▸ themesIdSlidesThemeSlideSet(id, theme_slide): Promise<{ command: string ; data: any ; status: number }>
Sets the details of the specified theme slide within the specified theme.
| Name | Type | Description |
|---|---|---|
id |
string |
|
theme_slide |
string |
NOT READY |
Promise<{ command: string ; data: any ; status: number }>
▸ themesIdSlidesThemeSlideThumbnail(id, theme_slide): Promise<{ command: string ; data: any ; status: number }>
Requests a thumbnail image of the specified theme slide at the given quality value.
| Name | Type |
|---|---|
id |
string |
theme_slide |
string |
Promise<{ command: string ; data: any ; status: number }>
The details of the specified theme slide within the specified theme.
▸ timerCreate(): Promise<{ command: string ; data: any ; status: number }>
Creates a new timer with the specified details.
Promise<{ command: string ; data: any ; status: number }>
▸ timerIdDelete(id): Promise<{ command: string ; data: any ; status: number }>
Deletes the specified timer.
| Name | Type |
|---|---|
id |
string |
Promise<{ command: string ; data: any ; status: number }>
▸ timerIdGet(id): Promise<{ command: string ; data: any ; status: number }>
Requests the details of the specified timer.
| Name | Type |
|---|---|
id |
string |
Promise<{ command: string ; data: any ; status: number }>
The details of the specified timer.
▸ timerIdOperation(id, operation): Promise<{ command: string ; data: any ; status: number }>
Performs the requested operation on the specified timer.
| Name | Type | Description |
|---|---|---|
id |
string |
|
operation |
"stop" | "start" | "reset" |
(start, stop, reset) |
Promise<{ command: string ; data: any ; status: number }>
▸ timerIdSet(id): Promise<{ command: string ; data: any ; status: number }>
Sets the details of the specified timer.
| Name | Type | Description |
|---|---|---|
id |
string |
NOT READY |
Promise<{ command: string ; data: any ; status: number }>
▸ timerSystemTime(): Promise<{ command: string ; data: any ; status: number }>
Requests the current system time.
Promise<{ command: string ; data: any ; status: number }>
The current system time.
▸ timerVideoCountdown(): Promise<{ command: string ; data: any ; status: number }>
Requests the current value of the video countdown timer.
Promise<{ command: string ; data: any ; status: number }>
The current value of the video countdown timer.
▸ timersCurrent(): Promise<{ command: string ; data: any ; status: number }>
Requests the current time for all configured timers.
Promise<{ command: string ; data: any ; status: number }>
The current time for all configured timers.
▸ timersGet(): Promise<{ command: string ; data: any ; status: number }>
Requests the details for all configured timers.
Promise<{ command: string ; data: any ; status: number }>
The details for all configured timers.
▸ timersOperation(operation): Promise<{ command: string ; data: any ; status: number }>
Performs the requested operation for all configured timers.
| Name | Type | Description |
|---|---|---|
operation |
"stop" | "start" | "reset" |
(start, stop, reset) |
Promise<{ command: string ; data: any ; status: number }>
▸ transportLayerAutoAdvance(layer): Promise<{ command: string ; data: any ; status: number }>
Requests the auto-advance status for the specified layer.
| Name | Type | Description |
|---|---|---|
layer |
"presentation" | "announcement" |
(presentation, announcement). |
Promise<{ command: string ; data: any ; status: number }>
The auto-advance status for the specified layer.
▸ transportLayerAutoAdvanceDelete(layer): Promise<{ command: string ; data: any ; status: number }>
Cancels the auto-advance for the specified layer.
| Name | Type | Description |
|---|---|---|
layer |
"presentation" | "announcement" |
(presentation, announcement). |
Promise<{ command: string ; data: any ; status: number }>
▸ transportLayerCurrent(layer): Promise<{ command: string ; data: any ; status: number }>
Requests the details of the currently playing content for the specified layer
| Name | Type | Description |
|---|---|---|
layer |
"presentation" | "announcement" |
(presentation, announcement). |
Promise<{ command: string ; data: any ; status: number }>
The details of the currently playing content for the specified layer
▸ transportLayerGoToEnd(layer): Promise<{ command: string ; data: any ; status: number }>
Moves to the end on a certain layer
| Name | Type | Description |
|---|---|---|
layer |
"audio" | "presentation" | "announcement" |
(presentation, announcement, audio) |
Promise<{ command: string ; data: any ; status: number }>
▸ transportLayerPause(layer): Promise<{ command: string ; data: any ; status: number }>
Pauses the content on the specified layer.
| Name | Type | Description |
|---|---|---|
layer |
"audio" | "presentation" | "announcement" |
(presentation, announcement, audio) |
Promise<{ command: string ; data: any ; status: number }>
▸ transportLayerPlay(layer): Promise<{ command: string ; data: any ; status: number }>
Plays the content on the specified layer.
| Name | Type | Description |
|---|---|---|
layer |
"audio" | "presentation" | "announcement" |
(presentation, announcement, audio) |
Promise<{ command: string ; data: any ; status: number }>
▸ transportLayerSkipBackwardTime(layer, time): Promise<{ command: string ; data: any ; status: number }>
Moves backward in the content on the specified layer by the specified number of seconds.
| Name | Type | Description |
|---|---|---|
layer |
"audio" | "presentation" | "announcement" |
(presentation, announcement, audio) |
time |
number |
in seconds |
Promise<{ command: string ; data: any ; status: number }>
▸ transportLayerSkipForwardTime(layer, time): Promise<{ command: string ; data: any ; status: number }>
Moves forward in the content on the specified layer by the specified number of seconds.
| Name | Type | Description |
|---|---|---|
layer |
"audio" | "presentation" | "announcement" |
(presentation, announcement, audio) |
time |
number |
in seconds |
Promise<{ command: string ; data: any ; status: number }>
▸ transportLayerTime(layer): Promise<{ command: string ; data: any ; status: number }>
Requests the current transport time for the specified layer.
| Name | Type | Description |
|---|---|---|
layer |
"audio" | "presentation" | "announcement" |
(presentation, announcement, audio) |
Promise<{ command: string ; data: any ; status: number }>
The current transport time for the specified layer.
▸ transportLayerTimeSet(layer): Promise<{ command: string ; data: any ; status: number }>
Moves to the specified time for the specified layer
| Name | Type | Description |
|---|---|---|
layer |
"audio" | "presentation" | "announcement" |
(presentation, announcement, audio) |
Promise<{ command: string ; data: any ; status: number }>
▸ triggerAudioNext(): Promise<{ command: string ; data: any ; status: number }>
Triggers the next item in the currently active media playlist.
Promise<{ command: string ; data: any ; status: number }>
▸ triggerAudioPrevious(): Promise<{ command: string ; data: any ; status: number }>
Triggers the previous item in the currently active audio playlist.
Promise<{ command: string ; data: any ; status: number }>
▸ triggerMediaNext(): Promise<{ command: string ; data: any ; status: number }>
Triggers the next item in the currently active media playlist.
Promise<{ command: string ; data: any ; status: number }>
▸ triggerMediaPrevious(): Promise<{ command: string ; data: any ; status: number }>
Triggers the previous item in the currently active media playlist.
Promise<{ command: string ; data: any ; status: number }>
▸ triggerNext(): Promise<{ command: string ; data: any ; status: number }>
Triggers the next cue or item in the currently active playlist or library.
Promise<{ command: string ; data: any ; status: number }>
▸ triggerPrevious(): Promise<{ command: string ; data: any ; status: number }>
Triggers the previous cue or item in the currently active playlist or library.
Promise<{ command: string ; data: any ; status: number }>
▸ version(): Promise<{ command: string ; data: any ; status: number }>
Requests the general information about the currently active ProPresenter instance
Promise<{ command: string ; data: any ; status: number }>
General information about the currently active ProPresenter instance
▸ videoInputs(): Promise<{ command: string ; data: any ; status: number }>
Requests the contents of the video inputs playlist.
Promise<{ command: string ; data: any ; status: number }>
The contents of the video inputs playlist.
▸ videoInputsIdTrigger(id): Promise<{ command: string ; data: any ; status: number }>
Triggers a video input from the video inputs playlist.
| Name | Type |
|---|---|
id |
string |
Promise<{ command: string ; data: any ; status: number }>