⚠️POST/PUT COMMANDS AREN'T YET FINISHED 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)
// 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.

Constructors

constructor

Properties

ip
port

Methods

Constructors

constructor

• new ProPresenter(ip, port)

Parameters

Name	Type
`ip`	`string`
`port`	`number`

Defined in

propresenter.ts:13

Properties

ip

• ip: string

Defined in

propresenter.ts:10

port

• port: number

Defined in

propresenter.ts:11

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

propresenter.ts:78

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

propresenter.ts:105

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

propresenter.ts:114

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

propresenter.ts:65

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

propresenter.ts:123

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

propresenter.ts:72

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

propresenter.ts:90

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

propresenter.ts:96

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

propresenter.ts:84

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

propresenter.ts:134

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

propresenter.ts:166

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

propresenter.ts:142

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

propresenter.ts:150

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

propresenter.ts:159

audioPlaylistsActiveFocus

▸ audioPlaylistsActiveFocus(): Promise<{ command: string ; data: any ; status: number }>

Focuses the active audio playlist.

Returns

Promise<{ command: string ; data: any ; status: number }>

Defined in

propresenter.ts:184

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

propresenter.ts:262

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

propresenter.ts:245

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

propresenter.ts:205

audioPlaylistsActivePreviousTrigger

▸ audioPlaylistsActivePreviousTrigger(): 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

propresenter.ts:253

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

propresenter.ts:191

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

propresenter.ts:271

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

propresenter.ts:280

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

propresenter.ts:212

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

propresenter.ts:237

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

propresenter.ts:220

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

propresenter.ts:228

audioPlaylistsFocusedTrigger

▸ audioPlaylistsFocusedTrigger(): Promise<{ command: string ; data: any ; status: number }>

Triggers the focused audio playlist.

Returns

Promise<{ command: string ; data: any ; status: number }>

Defined in

propresenter.ts:199

audioPlaylistsNextFocus

▸ audioPlaylistsNextFocus(): Promise<{ command: string ; data: any ; status: number }>

Focuses the next audio playlist.

Returns

Promise<{ command: string ; data: any ; status: number }>

Defined in

propresenter.ts:172

audioPlaylistsPreviousFocus

▸ audioPlaylistsPreviousFocus(): Promise<{ command: string ; data: any ; status: number }>

Focuses the previous audio playlist.

Returns

Promise<{ command: string ; data: any ; status: number }>

Defined in

propresenter.ts:178

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

propresenter.ts:316

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

propresenter.ts:294

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

propresenter.ts:308

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

propresenter.ts:301

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

propresenter.ts:407

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

propresenter.ts:360

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

propresenter.ts:394

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

propresenter.ts:343

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

propresenter.ts:370

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

propresenter.ts:387

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

propresenter.ts:326

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

propresenter.ts:351

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

propresenter.ts:378

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

propresenter.ts:865

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

propresenter.ts:25

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

propresenter.ts:443

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

propresenter.ts:486

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

propresenter.ts:472

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

propresenter.ts:455

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

propresenter.ts:463

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

propresenter.ts:545

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

propresenter.ts:503

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

propresenter.ts:516

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

propresenter.ts:531

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

propresenter.ts:552

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

propresenter.ts:523

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

propresenter.ts:538

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

propresenter.ts:563

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

propresenter.ts:585

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

propresenter.ts:571

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

propresenter.ts:578

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

propresenter.ts:594

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

propresenter.ts:604

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

propresenter.ts:612

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

propresenter.ts:620

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

propresenter.ts:656

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

propresenter.ts:688

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

propresenter.ts:670

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

propresenter.ts:766

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

propresenter.ts:749

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

propresenter.ts:757

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

propresenter.ts:709

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

propresenter.ts:638

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

propresenter.ts:646

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

propresenter.ts:663

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

propresenter.ts:741

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

propresenter.ts:724

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

propresenter.ts:732

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

propresenter.ts:703

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

propresenter.ts:676

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

propresenter.ts:695

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

propresenter.ts:794

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

propresenter.ts:775

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

propresenter.ts:784

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

propresenter.ts:716

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

propresenter.ts:682

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

propresenter.ts:630

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

propresenter.ts:808

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

propresenter.ts:855

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

propresenter.ts:837

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

propresenter.ts:823

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

propresenter.ts:830

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

propresenter.ts:946

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

propresenter.ts:1059

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

propresenter.ts:968

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

propresenter.ts:913

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

propresenter.ts:938

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

propresenter.ts:1050

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

propresenter.ts:960

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

propresenter.ts:920

playlistFocusedIndexTrigger

▸ playlistFocusedIndexTrigger(index): Promise<{ command: string ; data: any ; status: number }>

Triggers the specified item in the focused playlist.

Parameters

Name	Type
`index`	`string`

Returns

Promise<{ command: string ; data: any ; status: number }>

Defined in

propresenter.ts:1041

playlistFocusedNextTrigger

▸ playlistFocusedNextTrigger(): Promise<{ command: string ; data: any ; status: number }>

Triggers the next item in the currently focused playlist.

Returns

Promise<{ command: string ; data: any ; status: number }>

Defined in

propresenter.ts:976

playlistFocusedPreviousTrigger

▸ playlistFocusedPreviousTrigger(): Promise<{ command: string ; data: any ; status: number }>

Triggers the previous item in the currently focused playlist.

Returns

Promise<{ command: string ; data: any ; status: number }>

Defined in

propresenter.ts:982

playlistFocusedTrigger

▸ playlistFocusedTrigger(): Promise<{ command: string ; data: any ; status: number }>

Triggers the first item in the currently focused playlist.

Returns

Promise<{ command: string ; data: any ; status: number }>

Defined in

propresenter.ts:954

playlistIdentifierFocus

▸ playlistIdentifierFocus(identifier): Promise<{ command: string ; data: any ; status: number }>

Moves the focus to the specified playlist.

Parameters

Name	Type
`identifier`	`string`

Returns

Promise<{ command: string ; data: any ; status: number }>

Defined in

propresenter.ts:999

playlistIdentifierIndexTrigger

▸ playlistIdentifierIndexTrigger(identifier, index): Promise<{ command: string ; data: any ; status: number }>

Triggers the specified item in the specified playlist.

Parameters

Name	Type
`identifier`	`string`
`index`	`string`

Returns

Promise<{ command: string ; data: any ; status: number }>

Defined in

propresenter.ts:1032

playlistIdentifierNextTrigger

▸ playlistIdentifierNextTrigger(identifier): Promise<{ command: string ; data: any ; status: number }>

Triggers the next item in the specified playlist.

Parameters

Name	Type
`identifier`	`string`

Returns

Promise<{ command: string ; data: any ; status: number }>

Defined in

propresenter.ts:1013

playlistIdentifierPreviousTrigger

▸ playlistIdentifierPreviousTrigger(identifier): Promise<{ command: string ; data: any ; status: number }>

Triggers the previous item in the specified playlist.

Parameters

Name	Type
`identifier`	`string`

Returns

Promise<{ command: string ; data: any ; status: number }>

Defined in

propresenter.ts:1022

playlistIdentifierTrigger

▸ playlistIdentifierTrigger(identifier): Promise<{ command: string ; data: any ; status: number }>

Triggers the first item in the specified playlist.

Parameters

Name	Type
`identifier`	`string`

Returns

Promise<{ command: string ; data: any ; status: number }>

Defined in

propresenter.ts:1006

playlistIdentifierUpdates

▸ playlistIdentifierUpdates(identifier): Promise<{ command: string ; data: any ; status: number }>

Requests a chunked data update every time the specified audio playlist changes.

Parameters

Name	Type
`identifier`	`string`

Returns

Promise<{ command: string ; data: any ; status: number }>

A chunked data update every time the specified audio playlist changes.

Defined in

propresenter.ts:992

playlistNextFocus

▸ playlistNextFocus(): Promise<{ command: string ; data: any ; status: number }>

Moves the focus to the next playlist.

Returns

Promise<{ command: string ; data: any ; status: number }>

Defined in

propresenter.ts:926

playlistPlaylistIdGet

▸ playlistPlaylistIdGet(playlist_id): Promise<{ command: string ; data: any ; status: number }>

Requests a list of the items in the specified playlist.

Parameters

Name	Type
`playlist_id`	`string`

Returns

Promise<{ command: string ; data: any ; status: number }>

Alist of the items in the specified playlist.

Defined in

propresenter.ts:890

playlistPlaylistIdSet

▸ playlistPlaylistIdSet(playlist_id): Promise<{ command: string ; data: any ; status: number }>

Sets the contents of the specified playlist.

Parameters

Name	Type
`playlist_id`	`string`

Returns

Promise<{ command: string ; data: any ; status: number }>

Defined in

propresenter.ts:896

playlistPreviousFocus

▸ playlistPreviousFocus(): Promise<{ command: string ; data: any ; status: number }>

Moves the focus to the previous playlist.

Returns

Promise<{ command: string ; data: any ; status: number }>

Defined in

propresenter.ts:932

playlistsGet

▸ playlistsGet(): Promise<{ command: string ; data: any ; status: number }>

Requests a list of all configured playlists.

Returns

Promise<{ command: string ; data: any ; status: number }>

A list of all configured playlists.

Defined in

propresenter.ts:877

presentationActiveFocus

▸ presentationActiveFocus(): Promise<{ command: string ; data: any ; status: number }>

Sets the focus to the active presentation.

Returns

Promise<{ command: string ; data: any ; status: number }>

Defined in

propresenter.ts:1183

presentationActiveGet

▸ presentationActiveGet(): Promise<{ command: string ; data: any ; status: number }>

Requests the details of the currently active presentation.

Returns

Promise<{ command: string ; data: any ; status: number }>

The details of the currently active presentation.

Defined in

propresenter.ts:1072

presentationActiveGroupGroup_IdTrigger

▸ presentationActiveGroupGroup_IdTrigger(group_id): Promise<{ command: string ; data: any ; status: number }>

Triggers the specified group of the active presentation.

Parameters

Name	Type
`group_id`	`string`

Returns

Promise<{ command: string ; data: any ; status: number }>

Defined in

propresenter.ts:1298

presentationActiveIndexTrigger

▸ presentationActiveIndexTrigger(index): Promise<{ command: string ; data: any ; status: number }>

Triggers the specified cue of the active presentation.

Parameters

Name	Type
`index`	`string`

Returns

Promise<{ command: string ; data: any ; status: number }>

Defined in

propresenter.ts:1248

presentationActiveNextTrigger

▸ presentationActiveNextTrigger(): Promise<{ command: string ; data: any ; status: number }>

Triggers the next cue of the active presentation.

Returns

Promise<{ command: string ; data: any ; status: number }>

Defined in

propresenter.ts:1233

presentationActivePreviousTrigger

▸ presentationActivePreviousTrigger(): Promise<{ command: string ; data: any ; status: number }>

Triggers the previous cue of the active presentation.

Returns

Promise<{ command: string ; data: any ; status: number }>

Defined in

propresenter.ts:1239

presentationActiveTimeline

▸ presentationActiveTimeline(): Promise<{ command: string ; data: any ; status: number }>

Requests the current state of the active presentation timeline.

Returns

Promise<{ command: string ; data: any ; status: number }>

The current state of the active presentation timeline.

Defined in

propresenter.ts:1115

presentationActiveTimelineOperation

▸ presentationActiveTimelineOperation(operation): Promise<{ command: string ; data: any ; status: number }>

Performs the requested timeline operation for the currently active presentation (play, pause, rewind).

Parameters

Name	Type	Description
`operation`	`"pause"` \| `"play"` \| `"rewind"`	(play, pause, rewind)

Returns

Promise<{ command: string ; data: any ; status: number }>

Defined in

propresenter.ts:1129

presentationActiveTrigger

▸ presentationActiveTrigger(): Promise<{ command: string ; data: any ; status: number }>

Retriggers the active presentation from the start.

Returns

Promise<{ command: string ; data: any ; status: number }>

Defined in

propresenter.ts:1227

presentationChordChartGet

▸ presentationChordChartGet(): Promise<{ command: string ; data: any ; status: number }>

Requests the current chord chart image (if available) at the given quality value.

Returns

Promise<{ command: string ; data: any ; status: number }>

The current chord chart image (if available) at the given quality value.

Defined in

propresenter.ts:1093

presentationChordChartUpdates

▸ presentationChordChartUpdates(): Promise<{ command: string ; data: any ; status: number }>

Requests a chunked data update every time the chord chart changes.

Returns

Promise<{ command: string ; data: any ; status: number }>

A chunked data update every time the chord chart changes.

Defined in

propresenter.ts:1100

presentationFocusedGet

▸ presentationFocusedGet(): Promise<{ command: string ; data: any ; status: number }>

Gets the currently focused presentation.

Returns

Promise<{ command: string ; data: any ; status: number }>

The currently focused presentation.

Defined in

propresenter.ts:1079

presentationFocusedGroupGroup_IdTrigger

▸ presentationFocusedGroupGroup_IdTrigger(group_id): Promise<{ command: string ; data: any ; status: number }>

Triggers the specified group of the focused presentation.

Parameters

Name	Type
`group_id`	`string`

Returns

Promise<{ command: string ; data: any ; status: number }>

Defined in

propresenter.ts:1289

presentationFocusedIndexTrigger

▸ presentationFocusedIndexTrigger(index): Promise<{ command: string ; data: any ; status: number }>

Triggers the specified cue of the focused presentation.

Parameters

Name	Type
`index`	`string`

Returns

Promise<{ command: string ; data: any ; status: number }>

Defined in

propresenter.ts:1219

presentationFocusedNextTrigger

▸ presentationFocusedNextTrigger(): Promise<{ command: string ; data: any ; status: number }>

Triggers the next cue of the focused presentation.

Returns

Promise<{ command: string ; data: any ; status: number }>

Defined in

propresenter.ts:1202

presentationFocusedPreviousTrigger

▸ presentationFocusedPreviousTrigger(): Promise<{ command: string ; data: any ; status: number }>

Triggers the previous cue of the focused presentation.

Returns

Promise<{ command: string ; data: any ; status: number }>

Defined in

propresenter.ts:1210

presentationFocusedTimeline

▸ presentationFocusedTimeline(): Promise<{ command: string ; data: any ; status: number }>

Requests the current state of the focused presentation timeline.

Returns

Promise<{ command: string ; data: any ; status: number }>

The current state of the focused presentation timeline.

Defined in

propresenter.ts:1122

presentationFocusedTimelineOperation

▸ presentationFocusedTimelineOperation(operation): Promise<{ command: string ; data: any ; status: number }>

Performs the requested timeline operation for the currently focused presentation (play, pause, rewind).

Parameters

Name	Type	Description
`operation`	`"pause"` \| `"play"` \| `"rewind"`	(play, pause, rewind)

Returns

Promise<{ command: string ; data: any ; status: number }>

Defined in

propresenter.ts:1138

presentationFocusedTrigger

▸ presentationFocusedTrigger(): Promise<{ command: string ; data: any ; status: number }>

Triggers the focused presentation.

Returns

Promise<{ command: string ; data: any ; status: number }>

Defined in

propresenter.ts:1196

presentationNextFocus

▸ presentationNextFocus(): Promise<{ command: string ; data: any ; status: number }>

Sets the focus to the next presentation.

Returns

Promise<{ command: string ; data: any ; status: number }>

Defined in

propresenter.ts:1171

presentationPreviousFocus

▸ presentationPreviousFocus(): Promise<{ command: string ; data: any ; status: number }>

Sets the focus to the previous presentation.

Returns

Promise<{ command: string ; data: any ; status: number }>

Defined in

propresenter.ts:1177

presentationSlideIndexGet

▸ presentationSlideIndexGet(): Promise<{ command: string ; data: any ; status: number }>

Requests the index of the current slide/cue within the currently active presentation.

Returns

Promise<{ command: string ; data: any ; status: number }>

The index of the current slide/cue within the currently active presentation.

Defined in

propresenter.ts:1086

presentationUUIDFocus

▸ presentationUUIDFocus(uuid): Promise<{ command: string ; data: any ; status: number }>

Sets the focus to the specified presentation.

Parameters

Name	Type
`uuid`	`string`

Returns

Promise<{ command: string ; data: any ; status: number }>

Defined in

propresenter.ts:1190

presentationUUIDFocusedTimelineOperation

▸ presentationUUIDFocusedTimelineOperation(uuid, operation): Promise<{ command: string ; data: any ; status: number }>

Performs the requested timeline operation for the specified presentation (play, pause, rewind).

Parameters

Name	Type	Description
`uuid`	`string`
`operation`	`"pause"` \| `"play"` \| `"rewind"`	(play, pause, rewind)

Returns

Promise<{ command: string ; data: any ; status: number }>

Defined in

propresenter.ts:1148

presentationUUIDGet

▸ presentationUUIDGet(uuid): Promise<{ command: string ; data: any ; status: number }>

Requests the details of the specified presentation.

Parameters

Name	Type
`uuid`	`string`

Returns

Promise<{ command: string ; data: any ; status: number }>

The details of the specified presentation.

Defined in

propresenter.ts:1108

presentationUUIDGroupGroup_IdTrigger

▸ presentationUUIDGroupGroup_IdTrigger(uuid, group_id): Promise<{ command: string ; data: any ; status: number }>

Triggers the specified group of the specified presentation.

Parameters

Name	Type
`uuid`	`string`
`group_id`	`string`

Returns

Promise<{ command: string ; data: any ; status: number }>

Defined in

propresenter.ts:1308

presentationUUIDIndexTrigger

▸ presentationUUIDIndexTrigger(uuid, index): Promise<{ command: string ; data: any ; status: number }>

Triggers the specified cue of the specified presentation.

Parameters

Name	Type
`uuid`	`string`
`index`	`string`

Returns

Promise<{ command: string ; data: any ; status: number }>

Defined in

propresenter.ts:1280

presentationUUIDNextTrigger

▸ presentationUUIDNextTrigger(uuid): Promise<{ command: string ; data: any ; status: number }>

Triggers the next cue of the specified presentation.

Parameters

Name	Type
`uuid`	`string`

Returns

Promise<{ command: string ; data: any ; status: number }>

Defined in

propresenter.ts:1263

presentationUUIDPreviousTrigger

▸ presentationUUIDPreviousTrigger(uuid): Promise<{ command: string ; data: any ; status: number }>

Triggers the previous cue of the specified presentation.

Parameters

Name	Type
`uuid`	`string`

Returns

Promise<{ command: string ; data: any ; status: number }>

Defined in

propresenter.ts:1271

presentationUUIDThumbnailIndex

▸ 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.

Parameters

Name	Type
`uuid`	`string`
`index`	`string`

Returns

Promise<{ command: string ; data: any ; status: number }>

Defined in

propresenter.ts:1162

presentationUUIDTrigger

▸ presentationUUIDTrigger(uuid): Promise<{ command: string ; data: any ; status: number }>

Triggers the specified presentation.

Parameters

Name	Type
`uuid`	`string`

Returns

Promise<{ command: string ; data: any ; status: number }>

Defined in

propresenter.ts:1257

propGet

▸ propGet(): Promise<{ command: string ; data: any ; status: number }>

Gets a list of all the props.

Returns

Promise<{ command: string ; data: any ; status: number }>

A list of all the props.

Defined in

propresenter.ts:1322

propId

▸ propId(id): Promise<{ command: string ; data: any ; status: number }>

Requests the details of the specified prop.

Parameters

Name	Type
`id`	`string`

Returns

Promise<{ command: string ; data: any ; status: number }>

The details of the specified prop.

Defined in

propresenter.ts:1330

propIdClear

▸ propIdClear(id): Promise<{ command: string ; data: any ; status: number }>

Clears the specified prop.

Parameters

Name	Type
`id`	`string`

Returns

Promise<{ command: string ; data: any ; status: number }>

Defined in

propresenter.ts:1353

propIdDelete

▸ propIdDelete(id): Promise<{ command: string ; data: any ; status: number }>

Deletes the specified prop.

Parameters

Name	Type
`id`	`string`

Returns

Promise<{ command: string ; data: any ; status: number }>

Defined in

propresenter.ts:1338

propIdThumbnail

▸ propIdThumbnail(id): Promise<{ command: string ; data: any ; status: number }>

Requests a thumbnail image of the specified prop at the given quality value.

Parameters

Name	Type
`id`	`string`

Returns

Promise<{ command: string ; data: any ; status: number }>

A thumbnail image of the specified prop at the given quality value.

Defined in

propresenter.ts:1361

propIdTrigger

▸ propIdTrigger(id): Promise<{ command: string ; data: any ; status: number }>

Triggers the specified prop.

Parameters

Name	Type
`id`	`string`

Returns

Promise<{ command: string ; data: any ; status: number }>

Defined in

propresenter.ts:1346

stageLayoutIdDelete

▸ stageLayoutIdDelete(id): Promise<{ command: string ; data: any ; status: number }>

Deletes the specified stage layout.

Parameters

Name	Type
`id`	`string`

Returns

Promise<{ command: string ; data: any ; status: number }>

Defined in

propresenter.ts:1442

stageLayoutIdThumbnail

▸ stageLayoutIdThumbnail(id): Promise<{ command: string ; data: any ; status: number }>

Requests a thumbnail image of the specified stage layout at the given quality value.

Parameters

Name	Type
`id`	`string`

Returns

Promise<{ command: string ; data: any ; status: number }>

A thumbnail image of the specified stage layout at the given quality value.

Defined in

propresenter.ts:1451

stageLayoutMap

▸ stageLayoutMap(): Promise<{ command: string ; data: any ; status: number }>

Requests the currently selected stage layout for each configured stage screen.

Returns

Promise<{ command: string ; data: any ; status: number }>

The currently selected stage layout for each configured stage screen.

Defined in

propresenter.ts:1394

stageLayoutMapSet

▸ stageLayoutMapSet(): Promise<{ command: string ; data: any ; status: number }>

Sets the specified stage message to the corresponding stage screens. NOT READY

Returns

Promise<{ command: string ; data: any ; status: number }>

Defined in

propresenter.ts:1401

stageLayoutsGet

▸ stageLayoutsGet(): Promise<{ command: string ; data: any ; status: number }>

Requests a list of the configured stage layouts.

Returns

Promise<{ command: string ; data: any ; status: number }>

A list of the configured stage layouts.

Defined in

propresenter.ts:1436

stageMessage

▸ stageMessage(): Promise<{ command: string ; data: any ; status: number }>

Shows the specified stage message on the configured stage screen.

Returns

Promise<{ command: string ; data: any ; status: number }>

Defined in

propresenter.ts:1379

stageMessageGet

▸ stageMessageGet(): Promise<{ command: string ; data: any ; status: number }>

Requests the currently active stage message.

Returns

Promise<{ command: string ; data: any ; status: number }>

The currently active stage message.

Defined in

propresenter.ts:1373

stageMessageHide

▸ stageMessageHide(): Promise<{ command: string ; data: any ; status: number }>

Hides the currently displayed stage message from the configured stage screen.

Returns

Promise<{ command: string ; data: any ; status: number }>

Defined in

propresenter.ts:1385

stageScreenIdLayout

▸ stageScreenIdLayout(id): Promise<{ command: string ; data: any ; status: number }>

Requests the current stage layout for the specified stage screen.

Parameters

Name	Type
`id`	`string`

Returns

Promise<{ command: string ; data: any ; status: number }>

The current stage layout for the specified stage screen.

Defined in

propresenter.ts:1418

stageScreenIdLayoutId

▸ stageScreenIdLayoutId(id, layout_id): Promise<{ command: string ; data: any ; status: number }>

Sets the specified stage layout for the specified stage screen.

Parameters

Name	Type
`id`	`string`
`layout_id`	`string`

Returns

Promise<{ command: string ; data: any ; status: number }>

Defined in

propresenter.ts:1426

stageScreensGet

▸ stageScreensGet(): Promise<{ command: string ; data: any ; status: number }>

Requests a list of the configured stage screens.

Returns

Promise<{ command: string ; data: any ; status: number }>

A list of the configured stage screens.

Defined in

propresenter.ts:1410

statusAudienceScreens

▸ statusAudienceScreens(): Promise<{ command: string ; data: any ; status: number }>

Requests the status of the audience screens.

Returns

Promise<{ command: string ; data: any ; status: number }>

The status of the audience screens.

Defined in

propresenter.ts:1494

statusAudienceScreensSet

▸ statusAudienceScreensSet(): Promise<{ command: string ; data: any ; status: number }>

Sets the status of the audience screens. NOT READY

Returns

Promise<{ command: string ; data: any ; status: number }>

Defined in

propresenter.ts:1501

statusLayers

▸ statusLayers(): Promise<{ command: string ; data: any ; status: number }>

Requests the status of all available layers.

Returns

Promise<{ command: string ; data: any ; status: number }>

The status of all available layers.

Defined in

propresenter.ts:1471

statusScreens

▸ statusScreens(): Promise<{ command: string ; data: any ; status: number }>

Requests the details of all configured screens.

Returns

Promise<{ command: string ; data: any ; status: number }>

The details of all configured screens.

Defined in

propresenter.ts:1510

statusSlide

▸ statusSlide(): Promise<{ command: string ; data: any ; status: number }>

Requests the current/next slide text and image UUIDs.

Returns

Promise<{ command: string ; data: any ; status: number }>

The Requests the current/next slide text and image UUIDs.

Defined in

propresenter.ts:1517

statusStageScreens

▸ statusStageScreens(): Promise<{ command: string ; data: any ; status: number }>

Requests the status of the stage screens.

Returns

Promise<{ command: string ; data: any ; status: number }>

The status of the stage screens.

Defined in

propresenter.ts:1478

statusStageScreensSet

▸ statusStageScreensSet(): Promise<{ command: string ; data: any ; status: number }>

Sets the status of the stage screens. NOT READY

Returns

Promise<{ command: string ; data: any ; status: number }>

Defined in

propresenter.ts:1485

statusUpdate

▸ statusUpdate(): Promise<{ command: string ; data: any ; status: number }>

Aggregates the data from one or more streaming endpoints into a single streaming endpoint. NOT READY

Returns

Promise<{ command: string ; data: any ; status: number }>

Defined in

propresenter.ts:1524

themesGet

▸ themesGet(): Promise<{ command: string ; data: any ; status: number }>

Requests a list of all configured themes and theme slides.

Returns

Promise<{ command: string ; data: any ; status: number }>

A list of all configured themes and theme slides.

Defined in

propresenter.ts:1538

themesIdGet

▸ themesIdGet(id): Promise<{ command: string ; data: any ; status: number }>

Requests the details of the theme and theme slides.

Parameters

Name	Type
`id`	`string`

Returns

Promise<{ command: string ; data: any ; status: number }>

The details of the theme and theme slides.

Defined in

propresenter.ts:1546

themesIdSlidesThemeSlide

▸ themesIdSlidesThemeSlide(id, theme_slide): Promise<{ command: string ; data: any ; status: number }>

Requests the details of the specified theme slide within the specified theme.

Parameters

Name	Type
`id`	`string`
`theme_slide`	`string`

Returns

Promise<{ command: string ; data: any ; status: number }>

The details of the specified theme slide within the specified theme.

Defined in

propresenter.ts:1555

themesIdSlidesThemeSlideSet

▸ themesIdSlidesThemeSlideSet(id, theme_slide): Promise<{ command: string ; data: any ; status: number }>

Sets the details of the specified theme slide within the specified theme.

Parameters

Name	Type	Description
`id`	`string`
`theme_slide`	`string`	NOT READY

Returns

Promise<{ command: string ; data: any ; status: number }>

Defined in

propresenter.ts:1566

themesIdSlidesThemeSlideThumbnail

▸ 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.

Parameters

Name	Type
`id`	`string`
`theme_slide`	`string`

Returns

Promise<{ command: string ; data: any ; status: number }>

The details of the specified theme slide within the specified theme.

Defined in

propresenter.ts:1578

timerCreate

▸ timerCreate(): Promise<{ command: string ; data: any ; status: number }>

Creates a new timer with the specified details.

Returns

Promise<{ command: string ; data: any ; status: number }>

Defined in

propresenter.ts:1600

timerIdDelete

▸ timerIdDelete(id): Promise<{ command: string ; data: any ; status: number }>

Deletes the specified timer.

Parameters

Name	Type
`id`	`string`

Returns

Promise<{ command: string ; data: any ; status: number }>

Defined in

propresenter.ts:1637

timerIdGet

▸ timerIdGet(id): Promise<{ command: string ; data: any ; status: number }>

Requests the details of the specified timer.

Parameters

Name	Type
`id`	`string`

Returns

Promise<{ command: string ; data: any ; status: number }>

The details of the specified timer.

Defined in

propresenter.ts:1622

timerIdOperation

▸ timerIdOperation(id, operation): Promise<{ command: string ; data: any ; status: number }>

Performs the requested operation on the specified timer.

Parameters

Name	Type	Description
`id`	`string`
`operation`	`"stop"` \| `"start"` \| `"reset"`	(start, stop, reset)

Returns

Promise<{ command: string ; data: any ; status: number }>

Defined in

propresenter.ts:1647

timerIdSet

▸ timerIdSet(id): Promise<{ command: string ; data: any ; status: number }>

Sets the details of the specified timer.

Parameters

Name	Type	Description
`id`	`string`	NOT READY

Returns

Promise<{ command: string ; data: any ; status: number }>

Defined in

propresenter.ts:1630

timerSystemTime

▸ timerSystemTime(): Promise<{ command: string ; data: any ; status: number }>

Requests the current system time.

Returns

Promise<{ command: string ; data: any ; status: number }>

The current system time.

Defined in

propresenter.ts:1655

timerVideoCountdown

▸ timerVideoCountdown(): Promise<{ command: string ; data: any ; status: number }>

Requests the current value of the video countdown timer.

Returns

Promise<{ command: string ; data: any ; status: number }>

The current value of the video countdown timer.

Defined in

propresenter.ts:1662

timersCurrent

▸ timersCurrent(): Promise<{ command: string ; data: any ; status: number }>

Requests the current time for all configured timers.

Returns

Promise<{ command: string ; data: any ; status: number }>

The current time for all configured timers.

Defined in

propresenter.ts:1607

timersGet

▸ timersGet(): Promise<{ command: string ; data: any ; status: number }>

Requests the details for all configured timers.

Returns

Promise<{ command: string ; data: any ; status: number }>

The details for all configured timers.

Defined in

propresenter.ts:1592

timersOperation

▸ timersOperation(operation): Promise<{ command: string ; data: any ; status: number }>

Performs the requested operation for all configured timers.

Parameters

Name	Type	Description
`operation`	`"stop"` \| `"start"` \| `"reset"`	(start, stop, reset)

Returns

Promise<{ command: string ; data: any ; status: number }>

Defined in

propresenter.ts:1614

transportLayerAutoAdvance

▸ transportLayerAutoAdvance(layer): Promise<{ command: string ; data: any ; status: number }>

Requests the auto-advance status for the specified layer.

Parameters

Name	Type	Description
`layer`	`"presentation"` \| `"announcement"`	(presentation, announcement).

Returns

Promise<{ command: string ; data: any ; status: number }>

The auto-advance status for the specified layer.

Defined in

propresenter.ts:1741

transportLayerAutoAdvanceDelete

▸ transportLayerAutoAdvanceDelete(layer): Promise<{ command: string ; data: any ; status: number }>

Cancels the auto-advance for the specified layer.

Parameters

Name	Type	Description
`layer`	`"presentation"` \| `"announcement"`	(presentation, announcement).

Returns

Promise<{ command: string ; data: any ; status: number }>

Defined in

propresenter.ts:1748

transportLayerCurrent

▸ transportLayerCurrent(layer): Promise<{ command: string ; data: any ; status: number }>

Requests the details of the currently playing content for the specified layer

Parameters

Name	Type	Description
`layer`	`"presentation"` \| `"announcement"`	(presentation, announcement).

Returns

Promise<{ command: string ; data: any ; status: number }>

The details of the currently playing content for the specified layer

Defined in

propresenter.ts:1758

transportLayerGoToEnd

▸ transportLayerGoToEnd(layer): Promise<{ command: string ; data: any ; status: number }>

Moves to the end on a certain layer

Parameters

Name	Type	Description
`layer`	`"audio"` \| `"presentation"` \| `"announcement"`	(presentation, announcement, audio)

Returns

Promise<{ command: string ; data: any ; status: number }>

Defined in

propresenter.ts:1714

transportLayerPause

▸ transportLayerPause(layer): Promise<{ command: string ; data: any ; status: number }>

Pauses the content on the specified layer.

Parameters

Name	Type	Description
`layer`	`"audio"` \| `"presentation"` \| `"announcement"`	(presentation, announcement, audio)

Returns

Promise<{ command: string ; data: any ; status: number }>

Defined in

propresenter.ts:1681

transportLayerPlay

▸ transportLayerPlay(layer): Promise<{ command: string ; data: any ; status: number }>

Plays the content on the specified layer.

Parameters

Name	Type	Description
`layer`	`"audio"` \| `"presentation"` \| `"announcement"`	(presentation, announcement, audio)

Returns

Promise<{ command: string ; data: any ; status: number }>

Defined in

propresenter.ts:1674

transportLayerSkipBackwardTime

▸ 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.

Parameters

Name	Type	Description
`layer`	`"audio"` \| `"presentation"` \| `"announcement"`	(presentation, announcement, audio)
`time`	`number`	in seconds

Returns

Promise<{ command: string ; data: any ; status: number }>

Defined in

propresenter.ts:1689

transportLayerSkipForwardTime

▸ 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.

Parameters

Name	Type	Description
`layer`	`"audio"` \| `"presentation"` \| `"announcement"`	(presentation, announcement, audio)
`time`	`number`	in seconds

Returns

Promise<{ command: string ; data: any ; status: number }>

Defined in

propresenter.ts:1702

transportLayerTime

▸ transportLayerTime(layer): Promise<{ command: string ; data: any ; status: number }>

Requests the current transport time for the specified layer.

Parameters

Name	Type	Description
`layer`	`"audio"` \| `"presentation"` \| `"announcement"`	(presentation, announcement, audio)

Returns

Promise<{ command: string ; data: any ; status: number }>

The current transport time for the specified layer.

Defined in

propresenter.ts:1722

transportLayerTimeSet

▸ transportLayerTimeSet(layer): Promise<{ command: string ; data: any ; status: number }>

Moves to the specified time for the specified layer

Parameters

Name	Type	Description
`layer`	`"audio"` \| `"presentation"` \| `"announcement"`	(presentation, announcement, audio)

Returns

Promise<{ command: string ; data: any ; status: number }>

Defined in

propresenter.ts:1731

triggerAudioNext

▸ triggerAudioNext(): Promise<{ command: string ; data: any ; status: number }>

Triggers the next item in the currently active media playlist.

Returns

Promise<{ command: string ; data: any ; status: number }>

Defined in

propresenter.ts:1781

triggerAudioPrevious

▸ triggerAudioPrevious(): Promise<{ command: string ; data: any ; status: number }>

Triggers the previous item in the currently active audio playlist.

Returns

Promise<{ command: string ; data: any ; status: number }>

Defined in

propresenter.ts:1787

triggerMediaNext

▸ triggerMediaNext(): Promise<{ command: string ; data: any ; status: number }>

Triggers the next item in the currently active media playlist.

Returns

Promise<{ command: string ; data: any ; status: number }>

Defined in

propresenter.ts:1769

triggerMediaPrevious

▸ triggerMediaPrevious(): Promise<{ command: string ; data: any ; status: number }>

Triggers the previous item in the currently active media playlist.

Returns

Promise<{ command: string ; data: any ; status: number }>

Defined in

propresenter.ts:1775

triggerNext

▸ triggerNext(): Promise<{ command: string ; data: any ; status: number }>

Triggers the next cue or item in the currently active playlist or library.

Returns

Promise<{ command: string ; data: any ; status: number }>

Defined in

propresenter.ts:1793

triggerPrevious

▸ triggerPrevious(): Promise<{ command: string ; data: any ; status: number }>

Triggers the previous cue or item in the currently active playlist or library.

Returns

Promise<{ command: string ; data: any ; status: number }>

Defined in

propresenter.ts:1799

version

▸ version(): Promise<{ command: string ; data: any ; status: number }>

Requests the general information about the currently active ProPresenter instance

Returns

Promise<{ command: string ; data: any ; status: number }>

General information about the currently active ProPresenter instance

Defined in

propresenter.ts:1463

videoInputs

▸ videoInputs(): Promise<{ command: string ; data: any ; status: number }>

Requests the contents of the video inputs playlist.

Returns

Promise<{ command: string ; data: any ; status: number }>

The contents of the video inputs playlist.

Defined in

propresenter.ts:1810

videoInputsIdTrigger

▸ videoInputsIdTrigger(id): Promise<{ command: string ; data: any ; status: number }>

Triggers a video input from the video inputs playlist.

Parameters

Name	Type
`id`	`string`

Returns

Promise<{ command: string ; data: any ; status: number }>

Defined in

propresenter.ts:1817

Name		Name	Last commit message	Last commit date
Latest commit History 72 Commits
src		src
.gitignore		.gitignore
.prettierignore		.prettierignore
LICENSE		LICENSE
README.md		README.md
package.json		package.json
tsconfig.json		tsconfig.json
yarn.lock		yarn.lock

License

greyshirtguy/node-renewedvision-propresenter-api

Folders and files

Latest commit

History

Repository files navigation

⚠️POST/PUT COMMANDS AREN'T YET FINISHED AT THIS POINT⚠️

RenewedVision ProPresenter API wrapper

Installation

Usage

Constructors

Properties

Methods

Constructors

constructor

Parameters

Defined in

Properties

ip

Defined in

port

Defined in

Methods

announcementActiveFocus

Returns

Defined in

announcementActiveIndexTrigger

Parameters

Returns

Defined in

announcementActiveTimelineOperation

Parameters

Returns

Defined in

announcementGetActive

Returns

Defined in

announcementGetActiveTimelineOperation

Returns

Defined in

announcementGetSlideIndex

Returns

Defined in

announcementNextTrigger

Returns

Defined in

announcementPreviousTrigger

Returns

Defined in

announcementTrigger

Returns

Defined in

audioGetPlaylists

Returns

Defined in

audioGetPlaylistsActive

Returns

Defined in

audioGetPlaylistsByPlaylistId

Parameters

Returns

Defined in

audioGetPlaylistsByPlaylistIdUpdates

Parameters

Returns

Defined in

audioGetPlaylistsFocused

Returns

Defined in

audioPlaylistsActiveFocus

Returns

Defined in

audioPlaylistsActiveIdTrigger

Parameters

Returns

Defined in

audioPlaylistsActiveNextTrigger

Returns

Defined in

audioPlaylistsActiveTrigger