PluginApi
Defines the device types supported by Loupedeck.
Reserved.
Represents any device in Loupedeck Original Family.
Represents Loupedeck Original device.
Represents Loupedeck+ device.
Represents any device in Loupedeck CT Family.
Represents Loupedeck CT device.
Represents Loupedeck Live device.
Represents Razer Stream Controller device. Deprecated — Razer device support has been removed.
Represents Loupedeck Live S device.
Represents Razer Stream Controller X device. Deprecated — Razer device support has been removed.
Represents Logitech MX Creative Console devices.
Represents Logitech MX Creative Keypad device.
Represents Logitech MX Creative Dialpad device.
Represents Logitech Actions Ring device.
Represents any device supported by Logi Plugin Service.
The size of the plugin image.
Image size is not specified.
Specifies a 80x80 pixel image.
Specifies a 50x50 pixel image.
Specifies a 116x116 pixel image.
Status of the client application.
This class can be used to link a Loupedeck plugin to an application.
Defines the application process that is connected to the plugin.
For Windows applications, override this method to link one process to the plugin.
See also .
Process name.
Defines the application bundle that is connected to the plugin.
For macOS applications, override this method to link one bundle to the plugin.
See also .
Bundle identifier. For example "com.apple.finder".
Defines the application processes that are connected to the plugin.
For Windows applications, override this method to link more than one process to the plugin.
See also .
Process names.
Defines the application bundles that are connected to the plugin.
For macOS applications, override this method to link more than one bundle to the plugin.
See also .
Bundle identifiers.
Tests whether the given process name is supported by the plugin.
The name of the process to test.
true if the process name is supported, false otherwise.
Tests whether the given process name is supported by the plugin.
The name of the process to test.
The full path of the main module of the process to test.
true if the process name is supported, false otherwise.
Checks if the client application is installed.
Override this method to define how the client application status is obtained.
Status of the client application.
Base class for dynamic actions.
This class provides the foundation for dynamic commands and adjustments. Inherit from
or instead of using this class directly.
Gets or sets a value indicating whether this action is enabled.
When set to false, the action will not execute and will appear disabled in the user interface.
Called after the parent plugin is loaded.
true if the action loaded successfully; otherwise, false.
Override this method to perform action-specific initialization such as subscribing to events or setting initial
state.
Called before the parent plugin is unloaded.
true if the action unloaded successfully; otherwise, false.
Override this method to perform cleanup such as unsubscribing from events or releasing resources.
Registers a parameter to create action variations with different behaviors.
The unique name identifier for this parameter.
The display name shown for this parameter in the user interface.
The group name used to organize this parameter in the user interface.
The created parameter object.
Use parameters to create variations of an action with different behaviors. For example, a volume control
command might have parameters for "Master", "Music", and "Voice" channels. After adding parameters, call
to notify the Logi Plugin Service.
Called when the user executes this command.
The parameter name identifying which variation of the action to execute, or null if this action has
no parameters.
Override this method to implement the command's behavior. This method is called when the user presses a
button mapped to this command on the device or in the host application.
protected override void RunCommand(String actionParameter)
{
// Toggle mute state
this._isMuted = !this._isMuted;
// Send command to target application
this.Plugin.ClientApplication.SendKeyPress(Enums.VirtualKeyCode.VolumeMute);
// Update the action icon to reflect new state
this.ActionImageChanged();
}
Gets the display name for this command.
The parameter name identifying which variation of the action to display, or null if this action has
no parameters.
The size of the image being rendered, which may affect the display name.
The display name to show for this command, or null to use the default display name.
Override this method to provide dynamic display names that change based on the action's state. This method is
called when the Logi Plugin Service needs to display the command on the device or in the user interface.
Gets the action icon image for this command.
The parameter name identifying which variation of the action to display, or null if this action has
no parameters.
The size of the image to generate.
A representing the command's icon, or null if no custom image is provided.
Override this method to provide dynamic images that change based on the action's state. This method is called
when the Logi Plugin Service needs to display the command on the device or in the user interface. Use
to load images from the plugin assembly, or generate images dynamically using
methods.
Notifies the Logi Plugin Service that the action's parameters have changed.
Call this method after adding, removing, or modifying parameters to update the user interface with the new
parameter list.
Notifies the Logi Plugin Service that the action's display name or image has changed.
The parameter name identifying which variation of the action has changed, or null if this action has
no parameters.
Call this method after the action's visual appearance changes to update the display on the device and in the
user interface.
Notifies the Logi Plugin Service that the action's display name or image has changed.
Call this method after the action's visual appearance changes to update the display on the device and in the
user interface.
Notifies the Logi Plugin Service that the adjustment value has changed.
The parameter name identifying which variation of the adjustment has changed, or null if this action
has no parameters.
Call this method from implementations when the adjustment's value
changes to update the display on the device and in the user interface.
Notifies the Logi Plugin Service that the adjustment value has changed.
The new adjustment value.
Call this method from implementations when the adjustment's value
changes to update the display on the device and in the user interface.
Notifies the Logi Plugin Service that the adjustment value has changed.
The parameter name identifying which variation of the adjustment has changed, or null if this action
has no parameters.
The new adjustment value.
Call this method from implementations when the adjustment's value
changes to update the display on the device and in the user interface.
Notifies the Logi Plugin Service that the adjustment value has changed.
Call this method from implementations when the adjustment's value
changes to update the display on the device and in the user interface.
Base class for dynamic adjustments.
Inherit this class to create a dynamic adjustment for your plugin. Override to
implement the adjustment's behavior, and optionally override
and to customize the adjustment's appearance.
Minimal implementation requires overriding to handle rotation events and
to return the current value for display.
public class CounterAdjustment : PluginDynamicAdjustment
{
private Int32 _counter = 0;
public CounterAdjustment()
: base(displayName: "Counter", description: "Counts rotation ticks", groupName: "Adjustments", hasReset: true)
{
}
protected override void ApplyAdjustment(String actionParameter, Int32 diff)
{
this._counter += diff;
this.AdjustmentValueChanged();
}
protected override void RunCommand(String actionParameter)
{
this._counter = 0;
this.AdjustmentValueChanged();
}
protected override String GetAdjustmentValue(String actionParameter) => this._counter.ToString();
}
Initializes a new instance of the class.
Indicates whether this adjustment supports reset functionality.
The device types supported by this adjustment. Set to to support all devices,
or combine specific device types using bitwise OR.
Use this constructor when the display name, description, or group name are not known at construction time.
Initializes a new instance of the class with display name and group name.
The display name shown for this adjustment in the user interface.
A brief explanation of what this adjustment does.
The group name used to organize this adjustment in the user interface.
Indicates whether this adjustment supports reset functionality.
The device types supported by this adjustment. Set to to support all devices,
or combine specific device types using bitwise OR.
Use this constructor when the display name, description, and group name are known at construction time.
Called when the user adjusts this adjustment.
The parameter name identifying which variation of the action to execute, or null if this action has
no parameters.
The adjustment amount. Positive values indicate an increase, negative values indicate a decrease.
Override this method to implement the adjustment's behavior.
protected override void ApplyAdjustment(String actionParameter, Int32 diff)
{
// Update internal state based on adjustment
this._counter += diff;
// Notify that the value changed
this.AdjustmentValueChanged();
}
Gets the display name for this adjustment.
The parameter name identifying which variation of the action to display, or null if this action has
no parameters.
The size of the image being rendered, which may affect the display name.
The display name to show for this adjustment, or null to use the default display name.
Override this method to provide dynamic display names that change based on the adjustment's state.
Gets the action icon image for this adjustment.
The parameter name identifying which variation of the action to display, or null if this action has
no parameters.
The size of the image to generate.
A representing the adjustment's icon, or null if no custom image is provided.
Override this method to provide dynamic images that change based on the adjustment's state.
Gets the current value of the adjustment.
The parameter name identifying which variation of the action to get, or null if this action has no
parameters.
The adjustment value.
Override this method to return a string representation of the adjustment's current value. This value can be
displayed on the device and in the user interface.
protected override String GetAdjustmentValue(String actionParameter)
{
return this._counter.ToString();
}
Notifies the Logi Plugin Service that the adjustment value has changed.
The parameter name identifying which variation of the adjustment has changed, or null if this action
has no parameters.
The new adjustment value.
Call this method after updating the adjustment's value to refresh the display on the device and in the user
interface.
Notifies the Logi Plugin Service that the adjustment value has changed.
The new adjustment value.
Call this method after updating the adjustment's value to refresh the display on the device and in the user
interface.
Base class for dynamic commands.
Inherit this class to create a dynamic command for your plugin. Commands represent discrete actions such as
muting audio, starting a recording, or toggling a setting.
Minimal implementation requires overriding to handle command
execution. Optionally override or
to provide dynamic display names or action icons.
public class ToggleMuteCommand : PluginDynamicCommand
{
public ToggleMuteCommand()
: base(displayName: "Toggle Mute", description: "Mutes and unmutes system volume", groupName: "Audio")
{
}
protected override void RunCommand(String actionParameter)
{
this.Plugin.ClientApplication.SendKeyboardShortcut(VirtualKeyCode.VolumeMute);
}
}
Initializes a new instance of the class.
The device types supported by this command. Set to to support all devices, or
combine specific device types using bitwise OR.
Use this constructor when the display name, description, or group name are not known at construction time.
Initializes a new instance of the class with display name and group name.
The display name shown for this command in the user interface.
A brief explanation of what this command does.
The group name used to organize this command in the user interface.
The device types supported by this command. Set to to support all devices, or
combine specific device types using bitwise OR.
Use this constructor when the display name, description, and group name are known at construction time.
Base class for plugins.
Inherit this class to create a plugin. Override and for initialization
and cleanup. Set to define whether this is an Application or Universal plugin.
Gets the target application instance that this plugin controls.
Use this property to interact with application-specific functionality such as sending keyboard shortcuts,
checking application state, or accessing application-specific APIs.
Gets the unique identifier for this plugin.
The plugin name is derived from the class name with "Plugin" suffix removed. This name is used to identify
the plugin throughout the system.
Gets the plugin metadata displayed in the host application.
Contains information such as display name, description, author, version, homepage, and icons. This
information is shown to users in the plugin management interface.
Occurs when the plugin's current mode or submode changes.
Subscribe to this event to be notified when users switch between modes or submodes. The event provides the
new mode and submode in the event arguments.
Gets or sets the device types supported by this plugin.
Use this property to restrict which devices can use this plugin. Set to to
support all devices, or combine specific device types using bitwise OR.
Gets a value indicating whether this is a Universal plugin or an Application plugin.
Override this property to return true for Universal plugins that provide general-purpose functionality
and don't require a specific application to be in the foreground. Return false (default) for
Application plugins that integrate with a specific application and require it to be active.
Gets a value indicating whether this plugin uses only application-specific APIs rather than keyboard shortcuts.
Override this property to return true if your plugin controls the target application exclusively
through its API and does not send keyboard shortcuts. This allows the plugin to function even when the
application is not in the foreground. Return false (default) if your plugin sends keyboard shortcuts,
which require the application to be active.
Gets the logging interface for writing diagnostic messages and errors.
Called to perform plugin-specific installation setup.
true if installation succeeded; otherwise, false.
Override this method to perform custom installation tasks beyond the default installation handled by the Logi
Plugin Service. This method runs with normal user permissions.
Called to perform plugin-specific uninstallation cleanup.
true if uninstallation succeeded; otherwise, false.
Override this method to perform custom cleanup tasks beyond the default uninstallation handled by the Logi
Plugin Service. This method runs with normal user permissions.
Called during plugin installation for tasks that require administrator permissions.
true if installation succeeded; otherwise, false.
Override this method to include installation tasks that require administrator permissions. Standard
installation tasks should be performed in instead.
Called during plugin uninstallation for tasks that require administrator permissions.
true if uninstallation succeeded; otherwise, false.
Override this method to include uninstallation tasks that require administrator permissions. Standard
uninstallation tasks should be performed in instead.
Determines whether the plugin can be loaded.
true if the plugin can be loaded; otherwise, false.
Override this method to prevent plugin loading under specific conditions.
Called when the Logi Plugin Service loads the plugin.
Override this method to perform plugin initialization such as registering event handlers, starting background
tasks, or connecting to external services.
Called when the Logi Plugin Service unloads the plugin.
Override this method to perform cleanup such as unregistering event handlers, stopping background tasks, or
disconnecting from external services.
Checks whether the target application is currently running.
true if the application process is running; otherwise, false.
Checks whether the target application is currently active (has foreground focus).
true if the application is in the foreground; otherwise, false.
Checks whether the target application is installed on the system.
true if the application is installed; otherwise, false.
Called when the Logi Plugin Service requests a mode change.
The name of the mode to activate.
true if the mode change was handled successfully; otherwise, false.
Override this method if your plugin can programmatically change the target application's mode or state.
Return true if the mode change was applied, or false if the plugin does not support
programmatic mode changes.
Adds a mode to the plugin's mode collection.
The mode instance to register with the plugin.
Use this method to dynamically add modes at runtime. The mode name must be unique within the plugin.
Removes a mode from the plugin's mode collection.
The mode instance to unregister from the plugin.
Retrieves a mode by name.
The name of the mode to retrieve.
The mode with the specified name, or null if not found.
Retrieves a submode by parent mode name and submode name.
The name of the parent mode.
The name of the submode to retrieve.
The submode with the specified name, or null if not found.
Gets the directory path for plugin-specific data storage.
The absolute path to the plugin's data directory.
Use this directory to store plugin data files that need to persist between sessions. The directory is
created automatically if it does not exist.
Gets or sets the display name of an adjustment reset command.
Gets or sets the group name of an adjustment reset command.