streamdeck

Last updated 9 months ago

Stream Deck Preferences Panel

API Overview

API Documentation

Variables

Signature

plugins.core.preferences.panels.streamdeck.defaultIconPath -> string

Type

Variable

Description

Default Path where built-in icons are stored

Signature

plugins.core.preferences.panels.streamdeck.supportedExtensions -> string

Type

Variable

Description

Table of supported extensions for Stream Deck Icons.

Functions

Signature

plugins.core.preferences.panels.streamdeck.getGroupEditor(groupId) -> none

Type

Function

Description

Gets the Group Editor

Parameters

Returns

init

Signature

plugins.core.preferences.panels.streamdeck.init(deps, env) -> module

Type

Function

Description

Initialise the Module.

Parameters

Returns

Signature

plugins.core.preferences.panels.streamdeck.setGroupEditor(groupId, editorFn) -> none

Type

Function

Description

Sets the Group Editor

Parameters

Returns

Fields

enabled

Signature

plugins.core.preferences.panels.streamdeck.enabled <cp.prop: boolean>

Type

Field

Description

Enable or disable Stream Deck Support.

lastGroup

Signature

plugins.core.preferences.panels.streamdeck.lastGroup <cp.prop: string>

Type

Field

Description

Last group used in the Preferences Drop Down.