#plugins.core.streamdeck.prefs

Stream Deck Preferences Panel

#API Overview

Variables - Configurable values

defaultIconPath
supportedExtensions

Functions - API calls offered directly by the extension

buildIconFromLabel
processEncodedIcon

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

automaticallyApplyIconFromAction
backgroundColour
iconHistory
lastDevice
lastExportPath
lastIconPath
lastImportPath
lastUnit
pasteboard
previewSelectedApplicationAndBankOnHardware
resizeImagesOnImport
snippetsRefreshFrequency

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

setItem

#API Documentation

#Variables

#defaultIconPath


Signature	`plugins.core.streamdeck.prefs.defaultIconPath -> string`
Type	Variable
Description	Default Path where built-in icons are stored
Notes	None
Source	src/plugins/core/streamdeck/prefs/init.lua line 98

#supportedExtensions


Signature	`plugins.core.streamdeck.prefs.supportedExtensions -> string`
Type	Variable
Description	Table of supported extensions for Stream Deck Icons.
Notes	None
Source	src/plugins/core/streamdeck/prefs/init.lua line 91

#Functions

#buildIconFromLabel


Signature	`plugins.core.streamdeck.prefs.buildIconFromLabel(params) -> string`
Type	Function
Description	Creates a new icon image from a string.
Parameters	params - A table of parameters.
Returns	A new encoded icon as URL string.
Notes	None
Examples	None
Source	src/plugins/core/streamdeck/prefs/init.lua line 614

#processEncodedIcon


Signature	`plugins.core.streamdeck.prefs.processEncodedIcon(icon, controlType) -> string`
Type	Function
Description	Processes 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.
Notes	None
Examples	None
Source	src/plugins/core/streamdeck/prefs/init.lua line 680

#Fields

#automaticallyApplyIconFromAction


Signature	`plugins.core.streamdeck.prefs.automaticallyApplyIconFromAction <cp.prop: boolean>`
Type	Field
Description	Automatically Apply Icon from Action
Notes	None
Source	src/plugins/core/streamdeck/prefs/init.lua line 103

#backgroundColour


Signature	`plugins.core.streamdeck.prefs.backgroundColour <cp.prop: string>`
Type	Field
Description	Background Colour.
Notes	None
Source	src/plugins/core/streamdeck/prefs/init.lua line 108

#iconHistory


Signature	`plugins.core.streamdeck.prefs.iconHistory <cp.prop: table>`
Type	Field
Description	Icon History
Notes	None
Source	src/plugins/core/streamdeck/prefs/init.lua line 123

#lastDevice


Signature	`plugins.core.streamdeck.prefs.lastDevice <cp.prop: string>`
Type	Field
Description	Last Device used in the Preferences Panel.
Notes	None
Source	src/plugins/core/streamdeck/prefs/init.lua line 143

#lastExportPath


Signature	`plugins.core.streamdeck.prefs.lastExportPath <cp.prop: string>`
Type	Field
Description	Last Export path.
Notes	None
Source	src/plugins/core/streamdeck/prefs/init.lua line 133

#lastIconPath


Signature	`plugins.core.streamdeck.prefs.lastIconPath <cp.prop: string>`
Type	Field
Description	Last icon path.
Notes	None
Source	src/plugins/core/streamdeck/prefs/init.lua line 118

#lastImportPath


Signature	`plugins.core.streamdeck.prefs.lastImportPath <cp.prop: string>`
Type	Field
Description	Last Import path.
Notes	None
Source	src/plugins/core/streamdeck/prefs/init.lua line 138

#lastUnit


Signature	`plugins.core.streamdeck.prefs.lastUnit <cp.prop: string>`
Type	Field
Description	Last Unit used in the Preferences Panel.
Notes	None
Source	src/plugins/core/streamdeck/prefs/init.lua line 153

#pasteboard


Signature	`plugins.core.streamdeck.prefs.pasteboard <cp.prop: table>`
Type	Field
Description	Pasteboard
Notes	None
Source	src/plugins/core/streamdeck/prefs/init.lua line 128

#previewSelectedApplicationAndBankOnHardware


Signature	`plugins.core.streamdeck.prefs.previewSelectedApplicationAndBankOnHardware <cp.prop: boolean>`
Type	Field
Description	Should we preview the selected application and bank on hardware?
Notes	None
Source	src/plugins/core/streamdeck/manager/init.lua line 51

#resizeImagesOnImport


Signature	`plugins.core.streamdeck.prefs.resizeImagesOnImport <cp.prop: string>`
Type	Field
Description	Resize Icons on Import Preference.
Notes	None
Source	src/plugins/core/streamdeck/prefs/init.lua line 113

#snippetsRefreshFrequency


Signature	`plugins.core.streamdeck.prefs.snippetsRefreshFrequency <cp.prop: string>`
Type	Field
Description	How often snippets are refreshed.
Notes	None
Source	src/plugins/core/streamdeck/manager/init.lua line 56

#Methods

#setItem


Signature	`plugins.core.streamdeck.prefs.setItem(app, bank, button, key, [value]) -> none`
Type	Method
Description	Update 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
Notes	None
Examples	None
Source	src/plugins/core/streamdeck/prefs/init.lua line 563