plugins.core.streamdeck.manager.md

docs » plugins.core.streamdeck.manager

---

Elgato Stream Deck Manager Plugin.

API Overview

• Variables - Configurable values
• defaultGroup
• maxItems
• Functions - API calls offered directly by the extension
• activeGroup
• appWatcherCallback
• buttonCallback
• clear
• discoveryCallback
• getAction
• getActionHandlerID
• getActionTitle
• getIcon
• getLabel
• groupStatus
• init
• start
• update
• updateAction
• updateIcon
• updateLabel
• Fields - Variables which can only be accessed from an object returned by a constructor
• buttons
• enabled

API Documentation

Variables

defaultGroup

Signature	plugins.core.streamdeck.manager.defaultGroup -> string
Type	Variable
Description	The default group.

maxItems

Signature	plugins.core.streamdeck.manager.maxItems -> number
Type	Variable
Description	The maximum number of Touch Bar items per group.

Functions

activeGroup

Signature	plugins.core.streamdeck.manager.activeGroup() -> none
Type	Function
Description	Returns the active group.
Parameters	None
Returns	Returns the active group or manager.defaultGroup as a string.

appWatcherCallback

Signature	plugins.core.streamdeck.manager.appWatcherCallback(name, event, app) -> none
Type	Function
Description	Stream Deck App Watcher Callback
Parameters	name - A string containing the name of the application event - An event type app - An hs.application object representing the application, or nil if the application couldn't be found
Returns	None

buttonCallback

Signature	plugins.core.streamdeck.manager.buttonCallback(object, buttonID, pressed) -> none
Type	Function
Description	Stream Deck Button Callback
Parameters	object - The hs.streamdeck userdata object buttonID - A number containing the button that was pressed/released pressed - A boolean indicating whether the button was pressed (true) or released (false)
Returns	None

clear

Signature	plugins.core.streamdeck.manager.clear() -> none
Type	Function
Description	Clears the Touch Bar items.
Parameters	None
Returns	None

discoveryCallback

Signature	plugins.core.streamdeck.manager.discoveryCallback(connected, object) -> none
Type	Function
Description	Stream Deck Discovery Callback
Parameters	connected - A boolean, true if a device was connected, false if a device was disconnected object - An hs.streamdeck object, being the device that was connected/disconnected
Returns	None

getAction

Signature	plugins.core.streamdeck.manager.getAction(button, group) -> string
Type	Function
Description	Returns a specific Touch Bar Action.
Parameters	button - Button ID as string group - Group ID as string
Returns	Action as string

getActionHandlerID

Signature	plugins.core.streamdeck.manager.getActionHandlerID(button, group) -> string
Type	Function
Description	Returns a specific Touch Bar Action Handler ID.
Parameters	button - Button ID as string group - Group ID as string
Returns	Action as string

getActionTitle

Signature	plugins.core.streamdeck.manager.getActionTitle(button, group) -> string
Type	Function
Description	Returns a specific Touch Bar Action Title.
Parameters	button - Button ID as string group - Group ID as string
Returns	Action as string

getIcon

Signature	plugins.core.streamdeck.manager.getIcon(button, group) -> string
Type	Function
Description	Returns a specific Touch Bar Icon.
Parameters	button - Button ID as string group - Group ID as string
Returns	Icon data as string

getLabel

Signature	plugins.core.streamdeck.manager.getLabel(button, group) -> string
Type	Function
Description	Returns a specific Touch Bar Label.
Parameters	button - Button ID as string group - Group ID as string
Returns	Label as string

groupStatus

Signature	plugins.core.streamdeck.manager.groupStatus(groupID, status) -> none
Type	Function
Description	Updates a group's visibility status.
Parameters	groupID - the group you want to update as a string. status - the status of the group as a boolean.
Returns	None

init

Signature	plugins.core.streamdeck.manager.init(deps, env) -> none
Type	Function
Description	Initialises the Stream Deck Plugin
Parameters	deps - Dependencies Table env - Environment Table
Returns	None

start

Signature	plugins.core.streamdeck.manager.start() -> boolean
Type	Function
Description	Stops the Stream Deck Plugin
Parameters	None
Returns	None

update

Signature	plugins.core.streamdeck.manager.update() -> none
Type	Function
Description	Updates the Touch Bar.
Parameters	None
Returns	None

updateAction

Signature	plugins.core.streamdeck.manager.updateAction(button, group, action) -> none
Type	Function
Description	Updates a Touch Bar action.
Parameters	button - Button ID as string group - Group ID as string action - Action as string
Returns	None

updateIcon

Signature	plugins.core.streamdeck.manager.updateIcon(button, group, icon) -> none
Type	Function
Description	Updates a Touch Bar icon.
Parameters	button - Button ID as string group - Group ID as string icon - Icon Data as string
Returns	None

updateLabel

Signature	plugins.core.streamdeck.manager.updateLabel(button, group, label) -> none
Type	Function
Description	Updates a Touch Bar action.
Parameters	button - Button ID as string group - Group ID as string label - Label as string
Returns	None

Fields

buttons

Signature	plugins.core.streamdeck.manager.buttons <cp.prop: table>
Type	Field
Description	Contains all the saved Touch Bar Buttons

enabled

Signature	plugins.core.streamdeck.manager.enabled <cp.prop: boolean>
Type	Field
Description	Enable or disable Touch Bar Support.