#plugins.core.streamdeck.prefs

Stream Deck Preferences Panel


#API Overview

Variables - Configurable values

Functions - API calls offered directly by the extension

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

Methods - API calls which can only be made on an object returned by a constructor


#API Documentation

#Variables

Signatureplugins.core.streamdeck.prefs.defaultIconPath -> string
TypeVariable
DescriptionDefault Path where built-in icons are stored
NotesNone
Sourcesrc/plugins/core/streamdeck/prefs/init.lua line 98

Signatureplugins.core.streamdeck.prefs.supportedExtensions -> string
TypeVariable
DescriptionTable of supported extensions for Stream Deck Icons.
NotesNone
Sourcesrc/plugins/core/streamdeck/prefs/init.lua line 91

#Functions

Signatureplugins.core.streamdeck.prefs.buildIconFromLabel(params) -> string
TypeFunction
DescriptionCreates a new icon image from a string.
Parameters
  • params - A table of parameters.
Returns
  • A new encoded icon as URL string.
NotesNone
ExamplesNone
Sourcesrc/plugins/core/streamdeck/prefs/init.lua line 614

Signatureplugins.core.streamdeck.prefs.processEncodedIcon(icon, controlType) -> string
TypeFunction
DescriptionProcesses an encoded icon.
Parameters
  • icon - The encoded icon as URL string or a hs.image object.
  • button - The button ID.
Returns
  • A new encoded icon as URL string.
NotesNone
ExamplesNone
Sourcesrc/plugins/core/streamdeck/prefs/init.lua line 680

#Fields

Signatureplugins.core.streamdeck.prefs.automaticallyApplyIconFromAction <cp.prop: boolean>
TypeField
DescriptionAutomatically Apply Icon from Action
NotesNone
Sourcesrc/plugins/core/streamdeck/prefs/init.lua line 103

Signatureplugins.core.streamdeck.prefs.backgroundColour <cp.prop: string>
TypeField
DescriptionBackground Colour.
NotesNone
Sourcesrc/plugins/core/streamdeck/prefs/init.lua line 108

Signatureplugins.core.streamdeck.prefs.iconHistory <cp.prop: table>
TypeField
DescriptionIcon History
NotesNone
Sourcesrc/plugins/core/streamdeck/prefs/init.lua line 123

Signatureplugins.core.streamdeck.prefs.lastDevice <cp.prop: string>
TypeField
DescriptionLast Device used in the Preferences Panel.
NotesNone
Sourcesrc/plugins/core/streamdeck/prefs/init.lua line 143

Signatureplugins.core.streamdeck.prefs.lastExportPath <cp.prop: string>
TypeField
DescriptionLast Export path.
NotesNone
Sourcesrc/plugins/core/streamdeck/prefs/init.lua line 133

Signatureplugins.core.streamdeck.prefs.lastIconPath <cp.prop: string>
TypeField
DescriptionLast icon path.
NotesNone
Sourcesrc/plugins/core/streamdeck/prefs/init.lua line 118

Signatureplugins.core.streamdeck.prefs.lastImportPath <cp.prop: string>
TypeField
DescriptionLast Import path.
NotesNone
Sourcesrc/plugins/core/streamdeck/prefs/init.lua line 138

Signatureplugins.core.streamdeck.prefs.lastUnit <cp.prop: string>
TypeField
DescriptionLast Unit used in the Preferences Panel.
NotesNone
Sourcesrc/plugins/core/streamdeck/prefs/init.lua line 153

Signatureplugins.core.streamdeck.prefs.pasteboard <cp.prop: table>
TypeField
DescriptionPasteboard
NotesNone
Sourcesrc/plugins/core/streamdeck/prefs/init.lua line 128

Signatureplugins.core.streamdeck.prefs.previewSelectedApplicationAndBankOnHardware <cp.prop: boolean>
TypeField
DescriptionShould we preview the selected application and bank on hardware?
NotesNone
Sourcesrc/plugins/core/streamdeck/manager/init.lua line 51

Signatureplugins.core.streamdeck.prefs.resizeImagesOnImport <cp.prop: string>
TypeField
DescriptionResize Icons on Import Preference.
NotesNone
Sourcesrc/plugins/core/streamdeck/prefs/init.lua line 113

Signatureplugins.core.streamdeck.prefs.snippetsRefreshFrequency <cp.prop: string>
TypeField
DescriptionHow often snippets are refreshed.
NotesNone
Sourcesrc/plugins/core/streamdeck/manager/init.lua line 56

#Methods

Signatureplugins.core.streamdeck.prefs.setItem(app, bank, button, key, [value]) -> none
TypeMethod
DescriptionUpdate the Stream Deck layout file.
Parameters
  • app - The application bundle ID as a string
  • bank - The bank ID as a string
  • button - The button ID as a string
  • key - The key as a string or a table if replacing the entire button contents
  • value - The optional value
Returns
  • None
NotesNone
ExamplesNone
Sourcesrc/plugins/core/streamdeck/prefs/init.lua line 563