docs » plugins.core.streamdeck.manager
Elgato Stream Deck Manager Plugin.
- 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
Signature | plugins.core.streamdeck.manager.defaultLayout -> table |
---|---|
Type | Variable |
Description | Default Stream Deck Layout |
Signature | plugins.core.streamdeck.manager.buttonCallback(object, buttonID, pressed) -> none |
---|---|
Type | Function |
Description | Stream Deck Button Callback |
Parameters |
|
Returns |
|
Signature | plugins.core.streamdeck.manager.discoveryCallback(connected, object) -> none |
---|---|
Type | Function |
Description | Stream Deck Discovery Callback |
Parameters |
|
Returns |
|
Signature | plugins.core.streamdeck.manager.getDeviceType(object) -> string |
---|---|
Type | Function |
Description | Translates a Stream Deck button layout into a device type string. |
Parameters |
|
Returns |
|
Signature | plugins.core.streamdeck.manager.start() -> boolean |
---|---|
Type | Function |
Description | Stops the Stream Deck Plugin |
Parameters |
|
Returns |
|
Signature | plugins.core.streamdeck.manager.update() -> none |
---|---|
Type | Function |
Description | Updates the screens of all Stream Deck devices. |
Parameters |
|
Returns |
|
Signature | plugins.core.streamdeck.manager.activeBanks <cp.prop: table> |
---|---|
Type | Field |
Description | Table of active banks for each application. |
Signature | plugins.core.streamdeck.manager.enabled <cp.prop: boolean> |
---|---|
Type | Field |
Description | Enable or disable Stream Deck Support. |
Signature | plugins.core.streamdeck.manager.items <cp.prop: table> |
---|---|
Type | Field |
Description | Contains all the saved Stream Deck Buttons |