HTML Widget Plugins

Widget API Version 1.4.0

HTML widget plugins extend iCUE widget functionality, and are registered using the required_plugins property in manifest.json.

Supported Plugins

Plugin	Module name	Plugin name	Version	Description
Sensors Data Provider	widgetbuilder.sensorsdataprovider	Sensors	1.0	Sensor data from connected devices
Media Data Provider	widgetbuilder.mediadataprovider	Media	1.0	Media playback control
Link Provider	widgetbuilder.linkprovider	Url	1.0	Open links in the system browser
Stream Deck	widgetbuilder.streamdeck	StreamDeck	1.0	Stream Deck integration
FPS Data Provider	widgetbuilder.fpsdataprovider	Fps	1.0	FPS data and current process name
Device Action Provider	widgetbuilder.deviceactionprovider	DeviceAction	1.0	Dial and key action events from the device

Plugins are declared in the manifest.json file in the "required_plugins" section.

Single plugin:

manifest.json

"required_plugins": [
    "widgetbuilder.sensorsdataprovider:Sensors:1.0"
]

Multiple plugins:

manifest.json

"required_plugins": [
    "widgetbuilder.sensorsdataprovider:Sensors:1.0",
    "widgetbuilder.mediadataprovider:Media:1.0"
]

Boolean variable indicating plugin load status: plugin<<module_name>>_initialized

Examples:

plugin<<module_name>>Events = {
    "onInitialized": <<callback_function>>
};

Sensors plugin example:

pluginSensorsdataproviderEvents = {
	onInitialized: onSensorsdataproviderInitialized,
};

Media plugin example:

pluginMediadataproviderEvents = {
	onInitialized: onMediadataproviderInitialized,
};

Link plugin example:

pluginLinkproviderEvents = {
	onInitialized: onLinkproviderInitialized,
};

FPS plugin example:

pluginFpsdataproviderEvents = {
	onInitialized: onFpsdataproviderInitialized,
};

Device Action Provider example:

pluginDeviceactionproviderEvents = {
	onInitialized: onDeviceactionproviderInitialized,
};

Access plugins via window.plugins.<<module_name>>:

Each plugin has its own interface documented in the plugin-specific documentation.