plugins.core.streamdeck.manager.md

docs » plugins.core.streamdeck.manager

---

Elgato Stream Deck Manager Plugin.

API Overview

• Variables - Configurable values
• defaultLayout
• Functions - API calls offered directly by the extension
• buttonCallback
• discoveryCallback
• getDeviceType
• start
• update
• Fields - Variables which can only be accessed from an object returned by a constructor
• activeBanks
• enabled
• items

API Documentation

Variables

defaultLayout

Signature	plugins.core.streamdeck.manager.defaultLayout -> table
Type	Variable
Description	Default Stream Deck Layout

Functions

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

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

getDeviceType

Signature	plugins.core.streamdeck.manager.getDeviceType(object) -> string
Type	Function
Description	Translates a Stream Deck button layout into a device type string.
Parameters	object - A hs.streamdeck object
Returns	"Mini", "Original" or "XL"

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 screens of all Stream Deck devices.
Parameters	None
Returns	None

Fields

activeBanks

Signature	plugins.core.streamdeck.manager.activeBanks <cp.prop: table>
Type	Field
Description	Table of active banks for each application.

enabled

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

items

Signature	plugins.core.streamdeck.manager.items <cp.prop: table>
Type	Field
Description	Contains all the saved Stream Deck Buttons