# plugins.core.streamdeck.manager

Elgato Stream Deck Manager Plugin.

# API Overview

Variables - Configurable values

  • defaultLayout
  • imageCache
  • repeatTimers

Functions - API calls offered directly by the extension

  • buttonCallback
  • discoveryCallback
  • encoderCallback
  • getDeviceType
  • getSnippetImage
  • screenCallback
  • start
  • update

Fields - Variables which can only be accessed from an object returned by a constructor

  • activeBanks
  • automaticallySwitchApplications
  • enabled
  • lastApplication
  • lastBundleID

# API Documentation

# Variables

# defaultLayout

Signature plugins.core.streamdeck.manager.defaultLayout -> table
Type Variable
Description Default Stream Deck Layout
Notes None
Source src/plugins/core/streamdeck/manager/init.lua line 76

# imageCache

Signature plugins.core.streamdeck.manager.imageCache() -> none
Type Variable
Description A cache of images used on the Stream Deck.
Notes None
Source src/plugins/core/streamdeck/manager/init.lua line 536

# repeatTimers

Signature plugins.core.streamdeck.manager.repeatTimers -> table
Type Variable
Description A table containing hs.timer objects.
Notes None
Source src/plugins/core/streamdeck/manager/init.lua line 46

# 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
Notes None
Examples None
Source src/plugins/core/streamdeck/manager/init.lua line 276

# 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
Notes None
Examples None
Source src/plugins/core/streamdeck/manager/init.lua line 809

# encoderCallback

Signature plugins.core.streamdeck.manager.encoderCallback(object, buttonID, pressed, turningLeft, turningRight) -> none
Type Function
Description Stream Deck Screen Callback
Parameters
  • object - The hs.streamdeck userdata object
  • buttonID - The button ID
  • pressed - Was the encoder pressed?
  • turnedLeft - Did the encoder turn left?
  • turnedRight - Did the encoder turn right?
Returns
  • None
Notes None
Examples None
Source src/plugins/core/streamdeck/manager/init.lua line 484

# 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"
Notes None
Examples None
Source src/plugins/core/streamdeck/manager/init.lua line 249

# getSnippetImage

Signature plugins.core.streamdeck.manager.getSnippetImage(device, buttonData, isEncoder) -> string
Type Function
Description Generates the Preference Panel HTML Content.
Parameters
  • device - The device name as a string.
  • buttonData - A table of button data.
  • isEncoder - Are we dealing with an encoder?
Returns
  • An encoded image as a string
Notes None
Examples None
Source src/plugins/core/streamdeck/manager/init.lua line 163

# screenCallback

Signature plugins.core.streamdeck.manager.screenCallback(object, eventType, startX, startY, endX, endY) -> none
Type Function
Description Stream Deck Screen Callback
Parameters
  • object - The hs.streamdeck userdata object
  • eventType - The event type as a string
  • startX - The X position when first pressed
  • startY - The Y position when first pressed
  • endX - The X position when released
  • endY - The Y position when released
Returns
  • None
Notes None
Examples None
Source src/plugins/core/streamdeck/manager/init.lua line 501

# start

Signature plugins.core.streamdeck.manager.start() -> boolean
Type Function
Description Stops the Stream Deck Plugin
Parameters
  • None
Returns
  • None
Notes None
Examples None
Source src/plugins/core/streamdeck/manager/init.lua line 883

# update

Signature plugins.core.streamdeck.manager.update() -> none
Type Function
Description Updates the screens of all Stream Deck devices.
Parameters
  • None
Returns
  • None
Notes None
Examples None
Source src/plugins/core/streamdeck/manager/init.lua line 541

# Fields

# activeBanks

Signature plugins.core.streamdeck.manager.activeBanks <cp.prop: table>
Type Field
Description Table of active banks for each application.
Notes None
Source src/plugins/core/streamdeck/manager/init.lua line 81

# automaticallySwitchApplications

Signature plugins.core.streamdeck.manager.automaticallySwitchApplications <cp.prop: boolean>
Type Field
Description Enable or disable the automatic switching of applications.
Notes None
Source src/plugins/core/streamdeck/manager/init.lua line 61

# enabled

Signature plugins.core.streamdeck.manager.enabled <cp.prop: boolean>
Type Field
Description Enable or disable Stream Deck Support.
Notes None
Source src/plugins/core/streamdeck/manager/init.lua line 942

# lastApplication

Signature plugins.core.streamdeck.manager.lastApplication <cp.prop: string>
Type Field
Description Last Bank used in the Preferences Panel.
Notes None
Source src/plugins/core/streamdeck/manager/init.lua line 41

# lastBundleID

Signature plugins.core.streamdeck.manager.lastBundleID <cp.prop: string>
Type Field
Description The last Bundle ID.
Notes None
Source src/plugins/core/streamdeck/manager/init.lua line 66

© Copyright 2024 LateNite Films Pty Ltd. All rights reserved.