Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • StreamDeckActionClass

Index

Constructors

constructor

Accessors

action

  • get action(): string
  • set action(value: string): void
  • The action's unique identifier. If your plugin supports multiple actions, you should use this value to see which action was triggered.

    Gets the action

    Returns string

  • The action's unique identifier. If your plugin supports multiple actions, you should use this value to see which action was triggered.

    Sets the action

    Parameters

    • value: string

    Returns void

column

  • get column(): number
  • set column(value: number): void

context

  • get context(): string
  • set context(value: string): void
  • An opaque value identifying the instance's action. You will need to pass this opaque value to several APIs like the setTitle API.

    Gets the context

    Returns string

  • An opaque value identifying the instance's action. You will need to pass this opaque value to several APIs like the setTitle API.

    Sets the context

    Parameters

    • value: string

    Returns void

device

  • get device(): string
  • set device(value: string): void

isInMultiAction

  • get isInMultiAction(): boolean
  • set isInMultiAction(value: boolean): void

row

  • get row(): number
  • set row(value: number): void

settings

  • set settings(value: undefined | object): void

state

  • This is a parameter that is only set when the action has multiple states defined in its manifest.json. The 0-based value contains the current state of the action.

    Gets the state

    Returns StateType

  • This is a parameter that is only set when the action has multiple states defined in its manifest.json. The 0-based value contains the current state of the action.

    Sets the state

    Parameters

    Returns void

userDesiredState

  • This is a parameter that is only set when the action is triggered with a specific value from a Multi Action. For example if the user sets the Game Capture Record action to be disabled in a Multi Action, you would see the value 1. Only the value 0 and 1 are valid.

    Gets the user desired state

    Returns StateType

  • This is a parameter that is only set when the action is triggered with a specific value from a Multi Action. For example if the user sets the Game Capture Record action to be disabled in a Multi Action, you would see the value 1. Only the value 0 and 1 are valid.

    Sets the user desired state

    Parameters

    Returns void

Methods

disableAutoDebounce

  • disableAutoDebounce(): void

disableAutoSave

  • disableAutoSave(): void

enableAutoDebounce

  • enableAutoDebounce(): void

enableAutoSave

  • enableAutoSave(): void

getAction

  • getAction(): string

getContext

  • getContext(): string

getDevice

  • getDevice(): string

getSettings

  • getSettings<Settings>(): undefined | object | Settings

saveSettings

  • saveSettings(ms: number): void

setSettings

  • setSettings<Settings>(settings: object | Settings, ms?: number): void
  • Set context settings

    Type parameters

    • Settings = object

      your settings interface for autocomplete

    Parameters

    • settings: object | Settings
    • ms: number = 0

      for the debounce

    Returns void

setSettingsAttributes

  • setSettingsAttributes(attributes: object, ms?: number): void

Generated using TypeDoc