streamdeck

Last updated last month

Configure/control an Elgato Stream Deck

Please note that in order for this module to work, the official Elgato Stream Deck app should not be running

This module would not have been possible without standing on the shoulders of others:

API Overview

API Documentation

Functions

Signature

hs.streamdeck.discoveryCallback(fn)

Type

Function

Description

Sets/clears a callback for reacting to device discovery events

Parameters

Returns

getDevice

Signature

hs.streamdeck.getDevice(num)

Type

Function

Description

Gets an hs.streamdeck object for the specified device

Parameters

Returns

init

Signature

hs.streamdeck.init(fn)

Type

Function

Description

Initialises the Stream Deck driver and sets a discovery callback

Parameters

Returns

Notes

Signature

hs.streamdeck.numDevices()

Type

Function

Description

Gets the number of Stream Deck devices connected

Parameters

Returns

Methods

Signature

hs.streamdeck:buttonCallback(fn)

Type

Method

Description

Sets/clears the button callback function for a deck

Parameters

Returns

Signature

hs.streamdeck:firmwareVersion()

Type

Method

Description

Gets the firmware version of a deck

Parameters

Returns

reset

Signature

hs.streamdeck:reset()

Type

Method

Description

Resets a deck

Parameters

Returns

Signature

hs.streamdeck:serialNumber()

Type

Method

Description

Gets the serial number of a deck

Parameters

Returns

Signature

hs.streamdeck:setBrightness(brightness)

Type

Method

Description

Sets the brightness of a deck

Parameters

Returns

Signature

hs.streamdeck:setButtonColor(button, color)

Type

Method

Description

Sets a button on the deck to the specified color

Parameters

Returns

Signature

hs.streamdeck:setButtonImage(button, image)

Type

Method

Description

Sets the image of a button on the deck

Parameters

Returns