plugins.core.preferences.panels.streamdeck.md

docs » plugins.core.preferences.panels.streamdeck

---

Stream Deck Preferences Panel

API Overview

• Variables - Configurable values
• defaultIconPath
• supportedExtensions
• Functions - API calls offered directly by the extension
• getGroupEditor
• init
• setGroupEditor
• Fields - Variables which can only be accessed from an object returned by a constructor
• enabled
• lastGroup

API Documentation

Variables

defaultIconPath

Signature	plugins.core.preferences.panels.streamdeck.defaultIconPath -> string
Type	Variable
Description	Default Path where built-in icons are stored

supportedExtensions

Signature	plugins.core.preferences.panels.streamdeck.supportedExtensions -> string
Type	Variable
Description	Table of supported extensions for Stream Deck Icons.

Functions

getGroupEditor

Signature	plugins.core.preferences.panels.streamdeck.getGroupEditor(groupId) -> none
Type	Function
Description	Gets the Group Editor
Parameters	groupId - Group ID
Returns	Group Editor

init

Signature	plugins.core.preferences.panels.streamdeck.init(deps, env) -> module
Type	Function
Description	Initialise the Module.
Parameters	deps - Dependancies Table env - Environment Table
Returns	The Module

setGroupEditor

Signature	plugins.core.preferences.panels.streamdeck.setGroupEditor(groupId, editorFn) -> none
Type	Function
Description	Sets the Group Editor
Parameters	groupId - Group ID editorFn - Editor Function
Returns	None

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.