manager

Elgato Stream Deck Manager Plugin.

API Overview

API Documentation

Constants

Signature

plugins.core.streamdeck.manager.DEFAULT_GROUP -> string

Type

Constant

Description

The default group.

FILE_NAME

Signature

plugins.core.streamdeck.manager.FILE_NAME -> string

Type

Constant

Description

File name of settings file.

Signature

plugins.core.streamdeck.manager.FOLDER_NAME -> string

Type

Constant

Description

Folder Name where settings file is contained.

Variables

maxItems

Signature

plugins.core.streamdeck.manager.maxItems -> number

Type

Variable

Description

The maximum number of Stream Deck items per group.

Functions

Signature

plugins.core.streamdeck.manager.activeGroup() -> none

Type

Function

Description

Returns the active group.

Parameters

Returns

Signature

plugins.core.streamdeck.manager.appWatcherCallback(name, event, app) -> none

Type

Function

Description

Stream Deck App Watcher Callback

Parameters

Returns

Signature

plugins.core.streamdeck.manager.buttonCallback(object, buttonID, pressed) -> none

Type

Function

Description

Stream Deck Button Callback

Parameters

Returns

clear

Signature

plugins.core.streamdeck.manager.clear() -> none

Type

Function

Description

Clears the Stream Deck items.

Parameters

Returns

Signature

plugins.core.streamdeck.manager.discoveryCallback(connected, object) -> none

Type

Function

Description

Stream Deck Discovery Callback

Parameters

Returns

getAction

Signature

plugins.core.streamdeck.manager.getAction(button, group) -> string

Type

Function

Description

Returns a specific Stream Deck Action.

Parameters

Returns

Signature

plugins.core.streamdeck.manager.getActionHandlerID(button, group) -> string

Type

Function

Description

Returns a specific Stream Deck Action Handler ID.

Parameters

Returns

Signature

plugins.core.streamdeck.manager.getActionTitle(button, group) -> string

Type

Function

Description

Returns a specific Stream Deck Action Title.

Parameters

Returns

getIcon

Signature

plugins.core.streamdeck.manager.getIcon(button, group) -> string

Type

Function

Description

Returns a specific Stream Deck Icon.

Parameters

Returns

getLabel

Signature

plugins.core.streamdeck.manager.getLabel(button, group) -> string

Type

Function

Description

Returns a specific Stream Deck Label.

Parameters

Returns

Signature

plugins.core.streamdeck.manager.groupStatus(groupID, status) -> none

Type

Function

Description

Updates a group's visibility status.

Parameters

Returns

init

Signature

plugins.core.streamdeck.manager.init(deps, env) -> none

Type

Function

Description

Initialises the Stream Deck Plugin

Parameters

Returns

start

Signature

plugins.core.streamdeck.manager.start() -> boolean

Type

Function

Description

Stops the Stream Deck Plugin

Parameters

Returns

update

Signature

plugins.core.streamdeck.manager.update() -> none

Type

Function

Description

Updates the Stream Deck.

Parameters

Returns

Signature

plugins.core.streamdeck.manager.updateAction(button, group, action) -> none

Type

Function

Description

Updates a Stream Deck action.

Parameters

Returns

Signature

plugins.core.streamdeck.manager.updateIcon(button, group, icon) -> none

Type

Function

Description

Updates a Stream Deck icon.

Parameters

Returns

Signature

plugins.core.streamdeck.manager.updateLabel(button, group, label) -> none

Type

Function

Description

Updates a Stream Deck action.

Parameters

Returns

Fields

enabled

Signature

plugins.core.streamdeck.manager.enabled <cp.prop: boolean>

Type

Field

Description

Enable or disable Stream Deck Support.