Node.js API
    Preparing search index...

    Class AdjustmentActionAbstract

    Abstract base class for adjustment actions

    Adjustment actions handle continuous input devices that can be turned or moved to adjust values incrementally. These actions can optionally support reset functionality.

    class VolumeAdjustment extends AdjustmentAction {
      name = 'volume-adjustment';
      displayName = 'Volume Control';
      description = 'Adjust system volume';
      hasReset = true;

      execute(event: AdjustmentActionExecuteEvent) {
        // Adjust volume based on event.tick
        console.log(`Adjusting volume by ${event.tick}`);
      }
    }

    Hierarchy

    • ManageAction
      • AdjustmentAction
    Index

    Constructors

    constructor

    Properties

    _isRegistered _plugin actionType description displayName groupName hasReset name

    Accessors

    plugin resetCommandName

    Methods

    _setToRegistered execute toJson

    Constructors

    Properties

    _isRegistered

    _isRegistered: boolean = false

    _plugin

    _plugin: null | PluginSDK = null
    actionType: ActionType = ActionType.None

    Type of action.

    description: string

    Action Description shown in the UI.

    displayName: string

    Display Name (or title) shown in the UI.

    groupName: string = ''

    The logical group or folder this action will appear in the UI.

    hasReset: boolean

    Defines if action has reset command.

    name: string

    Unique name for the action. Used for identification in the system.

    Accessors

    • set plugin(plugin: PluginSDK): void

      Parameters

      Returns void

    • get resetCommandName(): string

      Unique reset command name for the action.

      Returns string

    Methods

    _setToRegistered

    • _setToRegistered(): void

      Returns void

    • Returns AdjustmentActionData

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods