Class StreamDeckHandlerBase<GlobalSettings>

This is the base class for all Stream Deck handlers

author: XeroxDev help@xeroxdev.de
copyright: 2021

Type parameters

GlobalSettings = any

Hierarchy

StreamDeckHandlerBase
- StreamDeckPluginHandler
- StreamDeckPropertyInspectorHandler

Index

Constructors

constructor

Accessors

Methods

Constructors

Protected constructor

new StreamDeckHandlerBase<GlobalSettings>(): StreamDeckHandlerBase<GlobalSettings>

- Defined in abstracts/stream-deck-handler-base.ts:35
Type parameters
- GlobalSettings = any
Returns StreamDeckHandlerBase<GlobalSettings>

Accessors

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

enableDebug

enableDebug(): void

- 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

- 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

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

Parameters
- url: string
Returns void

requestGlobalSettings

requestGlobalSettings(): void

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

Returns void

requestSettings

requestSettings(context: string): void

- 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

- 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

Generated using TypeDoc