renewedvision-propresenter v7.3.0
UNDER CONSTRUCTION, ONLY FIRST PART OF API IS INCORPORATED
POST COMMANDS AREN't INCULDED AT THIS POINT
RenewedVision ProPresenter API wrapper
Typescript wrapper for Node.js.
Installation
yarn add renewedvision-propresenter
Usage
import { ProPresenter } from 'renewedvision-propresenter'
// Change IP and Port to the values from ProPresenter; settings... > Network (enable network)
this.ProPresenter = new ProPresenter('10.0.0.1', 1025)
// 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"},
"status":200,
"command":"/version"}
*/
})
'command' result will return the requested action/command. This way you can see where the data is returning from.
Constructors
Properties
Methods
- announcementActiveFocus
- announcementActiveIndexTrigger
- announcementActiveTimelineOperation
- announcementGetActive
- announcementGetActiveTimelineOperation
- announcementGetSlideIndex
- announcementNextTrigger
- announcementPreviousTrigger
- announcementTrigger
- audioGetPlaylists
- audioGetPlaylistsActive
- audioGetPlaylistsByPlaylistId
- audioGetPlaylistsByPlaylistIdUpdates
- audioGetPlaylistsFocused
- audioPlaylistsActiveFocus
- audioPlaylistsActiveIdTrigger
- audioPlaylistsActiveNextTrigger
- audioPlaylistsActiveTrigger
- audioPlaylistsActivedPreviousTrigger
- 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
Constructors
constructor
• new ProPresenter(ip
, port
)
Parameters
Name | Type |
---|---|
ip | string |
port | number |
Defined in
Properties
ip
• ip: string
Defined in
port
• port: number
Defined in
Methods
announcementActiveFocus
▸ announcementActiveFocus(): Promise
<{ command
: string
; data
: any
; status
: number
}>
Focuses the currently active announcement presentation.
Returns
Promise
<{ command
: string
; data
: any
; status
: number
}>
Defined in
announcementActiveIndexTrigger
▸ announcementActiveIndexTrigger(index
): Promise
<{ command
: string
; data
: any
; status
: number
}>
Triggers the specified cue in the currently active announcement presentation.
Parameters
Name | Type |
---|---|
index | string | number |
Returns
Promise
<{ command
: string
; data
: any
; status
: number
}>
Defined in
announcementActiveTimelineOperation
▸ announcementActiveTimelineOperation(operation
): Promise
<{ command
: string
; data
: any
; status
: number
}>
Performs the requested timeline operation for the active announcment presentation.
Parameters
Name | Type |
---|---|
operation | any |
Returns
Promise
<{ command
: string
; data
: any
; status
: number
}>
Defined in
announcementGetActive
▸ announcementGetActive(): Promise
<{ command
: string
; data
: any
; status
: number
}>
Requests the currently active announcement presentation.
Returns
Promise
<{ command
: string
; data
: any
; status
: number
}>
the currently active announcement presentation.
Defined in
announcementGetActiveTimelineOperation
▸ announcementGetActiveTimelineOperation(): Promise
<{ command
: string
; data
: any
; status
: number
}>
Requests the current state of the active announcement timeline.
Returns
Promise
<{ command
: string
; data
: any
; status
: number
}>
The current state of the active announcement timeline.
Defined in
announcementGetSlideIndex
▸ announcementGetSlideIndex(): Promise
<{ command
: string
; data
: any
; status
: number
}>
Requests the index of the current slide/cue within the currently active announcement.
Returns
Promise
<{ command
: string
; data
: any
; status
: number
}>
The index of the current slide/cue within the currently active announcement.
Defined in
announcementNextTrigger
▸ announcementNextTrigger(): Promise
<{ command
: string
; data
: any
; status
: number
}>
Triggers the next cue in the active announcement presentation (if there is one).
Returns
Promise
<{ command
: string
; data
: any
; status
: number
}>
Defined in
announcementPreviousTrigger
▸ announcementPreviousTrigger(): Promise
<{ command
: string
; data
: any
; status
: number
}>
Triggers the previous cue in the currently active announcement presentation (if there is one).
Returns
Promise
<{ command
: string
; data
: any
; status
: number
}>
Defined in
announcementTrigger
▸ announcementTrigger(): Promise
<{ command
: string
; data
: any
; status
: number
}>
Retriggers the currently active announcement presentation (starts from the beginning).
Returns
Promise
<{ command
: string
; data
: any
; status
: number
}>
Defined in
audioGetPlaylists
▸ audioGetPlaylists(): Promise
<{ command
: string
; data
: any
; status
: number
}>
Requests a list with all the configured audio playlists.
Returns
Promise
<{ command
: string
; data
: any
; status
: number
}>
a list with all the configured audio playlists.
Defined in
audioGetPlaylistsActive
▸ audioGetPlaylistsActive(): Promise
<{ command
: string
; data
: any
; status
: number
}>
Requests the currently active audio playlist
Returns
Promise
<{ command
: string
; data
: any
; status
: number
}>
The currently active audio playlist
Defined in
audioGetPlaylistsByPlaylistId
▸ audioGetPlaylistsByPlaylistId(playlist_id
): Promise
<{ command
: string
; data
: any
; status
: number
}>
Requests a list of all the audio items in the specified audio playlist.
Parameters
Name | Type |
---|---|
playlist_id | any |
Returns
Promise
<{ command
: string
; data
: any
; status
: number
}>
a list of all the audio items in the specified audio playlist.
Defined in
audioGetPlaylistsByPlaylistIdUpdates
▸ audioGetPlaylistsByPlaylistIdUpdates(playlist_id
): Promise
<{ command
: string
; data
: any
; status
: number
}>
Requests a chunked data update every time the specified audio playlist changes.
Parameters
Name | Type |
---|---|
playlist_id | any |
Returns
Promise
<{ command
: string
; data
: any
; status
: number
}>
a chunked data update every time the specified audio playlist changes.
Defined in
audioGetPlaylistsFocused
▸ audioGetPlaylistsFocused(): Promise
<{ command
: string
; data
: any
; status
: number
}>
Requests the currently focused audio playlist
Returns
Promise
<{ command
: string
; data
: any
; status
: number
}>
The currently focused audio playlist
Defined in
audioPlaylistsActiveFocus
▸ audioPlaylistsActiveFocus(): Promise
<{ command
: string
; data
: any
; status
: number
}>
Focuses the active audio playlist.
Returns
Promise
<{ command
: string
; data
: any
; status
: number
}>
Defined in
audioPlaylistsActiveIdTrigger
▸ audioPlaylistsActiveIdTrigger(id
): Promise
<{ command
: string
; data
: any
; status
: number
}>
Triggers the specified item in the active audio playlist.
Params
id
Parameters
Name | Type |
---|---|
id | any |
Returns
Promise
<{ command
: string
; data
: any
; status
: number
}>
Defined in
audioPlaylistsActiveNextTrigger
▸ audioPlaylistsActiveNextTrigger(): Promise
<{ command
: string
; data
: any
; status
: number
}>
Triggers the next item in the active audio playlist.
Returns
Promise
<{ command
: string
; data
: any
; status
: number
}>
Defined in
audioPlaylistsActiveTrigger
▸ audioPlaylistsActiveTrigger(): Promise
<{ command
: string
; data
: any
; status
: number
}>
Triggers the active audio playlist (restarts from the beginning).
Returns
Promise
<{ command
: string
; data
: any
; status
: number
}>
Defined in
audioPlaylistsActivedPreviousTrigger
▸ audioPlaylistsActivedPreviousTrigger(): Promise
<{ command
: string
; data
: any
; status
: number
}>
Triggers the previous item in the active audio playlist.
Returns
Promise
<{ command
: string
; data
: any
; status
: number
}>
Defined in
audioPlaylistsByPlaylistIdFocus
▸ audioPlaylistsByPlaylistIdFocus(playlist_id
): Promise
<{ command
: string
; data
: any
; status
: number
}>
Focuses the specified audio playlist.
Parameters
Name | Type |
---|---|
playlist_id | any |
Returns
Promise
<{ command
: string
; data
: any
; status
: number
}>
Defined in
audioPlaylistsByPlaylistIdNextTrigger
▸ audioPlaylistsByPlaylistIdNextTrigger(playlist_id
): Promise
<{ command
: string
; data
: any
; status
: number
}>
Triggers the next item in the specified audio playlist.
Parameters
Name | Type |
---|---|
playlist_id | any |
Returns
Promise
<{ command
: string
; data
: any
; status
: number
}>
Defined in
audioPlaylistsByPlaylistIdPreviousTrigger
▸ audioPlaylistsByPlaylistIdPreviousTrigger(playlist_id
): Promise
<{ command
: string
; data
: any
; status
: number
}>
Triggers the previous item in the specified audio playlist.
Parameters
Name | Type |
---|---|
playlist_id | any |
Returns
Promise
<{ command
: string
; data
: any
; status
: number
}>
Defined in
audioPlaylistsByPlaylistIdTrigger
▸ audioPlaylistsByPlaylistIdTrigger(playlist_id
): Promise
<{ command
: string
; data
: any
; status
: number
}>
Triggers the specified audio playlist.
Parameters
Name | Type |
---|---|
playlist_id | any |
Returns
Promise
<{ command
: string
; data
: any
; status
: number
}>
Defined in
audioPlaylistsFocusedIdTrigger
▸ audioPlaylistsFocusedIdTrigger(id
): Promise
<{ command
: string
; data
: any
; status
: number
}>
Triggers the specified item in the focused audio playlist.
Params
id
Parameters
Name | Type |
---|---|
id | any |
Returns
Promise
<{ command
: string
; data
: any
; status
: number
}>
Defined in
audioPlaylistsFocusedNextTrigger
▸ audioPlaylistsFocusedNextTrigger(): Promise
<{ command
: string
; data
: any
; status
: number
}>
Triggers the next item in the focused audio playlist.
Returns
Promise
<{ command
: string
; data
: any
; status
: number
}>
Defined in
audioPlaylistsFocusedPreviousTrigger
▸ audioPlaylistsFocusedPreviousTrigger(): Promise
<{ command
: string
; data
: any
; status
: number
}>
Triggers the previous item in the focused audio playlist.
Returns
Promise
<{ command
: string
; data
: any
; status
: number
}>
Defined in
audioPlaylistsFocusedTrigger
▸ audioPlaylistsFocusedTrigger(): Promise
<{ command
: string
; data
: any
; status
: number
}>
Triggers the focused audio playlist.
Returns
Promise
<{ command
: string
; data
: any
; status
: number
}>
Defined in
audioPlaylistsNextFocus
▸ audioPlaylistsNextFocus(): Promise
<{ command
: string
; data
: any
; status
: number
}>
Focuses the next audio playlist.
Returns
Promise
<{ command
: string
; data
: any
; status
: number
}>
Defined in
audioPlaylistsPreviousFocus
▸ audioPlaylistsPreviousFocus(): Promise
<{ command
: string
; data
: any
; status
: number
}>
Focuses the previous audio playlist.
Returns
Promise
<{ command
: string
; data
: any
; status
: number
}>
Defined in
captureEncodingsType
▸ captureEncodingsType(type
): Promise
<{ command
: string
; data
: any
; status
: number
}>
Requests a list of all available capture modes for the capture type (disk, rtmp, resi).
Parameters
Name | Type | Description |
---|---|---|
type | "disk" | "rtmp" | "resi" | (disk, rtmp, resi) |
Returns
Promise
<{ command
: string
; data
: any
; status
: number
}>
A list of all available capture modes for the capture type (disk, rtmp, resi).
Defined in
captureGetStatus
▸ captureGetStatus(): Promise
<{ command
: string
; data
: any
; status
: number
}>
Requests the current capture status and capture time.
Returns
Promise
<{ command
: string
; data
: any
; status
: number
}>
The current capture status and capture time.
Defined in
captureGetsettings
▸ captureGetsettings(): Promise
<{ command
: string
; data
: any
; status
: number
}>
Requests the current capture settings.
Returns
Promise
<{ command
: string
; data
: any
; status
: number
}>
The current capture settings.
Defined in
captureOperation
▸ captureOperation(operation
): Promise
<{ command
: string
; data
: any
; status
: number
}>
Performs the requested capture operation (start, stop).
Parameters
Name | Type | Description |
---|---|---|
operation | "stop" | "start" | (start, stop) |
Returns
Promise
<{ command
: string
; data
: any
; status
: number
}>
Defined in
clearCreateGroup
▸ 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.
Parameters
Name | Type |
---|---|
name | string |
layers | string [] |
stop_timeline_announcements | boolean |
stop_timeline_presentation | boolean |
clear_next_presentation | boolean |
Returns
Promise
<{ command
: string
; data
: any
; status
: number
}>
The created group.
Defined in
clearDeleteGroupId
▸ clearDeleteGroupId(id
): Promise
<{ command
: string
; data
: any
; status
: number
}>
Deletes the specified clear group.
Parameters
Name | Type | Description |
---|---|---|
id | string | (name, index or UUID) |
Returns
Promise
<{ command
: string
; data
: any
; status
: number
}>
Defined in
clearGetGroup
▸ clearGetGroup(): Promise
<{ command
: string
; data
: any
; status
: number
}>
Requests a list of all the configured clear groups.
Returns
Promise
<{ command
: string
; data
: any
; status
: number
}>
A list of all the configured clear groups.
Defined in
clearGetGroupId
▸ clearGetGroupId(id
): Promise
<{ command
: string
; data
: any
; status
: number
}>
Requests the details of the specified clear group.
Parameters
Name | Type | Description |
---|---|---|
id | string | (name, index or UUID) |
Returns
Promise
<{ command
: string
; data
: any
; status
: number
}>
The details of the specified clear group.
Defined in
clearGetGroupIdIcon
▸ clearGetGroupIdIcon(id
): Promise
<{ command
: string
; data
: any
; status
: number
}>
Requests the image data for the icon of the specified clear group.
Parameters
Name | Type | Description |
---|---|---|
id | string | (name, index or UUID) |
Returns
Promise
<{ command
: string
; data
: any
; status
: number
}>
The image data for the icon of the specified clear group.
Defined in
clearGroupIdTrigger
▸ clearGroupIdTrigger(id
): Promise
<{ command
: string
; data
: any
; status
: number
}>
Triggers the specified clear group.
Parameters
Name | Type | Description |
---|---|---|
id | string | (name, index or UUID) |
Returns
Promise
<{ command
: string
; data
: any
; status
: number
}>
Defined in
clearLayer
▸ clearLayer(layer
): Promise
<{ command
: string
; data
: any
; status
: number
}>
Clears the specified layer (audio, props, messages, announcements, slide, media, video_input).
Parameters
Name | Type | Description |
---|---|---|
layer | "media" | "audio" | "props" | "messages" | "announcements" | "slide" | "video_input" | (audio, props, messages, announcements, slide, media, video_input) |
Returns
Promise
<{ command
: string
; data
: any
; status
: number
}>
Defined in
clearSetGroupId
▸ clearSetGroupId(id
): Promise
<{ command
: string
; data
: any
; status
: number
}>
Sets the details of the specified clear group.
Parameters
Name | Type | Description |
---|---|---|
id | string | (name, index or UUID) |
Returns
Promise
<{ command
: string
; data
: any
; status
: number
}>
The details of the specified clear group.
Defined in
clearSetGroupIdIcon
▸ clearSetGroupIdIcon(id
): Promise
<{ command
: string
; data
: any
; status
: number
}>
Sets the custom icon of the specified clear group.
Parameters
Name | Type | Description |
---|---|---|
id | string | (name, index or UUID) |
Returns
Promise
<{ command
: string
; data
: any
; status
: number
}>
Defined in
findMyMouse
▸ findMyMouse(): Promise
<{ command
: string
; data
: any
; status
: number
}>
Executes the "Find My Mouse" operation.
Returns
Promise
<{ command
: string
; data
: any
; status
: number
}>
Defined in
getDataFromProPresenter
▸ Private
getDataFromProPresenter(path
, userOptions?
): Promise
<{ command
: string
; data
: any
; status
: number
}>
API wrapper function, use fetch to send/retrieve the data from ProPresenter
Parameters
Name | Type | Description |
---|---|---|
path | string | |
userOptions? | any | (optional) |
Returns
Promise
<{ command
: string
; data
: any
; status
: number
}>
Promise from fetch
Defined in
groupsGet
▸ groupsGet(): Promise
<{ command
: string
; data
: any
; status
: number
}>
Requests a list of all the configured global groups.
Returns
Promise
<{ command
: string
; data
: any
; status
: number
}>
A list of all the configured global groups.
Defined in
libraryByIdPresentationIdCueTrigger
▸ 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.
Parameters
Name | Type |
---|---|
library_id | string |
presentation_id | string |
cue | string |
Returns
Promise
<{ command
: string
; data
: any
; status
: number
}>
Defined in
libraryByIdPresentationIdTrigger
▸ libraryByIdPresentationIdTrigger(library_id
, presentation_id
): Promise
<{ command
: string
; data
: any
; status
: number
}>
Triggers the first cue of the specified presentation in the specified library.
Parameters
Name | Type |
---|---|
library_id | string |
presentation_id | string |
Returns
Promise
<{ command
: string
; data
: any
; status
: number
}>
Defined in
libraryGet
▸ libraryGet(): Promise
<{ command
: string
; data
: any
; status
: number
}>
Requests a list of all the configured libraries.
Returns
Promise
<{ command
: string
; data
: any
; status
: number
}>
A list of all the configured libraries.
Defined in
libraryGetById
▸ 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)
Parameters
Name | Type |
---|---|
id | string |
Returns
Promise
<{ command
: string
; data
: any
; status
: number
}>
An array of all items in the specified library.
Defined in
lookDeleteId
▸ lookDeleteId(id
): Promise
<{ command
: string
; data
: any
; status
: number
}>
Deletes the specified audience look from the saved looks.
Parameters
Name | Type |
---|---|
id | string |
Returns
Promise
<{ command
: string
; data
: any
; status
: number
}>
Defined in
lookGet
▸ lookGet(): Promise
<{ command
: string
; data
: any
; status
: number
}>
Requests a list of all configured audience looks, except the live look.
Returns
Promise
<{ command
: string
; data
: any
; status
: number
}>
A list of all configured audience looks, except the live look.
Defined in
lookGetCurrent
▸ lookGetCurrent(): Promise
<{ command
: string
; data
: any
; status
: number
}>
Requests the details of the currently live audience look.
Returns
Promise
<{ command
: string
; data
: any
; status
: number
}>
The details of the currently live audience look.
Defined in
lookGetId
▸ lookGetId(id
): Promise
<{ command
: string
; data
: any
; status
: number
}>
Requests the details of the specified audience look.
Parameters
Name | Type |
---|---|
id | string |
Returns
Promise
<{ command
: string
; data
: any
; status
: number
}>
The details of the specified audience look.
Defined in
lookIdTrigger
▸ lookIdTrigger(id
): Promise
<{ command
: string
; data
: any
; status
: number
}>
Triggers the specified audience look to make it the live/current look.
Parameters
Name | Type |
---|---|
id | string |
Returns
Promise
<{ command
: string
; data
: any
; status
: number
}>
Defined in
lookSetCurrent
▸ lookSetCurrent(): Promise
<{ command
: string
; data
: any
; status
: number
}>
Requests the details of the currently live audience look.
Returns
Promise
<{ command
: string
; data
: any
; status
: number
}>
The details of the currently live audience look.
Defined in
lookSetId
▸ lookSetId(id
): Promise
<{ command
: string
; data
: any
; status
: number
}>
Sets the details of the specified audience look.
Parameters
Name | Type |
---|---|
id | string |
Returns
Promise
<{ command
: string
; data
: any
; status
: number
}>
Defined in
marcosGet
▸ marcosGet(): Promise
<{ command
: string
; data
: any
; status
: number
}>
Requests a list of all the configured macros.
Returns
Promise
<{ command
: string
; data
: any
; status
: number
}>
A list of all the configured macros.
Defined in
marcosIdDelete
▸ marcosIdDelete(id
): Promise
<{ command
: string
; data
: any
; status
: number
}>
Deletes the specified macro.
Parameters
Name | Type |
---|---|
id | string |
Returns
Promise
<{ command
: string
; data
: any
; status
: number
}>
Defined in
marcosIdGet
▸ marcosIdGet(id
): Promise
<{ command
: string
; data
: any
; status
: number
}>
Requests the details of the specified macro.
Parameters
Name | Type |
---|---|
id | string |
Returns
Promise
<{ command
: string
; data
: any
; status
: number
}>
The details of the specified macro.
Defined in
marcosIdSet
▸ marcosIdSet(id
): Promise
<{ command
: string
; data
: any
; status
: number
}>
Sets the details of the specified macro.
Parameters
Name | Type |
---|---|
id | string |
Returns
Promise
<{ command
: string
; data
: any
; status
: number
}>
Defined in
marcosIdTriggerGet
▸ marcosIdTriggerGet(id
): Promise
<{ command
: string
; data
: any
; status
: number
}>
Triggers the specified macro.
Parameters
Name | Type |
---|---|
id | string |
Returns
Promise
<{ command
: string
; data
: any
; status
: number
}>
Defined in
masksGet
▸ masksGet(): Promise
<{ command
: string
; data
: any
; status
: number
}>
Requests a list of all configured masks.
Returns
Promise
<{ command
: string
; data
: any
; status
: number
}>
A list of all configured masks.
Defined in
masksIdGet
▸ masksIdGet(id
): Promise
<{ command
: string
; data
: any
; status
: number
}>
Requests the details of the specified mask.
Parameters
Name | Type |
---|---|
id | string |
Returns
Promise
<{ command
: string
; data
: any
; status
: number
}>
The details of the specified mask.
Defined in
masksIdThumbnailGet
▸ masksIdThumbnailGet(id
): Promise
<{ command
: string
; data
: any
; status
: number
}>
Requests a thumbnail image of the specified mask at the given quality value.
Parameters
Name | Type |
---|---|
id | string |
Returns
Promise
<{ command
: string
; data
: any
; status
: number
}>
A thumbnail image of the specified mask at the given quality value.
Defined in
mediaByUUIDThumbnailsGet
▸ mediaByUUIDThumbnailsGet(uuid
): Promise
<{ command
: string
; data
: any
; status
: number
}>
Requests a thumbnail image of the specified media item at the given quality value.
Parameters
Name | Type |
---|---|
uuid | string |
Returns
Promise
<{ command
: string
; data
: any
; status
: number
}>
A thumbnail image of the specified media item at the given quality value.
Defined in
mediaPlaylistActiveFocus
▸ mediaPlaylistActiveFocus(): Promise
<{ command
: string
; data
: any
; status
: number
}>
Sets the focus to the active media playlist.
Returns
Promise
<{ command
: string
; data
: any
; status
: number
}>
Defined in
mediaPlaylistActiveGet
▸ mediaPlaylistActiveGet(): Promise
<{ command
: string
; data
: any
; status
: number
}>
Returns the identifier of the currently active media playlist.
Returns
Promise
<{ command
: string
; data
: any
; status
: number
}>
The identifier of the currently active media playlist
Defined in
mediaPlaylistActiveMediaIdTrigger
▸ mediaPlaylistActiveMediaIdTrigger(media_id
): Promise
<{ command
: string
; data
: any
; status
: number
}>
Triggers the specified item in the active media playlist.
Parameters
Name | Type |
---|---|
media_id | string |
Returns
Promise
<{ command
: string
; data
: any
; status
: number
}>
Defined in
mediaPlaylistActiveNextTrigger
▸ mediaPlaylistActiveNextTrigger(): Promise
<{ command
: string
; data
: any
; status
: number
}>
Triggers the next item in the active media playlist.
Returns
Promise
<{ command
: string
; data
: any
; status
: number
}>
Defined in
mediaPlaylistActivePreviousTrigger
▸ mediaPlaylistActivePreviousTrigger(): Promise
<{ command
: string
; data
: any
; status
: number
}>
Triggers the previous item in the active media playlist.
Returns
Promise
<{ command
: string
; data
: any
; status
: number
}>
Defined in
mediaPlaylistActiveTrigger
▸ mediaPlaylistActiveTrigger(): Promise
<{ command
: string
; data
: any
; status
: number
}>
Triggers the first item in the active media playlist.
Returns
Promise
<{ command
: string
; data
: any
; status
: number
}>
Defined in
mediaPlaylistByPlaylistIdGet
▸ mediaPlaylistByPlaylistIdGet(playlist_id
): Promise
<{ command
: string
; data
: any
; status
: number
}>
Requests a list of all the media items in the specified media playlist.
Parameters
Name | Type |
---|---|
playlist_id | string |
Returns
Promise
<{ command
: string
; data
: any
; status
: number
}>
A list of all the media items in the specified media playlist.
Defined in
mediaPlaylistByPlaylistIdUpdatesGet
▸ mediaPlaylistByPlaylistIdUpdatesGet(playlist_id
): Promise
<{ command
: string
; data
: any
; status
: number
}>
Requests a chunked data update every time the specified media playlist changes.
Parameters
Name | Type |
---|---|
playlist_id | string |
Returns
Promise
<{ command
: string
; data
: any
; status
: number
}>
A chunked data update every time the specified media playlist changes.
Defined in
mediaPlaylistFocusedGet
▸ mediaPlaylistFocusedGet(): Promise
<{ command
: string
; data
: any
; status
: number
}>
Returns the identifier of the currently focused media playlist
Returns
Promise
<{ command
: string
; data
: any
; status
: number
}>
The identifier of the currently focused media playlist
Defined in
mediaPlaylistFocusedMediaIdTrigger
▸ mediaPlaylistFocusedMediaIdTrigger(media_id
): Promise
<{ command
: string
; data
: any
; status
: number
}>
Triggers the specified item in the focused media playlist.
Parameters
Name | Type |
---|---|
media_id | string |
Returns
Promise
<{ command
: string
; data
: any
; status
: number
}>
Defined in
mediaPlaylistFocusedNextTrigger
▸ mediaPlaylistFocusedNextTrigger(): Promise
<{ command
: string
; data
: any
; status
: number
}>
Triggers the next item in the focused media playlist.
Returns
Promise
<{ command
: string
; data
: any
; status
: number
}>
Defined in
mediaPlaylistFocusedPreviousTrigger
▸ mediaPlaylistFocusedPreviousTrigger(): Promise
<{ command
: string
; data
: any
; status
: number
}>
Triggers the previous item in the focused media playlist.
Returns
Promise
<{ command
: string
; data
: any
; status
: number
}>
Defined in
mediaPlaylistFocusedTrigger
▸ mediaPlaylistFocusedTrigger(): Promise
<{ command
: string
; data
: any
; status
: number
}>
Triggers the first item in the focused media playlist.
Returns
Promise
<{ command
: string
; data
: any
; status
: number
}>
Defined in
mediaPlaylistNextFocus
▸ mediaPlaylistNextFocus(): Promise
<{ command
: string
; data
: any
; status
: number
}>
Sets the focus to the next media playlist.
Returns
Promise
<{ command
: string
; data
: any
; status
: number
}>
Defined in
mediaPlaylistPlaylistIdFocus
▸ mediaPlaylistPlaylistIdFocus(playlist_id
): Promise
<{ command
: string
; data
: any
; status
: number
}>
Sets the focus to the specified media playlist.
Parameters
Name | Type |
---|---|
playlist_id | string |
Returns
Promise
<{ command
: string
; data
: any
; status
: number
}>
Defined in
mediaPlaylistPlaylistIdMediaIdTrigger
▸ mediaPlaylistPlaylistIdMediaIdTrigger(playlist_id
, media_id
): Promise
<{ command
: string
; data
: any
; status
: number
}>
Triggers the previous item in the specified media playlist.
Parameters
Name | Type |
---|---|
playlist_id | string |
media_id | string |
Returns
Promise
<{ command
: string
; data
: any
; status
: number
}>
Defined in
mediaPlaylistPlaylistIdNextTrigger
▸ mediaPlaylistPlaylistIdNextTrigger(playlist_id
): Promise
<{ command
: string
; data
: any
; status
: number
}>
Triggers the next item in the specified media playlist.
Parameters
Name | Type |
---|---|
playlist_id | string |
Returns
Promise
<{ command
: string
; data
: any
; status
: number
}>
Defined in
mediaPlaylistPlaylistIdPreviousTrigger
▸ mediaPlaylistPlaylistIdPreviousTrigger(playlist_id
): Promise
<{ command
: string
; data
: any
; status
: number
}>
Triggers the previous item in the specified media playlist.
Parameters
Name | Type |
---|---|
playlist_id | string |
Returns
Promise
<{ command
: string
; data
: any
; status
: number
}>
Defined in
mediaPlaylistPlaylistIdTrigger
▸ mediaPlaylistPlaylistIdTrigger(playlist_id
): Promise
<{ command
: string
; data
: any
; status
: number
}>
Triggers the first item in the specified media playlist.
Parameters
Name | Type |
---|---|
playlist_id | string |
Returns
Promise
<{ command
: string
; data
: any
; status
: number
}>
Defined in
mediaPlaylistPreviousFocus
▸ mediaPlaylistPreviousFocus(): Promise
<{ command
: string
; data
: any
; status
: number
}>
Sets the focus to the previous media playlist.
Returns
Promise
<{ command
: string
; data
: any
; status
: number
}>
Defined in
mediaPlaylistsGet
▸ mediaPlaylistsGet(): Promise
<{ command
: string
; data
: any
; status
: number
}>
Requests a list of all the configured media playlists.
Returns
Promise
<{ command
: string
; data
: any
; status
: number
}>
A list of all the configured media playlists.
Defined in
messagesGet
▸ messagesGet(): Promise
<{ command
: string
; data
: any
; status
: number
}>
Requests a list of all configured messages.
Returns
Promise
<{ command
: string
; data
: any
; status
: number
}>
A list of all configured messages.
Defined in
messagesIdClear
▸ messagesIdClear(id
): Promise
<{ command
: string
; data
: any
; status
: number
}>
Clears / Hides the specified message.
Parameters
Name | Type |
---|---|
id | string |
Returns
Promise
<{ command
: string
; data
: any
; status
: number
}>
Defined in
messagesIdDelete
▸ messagesIdDelete(id
): Promise
<{ command
: string
; data
: any
; status
: number
}>
Deletes the specified message.
Parameters
Name | Type |
---|---|
id | string |
Returns
Promise
<{ command
: string
; data
: any
; status
: number
}>
Defined in
messagesIdGet
▸ messagesIdGet(id
): Promise
<{ command
: string
; data
: any
; status
: number
}>
Requests the details of the specified message.
Parameters
Name | Type |
---|---|
id | string |
Returns
Promise
<{ command
: string
; data
: any
; status
: number
}>
The details of the specified message.
Defined in
messagesIdSet
▸ messagesIdSet(id
): Promise
<{ command
: string
; data
: any
; status
: number
}>
Sets the details of the specified message.
Parameters
Name | Type |
---|---|
id | string |
Returns
Promise
<{ command
: string
; data
: any
; status
: number
}>
Defined in
playlistActiveAnnouncementFocus
▸ playlistActiveAnnouncementFocus(): Promise
<{ command
: string
; data
: any
; status
: number
}>
Moves the focus to the currently active playlist for the announcement destination.
Returns
Promise
<{ command
: string
; data
: any
; status
: number
}>
Defined in
playlistActiveAnnouncementIndexTrigger
▸ playlistActiveAnnouncementIndexTrigger(index
): Promise
<{ command
: string
; data
: any
; status
: number
}>
Triggers the specified item in the currently active playlist for the announcement destination.
Parameters
Name | Type |
---|---|
index | string |
Returns
Promise
<{ command
: string
; data
: any
; status
: number
}>
Defined in
playlistActiveAnnouncementTrigger
▸ playlistActiveAnnouncementTrigger(): Promise
<{ command
: string
; data
: any
; status
: number
}>
Triggers the first item in the currently active playlist for the announcement destination.
Returns
Promise
<{ command
: string
; data
: any
; status
: number
}>
Defined in
playlistActiveGet
▸ playlistActiveGet(): Promise
<{ command
: string
; data
: any
; status
: number
}>
Requests the details of the active playlist.
Returns
Promise
<{ command
: string
; data
: any
; status
: number
}>
The details of the active playlist.
Defined in
playlistActivePresentationFocus
▸ playlistActivePresentationFocus(): Promise
<{ command
: string
; data
: any
; status
: number
}>
Moves the focus to the currently active playlist for the presentation destination.
Returns
Promise
<{ command
: string
; data
: any
; status
: number
}>
Defined in
playlistActivePresentationIndexTrigger
▸ playlistActivePresentationIndexTrigger(index
): Promise
<{ command
: string
; data
: any
; status
: number
}>
Triggers the specified item in the currently active playlist for the presentation destination.
Parameters
Name | Type |
---|---|
index | string |
Returns
Promise
<{ command
: string
; data
: any
; status
: number
}>
Defined in
playlistActivePresentationTrigger
▸ playlistActivePresentationTrigger(): Promise
<{ command
: string
; data
: any
; status
: number
}>
Triggers the first item in the currently active playlist for the presentation destination.
Returns
Promise
<{ command
: string
; data
: any
; status
: number
}>
Defined in
playlistFocusedGet
▸ playlistFocusedGet(): Promise
<{ command
: string
; data
: any
; status
: number
}>
Requests the details of the currently focused playlist.
Returns
Promise
<{ command
: string
; data
: any
; status
: number
}>
The details of the currently focused playlist.
Defined in
playlistFocusedIndexTrigger
▸ playlistFocusedIndexTrigger(index
): Promise
<{ command
: string
; data
: any
; status
: number
}>
Triggers the specified item in the focused pla