docs » hs.streamdeck

Sets/clears a callback for reacting to device discovery events

• fn - A function that will be called when a Stream Deck is connected or disconnected. It should take the following arguments:
  • A boolean, true if a device was connected, false if a device was disconnected
  • An hs.streamdeck object, being the device that was connected/disconnected

• None

Gets an hs.streamdeck object for the specified device

• num - A number that should be within the bounds of the number of connected devices

• An hs.streamdeck object

Initialises the Stream Deck driver and sets a discovery callback

• fn - A function that will be called when a Stream Deck is connected or disconnected. It should take the following arguments:
  • A boolean, true if a device was connected, false if a device was disconnected
  • An hs.streamdeck object, being the device that was connected/disconnected

• None

• This function must be called before any other parts of this module are used

Gets the number of Stream Deck devices connected

• None

• A number containing the number of Stream Deck devices attached to the system

Sets/clears the button callback function for a Stream Deck device

• fn - A function to be called when a button is pressed/released on the stream deck. It should receive three arguments:
  • The hs.streamdeck userdata object
  • A number containing the button that was pressed/released
  • A boolean indicating whether the button was pressed (true) or released (false)

• The hs.streamdeck device

Gets the layout of buttons a Stream Deck device has

• None

• The number of columns
• The number of rows

Sets/clears the knob/encoder callback function for a Stream Deck Plus.

• fn - A function to be called when an encoder button is pressed/released/rotated on a Stream Deck Plus. It should receive five arguments:
  • The hs.streamdeck userdata object
  • A number containing the button that was pressed/released/rotated
  • A boolean indicating whether the button was pressed (true) or released (false)
  • A boolean indicating that the button was turned left
  • A boolean indicating that the button was turned right

• The hs.streamdeck device

Gets the firmware version of a Stream Deck device

• None

• A string containing the firmware version of the deck

Gets the width and height of the buttons in pixels

• None

• An table with keys w and h containing the width and height, respectively, of images expected by the Stream Deck

Resets a Stream Deck device

• None

• The hs.streamdeck object

Sets/clears the screen callback function for a Stream Deck Plus's touch screen (above the encoder knobs).

• fn - A function to be called when a screen is pressed/released/swiped on a Stream Deck Plus. It should receive six arguments:
  • The hs.streamdeck userdata object
  • A string either containing "shortPress", "longPress" or "swipe"
  • The X position of where the screen was first touched
  • The Y position of where the screen was first touched
  • The X position of where the screen was last touched (if swiping)
  • The Y position of where the screen was last touched (if swiping)

• The hs.streamdeck device

Gets the serial number of a Stream Deck device

• None

• A string containing the serial number of the deck

Sets the brightness of a Stream Deck device

• brightness - A whole number between 0 and 100 indicating the percentage brightness level to set

• The hs.streamdeck device

Sets a button on the Stream Deck device to the specified color

• button - A number (from 1 to 15) describing which button to set the color on
• color - An hs.drawing.color object

• The hs.streamdeck object

Sets the image of a button on the Stream Deck device

• button - A number (from 1 to 15) describing which button to set the image for
• image - An hs.image object

• The hs.streamdeck object

Sets the image of the screen on the Stream Deck device

• encoder - A number (from 1 to 4) describing which encoder to set the image for
• image - An hs.image object

• The hs.streamdeck object