npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2026 – Pkg Stats / Ryan Hefner

renewedvision-propresenter

v7.7.3

Published

RenewedVision ProPresenter API wrapper

Vulnerabilities

Powered byPowered by Snyk
  • 0High
  • 0Medium
  • 0Low

Links

Git

Maintainers

jeffreydavidszjeffreydavidsz

Keywords

renewedvisionpropresenter

Readme

⚠️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

Properties

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 }>

Trigg