Class StreamDeckPluginHandler<GlobalSettings>

This will help you create the stream deck action handler

author: XeroxDev help@xeroxdev.de
copyright: 2021

Type parameters

GlobalSettings = any

Hierarchy

StreamDeckHandlerBase<GlobalSettings>
- StreamDeckPluginHandler

Index

Constructors

constructor

Accessors

Methods

Constructors

Protected constructor

new StreamDeckPluginHandler<GlobalSettings>(): StreamDeckPluginHandler<GlobalSettings>

Overrides StreamDeckHandlerBase.constructor
- Defined in abstracts/stream-deck-plugin-handler.ts:15
Type parameters
- GlobalSettings = any
Returns StreamDeckPluginHandler<GlobalSettings>

Accessors

actionManager

get actionManager(): ActionManager

- Defined in abstracts/stream-deck-plugin-handler.ts:22
Returns ActionManager

connectionReady

get connectionReady(): boolean

- Defined in abstracts/stream-deck-handler-base.ts:111
Returns boolean

documentReady

get documentReady(): boolean

- Defined in abstracts/stream-deck-handler-base.ts:107
Returns boolean

globalSettingsReady

get globalSettingsReady(): boolean

- Defined in abstracts/stream-deck-handler-base.ts:115
Returns boolean

info

get info(): InitEventInfo

- Defined in abstracts/stream-deck-handler-base.ts:94
All the information send from Elgato

Returns InitEventInfo

port

get port(): string

- Defined in abstracts/stream-deck-handler-base.ts:71
The port for the Stream Deck Application

Returns string

registerEvent

get registerEvent(): string

- Defined in abstracts/stream-deck-handler-base.ts:86
The Event sent from Elgato, which is needed for the registration procedure

Returns string

settingsManager

get settingsManager(): SettingsManager

- Defined in abstracts/stream-deck-handler-base.ts:103
Through this object you can get, set and edit all available settings (global settings and context settings)

see

SettingsManager

Returns SettingsManager

uuid

get uuid(): string

- Defined in abstracts/stream-deck-handler-base.ts:78
Returns string

The UUID of the Plugin

Methods

Protected _eventHandler

_eventHandler(ev: MessageEvent<any>): void

Overrides StreamDeckHandlerBase._eventHandler
- Defined in abstracts/stream-deck-plugin-handler.ts:187
Parameters
- ev: MessageEvent<any>
Returns void

enableDebug

enableDebug(): void

Inherited from StreamDeckHandlerBase.enableDebug
- Defined in abstracts/stream-deck-handler-base.ts:207
Enables debug mode so you can see incoming and outgoing events.

Returns void

logMessage

logMessage(message: string): void

Inherited from StreamDeckHandlerBase.logMessage
- Defined in abstracts/stream-deck-handler-base.ts:177
Logs a message to the elgato log file

Parameters
- message: string
Returns void

openUrl

openUrl(url: string): void

Inherited from StreamDeckHandlerBase.openUrl
- Defined in abstracts/stream-deck-handler-base.ts:167
Opens a url

Parameters
- url: string
Returns void

requestGlobalSettings

requestGlobalSettings(): void

Inherited from StreamDeckHandlerBase.requestGlobalSettings
- Defined in abstracts/stream-deck-handler-base.ts:157
Requests global settings

Returns void

requestSettings

requestSettings(context: string): void

Inherited from StreamDeckHandlerBase.requestSettings
- Defined in abstracts/stream-deck-handler-base.ts:136
Requests settings for current context / action

Parameters
- context: string
Returns void

send

send(event: string, data: any): void

Inherited from StreamDeckHandlerBase.send
- Defined in abstracts/stream-deck-handler-base.ts:188
Sends custom socket events to the stream deck software

Parameters
- event: string
- data: any
Returns void

sendToPropertyInspector

sendToPropertyInspector(payload: any, action: string, context: string): void

- Defined in abstracts/stream-deck-plugin-handler.ts:175
Send data to the property inspector

Parameters
- payload: any
  
  Data to send
- action: string
  
  Action context.
- context: string
  
  The context which called it
Returns void

setFeedback

setFeedback(context: string, payload: any): void

- Defined in abstracts/stream-deck-plugin-handler.ts:248
Sets the action title

Parameters
- context: string
  
  The context which called it
- payload: any
Returns void

setFeedbackLayout

setFeedbackLayout(context: string, layout: string): void

- Defined in abstracts/stream-deck-plugin-handler.ts:263
Sets the action title

Parameters
- context: string
  
  The context which called it
- layout: string
Returns void

setImage

setImage(image: string, context: string, target?: TargetType, state?: StateType): void

- Defined in abstracts/stream-deck-plugin-handler.ts:59
Sets the action image

Parameters
- image: string
  
  Image as string
- context: string
  
  The context which called it
- target: TargetType = ...
  
  Show image only on hardware, software or both (default: Both)
- Optional state: StateType
  
  Show image only on ON state or OFF state (default: Both)
Returns void

setImageFromUrl

setImageFromUrl(url: string, context: string, target?: TargetType, state?: StateType): Promise<string>

- Defined in abstracts/stream-deck-plugin-handler.ts:86
Sets the action image but instead from file, from URL

Parameters
- url: string
- context: string
- target: TargetType = ...
- Optional state: StateType
Returns Promise<string>

setState

setState(state: StateType, context: string): void

- Defined in abstracts/stream-deck-plugin-handler.ts:149
Sets the state of the action (ON / OFF)

Parameters
- state: StateType
- context: string
  
  The context which called it
Returns void

setTitle

setTitle(title: string, context: string, target?: TargetType, state?: StateType): void

- Defined in abstracts/stream-deck-plugin-handler.ts:33
Sets the action title

Parameters
- title: string
  
  The string the title should be
- context: string
  
  The context which called it
- target: TargetType = ...
  
  Show title only on hardware, software or both (default: Both)
- Optional state: StateType
  
  Show title only on ON state or OFF state (default: Both)
Returns void

showAlert

showAlert(context: string): void

- Defined in abstracts/stream-deck-plugin-handler.ts:132
Shows a alert icon on action

Parameters
- context: string
Returns void

showOk

showOk(context: string): void

- Defined in abstracts/stream-deck-plugin-handler.ts:140
Shows a okay icon on action

Parameters
- context: string
Returns void

switchToProfile

switchToProfile(profile: string, device?: string): void

- Defined in abstracts/stream-deck-plugin-handler.ts:161
Switch to a profile

Parameters
- profile: string
- Optional device: string
Returns void

Generated using TypeDoc