Space Plugin SDK

https://sdk.key123.vip/en/guide/overview.html
Admin
The Space Plugin SDK enables developers to create custom actions and plugins to extend the...
Tokens:9,383
Snippets:70
Trust Score:5.8
Update:1 year ago
Show doc for...
Tokens:
Raw
### Clone Stream Dock Plugin Template

Source: https://sdk.key123.vip/en/guide/overview.html/get-started

This command clones the Stream Dock Plugin SDK repository from GitHub, providing the necessary template files to begin developing a new plugin. It's the quickest way to set up your development environment.

```bash
git clone git@github.com:MiraboxSpace/StreamDock-Plugin-SDK.git
```

--------------------------------

### Stream Dock Debugging URL

Source: https://sdk.key123.vip/en/guide/overview.html/get-started

This URL provides access to the Stream Dock's debugging interface in a web browser, allowing developers to monitor and interact with their plugins during development. It's essential for troubleshooting and testing.

```plaintext
http://localhost:23519/
```

--------------------------------

### Vue.js Property Inspector Script Setup

Source: https://sdk.key123.vip/en/guide/overview.html/property-inspector

This snippet demonstrates the foundational script setup for a Vue 3-based Property Inspector. It imports essential hooks like `usePropertyStore`, `useWatchEvent`, and `useI18nStore` for managing plugin properties, handling events, and internationalization. It also outlines the structure for `didReceiveSettings` and `sendToPropertyInspector` event handlers.

```Vue
<script setup lang="ts">
  import { usePropertyStore, useWatchEvent, TabView } from '@/hooks/property';
  import { useI18nStore } from '@/hooks/i18n';

  const i18n = useI18nStore();
  const property = usePropertyStore();
  useWatchEvent({
    didReceiveSettings(data) {},
    sendToPropertyInspector(data) {}
  });
</script>

<template>
</template>

<style lang="scss" scoped></style>
```

--------------------------------

### Example JSON for applicationDidLaunch Event

Source: https://sdk.key123.vip/en/guide/overview.html/events-received

Illustrates the JSON structure of the `applicationDidLaunch` event received by a plugin when a monitored application starts.

```json
{
    "event": "applicationDidLaunch",
    "payload" : {
        "application": "com.apple.mail"
    }
}
```

--------------------------------

### Example JSON for systemDidWakeUp Event

Source: https://sdk.key123.vip/en/guide/overview.html/events-received

Illustrates the JSON structure of the `systemDidWakeUp` event received by a plugin when the computer resumes from sleep.

```json
{
 "event": "systemDidWakeUp"
}
```

--------------------------------

### Example `en.json` for Manifest Localization

Source: https://sdk.key123.vip/en/guide/overview.html/i18n

This JSON snippet illustrates the structure for `en.json` used to internationalize various strings within the plugin's manifest. It includes localized values for the plugin's description, name, category, action-specific details (name, tooltip), and general localization keys.

```JSON
{
  "Description": "Test",
  "Name": "Test",
  "Category": "Test",
  "com.mirabox.demo.action1": {
    "Name": "Test",
    "Tooltip": "Test"
  },
  "Localization": {
    "test": "Test"
  }
}
```

--------------------------------

### sendToPlugin Event Structure and API Reference

Source: https://sdk.key123.vip/en/guide/overview.html/events-sent

Defines the JSON structure and parameters for the 'sendToPlugin' event, used by the Property Inspector to send data to the plugin. Includes examples for both sending and receiving the event.

```JSON
{
    "action": "com.mirabox.demo.action1",
    "event": "sendToPlugin",
    "context": uniqueValue,
    "payload": {<json data>}
}
```

```APIDOC
Event Members:
  action: Unique identifier for the action
  event: sendToPlugin
  context: The value is the property inspector's inPropertyInspectorUUID
  payload: JSON object
```

```JSON
{
  "action": "com.mirabox.demo.action1",
  "event": "sendToPlugin",
  "context": uniqueValue,
  "payload": {<json data>}
}
```

--------------------------------

### Example JSON for sendToPlugin Event

Source: https://sdk.key123.vip/en/guide/overview.html/events-received

Illustrates the JSON structure of the `sendToPlugin` event, used by the property inspector to send data to the plugin.

```json
{
    "action": "com.mirabox.demo.action1",
    "event": "sendToPlugin",
    "context": uniqueValue,
    "payload": {<json data>}
}
```

--------------------------------

### Vue.js Property Inspector Template with Two-Way Binding

Source: https://sdk.key123.vip/en/guide/overview.html/property-inspector

This Vue.js snippet provides a complete example of a Property Inspector component, combining the script setup with a template. It showcases how to use `v-model` for two-way data binding with `property.settings.text`, allowing direct manipulation and automatic persistence of settings without additional manual operations.

```Vue
<script setup lang="ts">
  import { usePropertyStore, useWatchEvent, TabView } from '@/hooks/property';
  import { useI18nStore } from '@/hooks/i18n';

  const i18n = useI18nStore();
  const property = usePropertyStore();
  useWatchEvent({
    didReceiveSettings(data) {},
    sendToPropertyInspector(data) {}
  });
</script>

<template>
  <TabView :title="i18n.title">
    <input type="text" v-model="property.settings.text">
  </TabView>
</template>

<style lang="scss" scoped></style>
```

--------------------------------

### Example JSON for propertyInspectorDidAppear Event

Source: https://sdk.key123.vip/en/guide/overview.html/events-received

Illustrates the JSON structure of the `propertyInspectorDidAppear` event, indicating when the property inspector becomes visible.

```json
{
  "action": "com.mirabox.demo.action1",
  "event": "propertyInspectorDidAppear",
  "context": uniqueValue,
  "device": uniqueValue
}
```

--------------------------------

### Handle Plugin Will Appear Event

Source: https://sdk.key123.vip/en/guide/overview.html/events-received

Documents the JSON structure received by a plugin when an action instance appears on the Stream Dock. This includes scenarios like application start, profile switching, or setting a key. It details the action, event type, context, device, and payload, including settings, coordinates, controller type, state, and multi-action status.

```JSON
{
    "action": "com.mirabox.demo.action1",
    "event": "willAppear",
    "context": uniqueValue,
    "device": uniqueValue,
    "payload": {
        "settings": {<json data>},
        "coordinates": {
            "column": 3,
            "row": 1
        },
        "controller": "Keypad",
        "state": 0,
        "isInMultiAction": false
    }
}
```

```APIDOC
Event Members:
  action: Unique identifier for the action. If your plugin supports multiple actions, use this value to determine which action was triggered
  event: willAppear
  context: Value that identifies the instance action
  device: Value used to identify the device
  payload: A JSON object
```

```APIDOC
Payload Members:
  settings: This JSON object contains the persistent storage data
  coordinates: Coordinates of the triggered action
  controller: Keypad (normal buttons), Information (view-only, no touch or button events), SecondaryScreen (small screen display), Knob (rotary control)
  state: Set only if the action has multiple states defined in its manifest.json. The value starting from 0 represents the current state of the action
  isInMultiAction: Boolean value indicating whether the action is within a Multi-Action
```

--------------------------------

### Example JSON for applicationDidTerminate Event

Source: https://sdk.key123.vip/en/guide/overview.html/events-received

Illustrates the JSON structure of the `applicationDidTerminate` event received by a plugin when a monitored application closes.

```json
{
    "event": "applicationDidTerminate",
    "payload" : {
        "application": "com.apple.mail"
    }
}
```

--------------------------------

### Example JSON for sendToPropertyInspector Event

Source: https://sdk.key123.vip/en/guide/overview.html/events-received

Illustrates the JSON structure of the `sendToPropertyInspector` event, used by the plugin to send data to the property inspector.

```json
{
    "action": "com.mirabox.demo.action1",
    "event": "sendToPropertyInspector",
    "context": uniqueValue,
    "payload": {<json data>}
}
```

--------------------------------

### sendToPropertyInspector Event Structure and API Reference

Source: https://sdk.key123.vip/en/guide/overview.html/events-sent

Defines the JSON structure and parameters for the 'sendToPropertyInspector' event, used by plugins to send data to the Property Inspector. Includes examples for both sending and receiving the event.

```JSON
{
    "action": "com.mirabox.demo.action1",
    "event": "sendToPropertyInspector",
    "context": uniqueValue,
    "payload": {<json data>}
}
```

```APIDOC
Event Members:
  action: Unique identifier for the action
  event: sendToPropertyInspector
  context: Identifier for the action instance
  payload: JSON object
```

```JSON
{
  "action": "com.mirabox.demo.action1",
  "event": "sendToPropertyInspector",
  "context": uniqueValue,
  "payload": {<json data>}
}
```

--------------------------------

### Example JSON for propertyInspectorDidDisappear Event

Source: https://sdk.key123.vip/en/guide/overview.html/events-received

Illustrates the JSON structure of the `propertyInspectorDidDisappear` event, indicating when the property inspector is no longer visible.

```json
{
    "action": "com.mirabox.demo.action1",
    "event": "propertyInspectorDidDisappear",
    "context": uniqueValue,
    "device": uniqueValue
}
```

--------------------------------

### Vue.js Template Example with Internationalization

Source: https://sdk.key123.vip/en/guide/overview.html/i18n

This Vue.js template demonstrates how to integrate and use the `useI18nStore` hook within a component to display internationalized text. It imports the necessary hooks and accesses localized strings directly in the template using `i18n.test`.

```Vue
<script setup lang="ts">
  import { usePropertyStore, useWatchEvent } from '@/hooks/property';
  import { useI18nStore } from '@/hooks/i18n';

  const i18n = useI18nStore();
  const property = usePropertyStore();
  useWatchEvent({
    didReceiveSettings(data) {},
    sendToPropertyInspector(data) {}
  });
</script>

<template>
  <div>{{ i18n.test }}</div>
</template>
```

--------------------------------

### Establish WebSocket Connection to Stream Dock

Source: https://sdk.key123.vip/en/guide/overview.html/registration

Illustrates how to create a WebSocket connection to the Stream Dock application. This connection uses the `inPort` parameter provided to the plugin's entry point function, enabling real-time communication.

```JavaScript
const server = new WebSocket('ws://127.0.0.1:' + inPort);
```

--------------------------------

### Command-Line Parameters for Compiled Executable Plugins

Source: https://sdk.key123.vip/en/guide/overview.html/registration

Documents the command-line arguments that Stream Dock passes to compiled executable plugins (.exe files) upon launch. These parameters are essential for the executable to establish communication and register itself with the Stream Dock application.

```APIDOC
Parameter Reference for Compiled Executables:
-port:
  Description: The string "-port"
-port <value>:
  Description: The port number used for connecting to the WebSocket.
-pluginUUID:
  Description: The string "-pluginUUID"
-pluginUUID <value>:
  Description: A unique identifier string used to register the plugin after opening the WebSocket.
-registerEvent:
  Description: The string "-registerEvent"
-registerEvent <value>:
  Description: The event type applied to register the plugin after opening the WebSocket.
-info:
  Description: The string "-info"
-info <value>:
  Description: A JSON string containing Stream Dock and device information.
```

--------------------------------

### JavaScript Plugin Entry Point Function

Source: https://sdk.key123.vip/en/guide/overview.html/registration

Defines the `connectElgatoStreamDeckSocket` function, which serves as the primary entry point for JavaScript plugins. This function is called by the Stream Dock application upon plugin loading and provides necessary connection parameters for establishing communication.

```JavaScript
// To ensure compatibility with Elgato,
// we use the same function names as theirs,
// so your developed plugin can be compatible with Elgato software.
function connectElgatoStreamDeckSocket(
    inPort,
    inPluginUUID,
    inRegisterEvent,
    inInfo
)
```

--------------------------------

### Handle Incoming WebSocket Messages

Source: https://sdk.key123.vip/en/guide/overview.html/registration

Shows how to set up an event listener to receive and process messages sent from the Stream Dock application to the plugin via the WebSocket connection. This is essential for the plugin to react to events and commands from Stream Dock.

```JavaScript
server.onmessage = (e) => (
    console.log(e.data);
);
```

--------------------------------

### Create WebSocket Connection for Property Inspector

Source: https://sdk.key123.vip/en/guide/overview.html/registration

This code snippet demonstrates how to establish a WebSocket connection from the Property Inspector to the Stream Deck software using the provided `inPort` parameter. This connection is fundamental for all subsequent communication.

```JavaScript
const server = new WebSocket('ws://127.0.0.1:' + inPort);
```

--------------------------------

### Property Inspector Info JSON Structure

Source: https://sdk.key123.vip/en/guide/overview.html/registration

This API documentation details the structure of the `inInfo` JSON object, which provides comprehensive information about the Stream Deck application, connected devices, and the plugin itself. It includes application details, color schemes, device pixel ratio, and an array of connected devices.

```APIDOC
{
    "application":{
        "font":"HarmonyOS Sans",
        "language":"zh_CN",
        "platform":"windows",
        "platformVersion":"10.0.19045",
        "version":"4.9"
    },
    "colors":{
        "buttonMouseOverBackgroundColor":"#464646FF",
        "buttonPressedBackgroundColor":"#303030FF",
        "buttonPressedBorderColor":"#646464FF",
        "buttonPressedTextColor":"#969696FF",
        "highlightColor":"#0078FFFF"
    },
    "devicePixelRatio":1,
    "devices":[
        {
            "id": "55F16B35884A859CCE4FFA1FC8D3DE5B",
            "name": "Device Name",
            "size": {
                "columns": 5,
                "rows": 3
            },
            "type": 0
            },
            {
            "id": "B8F04425B95855CF417199BCB97CD2BB",
            "name": "Another Device",
            "size": {
                "columns": 3,
                "rows": 2
            },
            "type": 1
        }
    ],
    "plugin":{
        "uuid":"com.mirabox.demo",
        "version":"1.8"
    }
}
```

--------------------------------

### Application Object Structure within Info JSON

Source: https://sdk.key123.vip/en/guide/overview.html/registration

This section describes the `application` object, a sub-component of the `inInfo` JSON. It provides details about the Stream Deck application's environment, including its language, operating platform, platform version, and application version.

```APIDOC
application:
  language: string - The language of the application (e.g., "zh_CN")
  platform: string - The platform on which the application is running (e.g., "windows")
  platformVersion: string - The version of the platform (e.g., "10.0.19045")
  version: string - The version of the application (e.g., "4.9")
```

--------------------------------

### Property Inspector Action Info JSON Structure

Source: https://sdk.key123.vip/en/guide/overview.html/registration

This API documentation specifies the structure of the `inActionInfo` JSON string. This object provides context-specific information about the action that triggered the Property Inspector, including the action's identifier, a unique context value, the device ID, and a payload containing settings and coordinate data.

```APIDOC
{
  "action": "com.mirabox.demo.action1",
  "context": "uniqueValue",
  "device": "uniqueValue",
  "payload": {
    "settings": {<JSON data>},
    "controller": "Keypad" | "Encoder",
    "coordinates": {
      "column": 2,
      "row": 1
    }
  }
}
```

--------------------------------

### Payload Object Structure Definition

Source: https://sdk.key123.vip/en/guide/overview.html/registration

Defines the structure and properties of the `payload` object. It includes `settings` for persistent data storage, `controller` to specify the input device type (e.g., Keypad, Knob), and `coordinates` for action location.

```APIDOC
Payload Object:
  members:
    - name: settings
      description: A JSON object containing persistently stored data
      type: JSON object
    - name: controller
      description: An array of controllers. Valid values include `Keypad`, `Information`, `SecondaryScreen`, `Knob`. `Keypad` is for regular keys, `Information` is for display only without touch or key events, `SecondaryScreen` is for small screen display, and `Knob` is for the rotary knob.
      type: array of strings
      default: ["Keypad"]
    - name: coordinates
      description: The coordinates of the triggered action
      type: any
```

--------------------------------

### getSettings Event Parameters

Source: https://sdk.key123.vip/en/guide/overview.html/events-sent

Details of the members required for the `getSettings` event payload.

```APIDOC
Member: event
  Description: getSettings
Member: context
  Description: If the plugin calls this, the value is the plugin's [inPluginUUID](/en/guide/registration.html#javascript-plugin-registration), if the property inspector calls this, the value is the property inspector's [inPropertyInspectorUUID](/en/guide/registration.html#propertyinspector-registration)
```

--------------------------------

### Configure Plugin to Monitor Applications

Source: https://sdk.key123.vip/en/guide/overview.html/events-received

Demonstrates how to configure a plugin's `manifest.json` to monitor application launches and terminations on macOS (using bundle identifiers) and Windows (using exe file names).

```json
"ApplicationsToMonitor": {
 "mac": [
  "com.apple.mail"
 ]
}
```

--------------------------------

### Devices Array Structure within Info JSON

Source: https://sdk.key123.vip/en/guide/overview.html/registration

This section describes the `devices` array, a component of the `inInfo` JSON. Each element in this array represents a connected Stream Deck device, providing its unique ID, name, physical size (columns and rows), and type.

```APIDOC
devices[]:
  id: string - The unique identifier of the device (e.g., "55F16B35884A859CCE4FFA1FC8D3DE5B")
  name: string - The name of the device (e.g., "Device Name")
  size: object - The size of the device in terms of columns and rows
    columns: number - Number of columns on the device
    rows: number - Number of rows on the device
  type: number - The type of the device (e.g., 0 for Stream Deck, 1 for Stream Deck Mini)
```

--------------------------------

### Send Plugin Registration Event via WebSocket

Source: https://sdk.key123.vip/en/guide/overview.html/registration

Demonstrates how to send the required registration event to the Stream Dock application once the WebSocket connection is successfully established. This step is crucial for the plugin to be recognized and integrated by Stream Dock.

```JavaScript
server.onopen = () => server.send(
    JSON.stringify({ event: inRegisterEvent, uuid: inPluginUUID });
);
```

--------------------------------

### showOk Event Structure and API Reference

Source: https://sdk.key123.vip/en/guide/overview.html/events-sent

Defines the JSON structure and parameters for the 'showOk' event, used by plugins to display a temporary OK checkmark icon on an action instance.

```JSON
{
    "event": "showOk",
    "context": uniqueValue
}
```

```APIDOC
Event Members:
  event: showOk
  context: Identifier for the action instance
```

--------------------------------

### Plugin Object Structure within Info JSON

Source: https://sdk.key123.vip/en/guide/overview.html/registration

This section details the `plugin` object, found within the `inInfo` JSON. It contains identifying information for the plugin itself, specifically its unique identifier (UUID) and version number.

```APIDOC
plugin:
  uuid: string - The unique identifier of the plugin (e.g., "com.mirabox.demo")
  version: string - The version of the plugin (e.g., "1.8")
```

--------------------------------

### API Reference for applicationDidLaunch Event

Source: https://sdk.key123.vip/en/guide/overview.html/events-received

Detailed documentation for the `applicationDidLaunch` event, outlining its members and the structure of its payload.

```APIDOC
event: applicationDidLaunch
payload: A JSON object
  application: The identifier of the launched application
```

--------------------------------

### API Reference for systemDidWakeUp Event

Source: https://sdk.key123.vip/en/guide/overview.html/events-received

Detailed documentation for the `systemDidWakeUp` event, outlining its members.

```APIDOC
event: systemDidWakeUp
```

--------------------------------

### setSettings Event Parameters

Source: https://sdk.key123.vip/en/guide/overview.html/events-sent

Details of the members required for the `setSettings` event payload.

```APIDOC
Member: event
  Description: setSettings
Member: context
  Description: If it is a plugin call, the value is the `context` of the plugin `action`, if the property inspector calls this, the value is the property inspector's [inPropertyInspectorUUID](/en/guide/registration.html#propertyinspector-registration)
Member: payload
  Description: Data sent by the plugin or Property Inspector
```

--------------------------------

### Declare Property Inspector Connection Function

Source: https://sdk.key123.vip/en/guide/overview.html/registration

This JavaScript function is the entry point for the Property Inspector, called by the Stream Deck software upon display. It provides necessary parameters for establishing WebSocket communication and registering the Property Inspector. Its naming convention ensures compatibility with Elgato's existing software.

```JavaScript
function connectElgatoStreamDeckSocket(
    inPort,
    inPropertyInspectorUUID,
    inRegisterEvent,
    inInfo,
    inActionInfo
)
```

--------------------------------

### Handle Incoming WebSocket Messages for Property Inspector

Source: https://sdk.key123.vip/en/guide/overview.html/registration

Once registered, the Property Inspector receives events and data from the Stream Deck software via the WebSocket. This snippet illustrates a basic `onmessage` event handler to process incoming data, typically JSON messages, from the Stream Deck application.

```JavaScript
server.onmessage = (e) => (
    console.log(e.data);
);
```

--------------------------------

### Handle didReceiveSettings Callback Event

Source: https://sdk.key123.vip/en/guide/overview.html/events-sent

This event is asynchronously received by a plugin or Property Inspector, typically after a `getSettings` or `setSettings` call. It contains the action's identifier, context, device, and the `payload` with the actual settings data, along with coordinate and multi-action status.

```JSON
{
  "action": "com.mirabox.demo.action1",
  "event": "didReceiveSettings",
  "context": uniqueValue,
  "device": uniqueValue,
  "payload": {
   "settings": {<json data>},
    "coordinates": {
      "column": 3,
      "row": 1
    },
    "isInMultiAction": false
  }
}
```

--------------------------------

### Send getSettings Event to Request Action Instance Data

Source: https://sdk.key123.vip/en/guide/overview.html/events-sent

Plugins and Property Inspectors use this event to request persistent data previously stored for an action instance. The `context` identifies the action instance for which settings are requested. Upon sending this event, the plugin or Property Inspector will asynchronously receive a `didReceiveSettings` event containing the requested data.

```JSON
{
    "event": "getSettings",
    "context": uniqueValue
}
```

--------------------------------

### Register Property Inspector on WebSocket Open

Source: https://sdk.key123.vip/en/guide/overview.html/registration

After the WebSocket connection is successfully opened, the Property Inspector must register itself with the Stream Deck software. This snippet shows how to send a JSON message containing the registration event and the Property Inspector's UUID via the WebSocket's `onopen` event handler.

```JavaScript
server.onopen = () => server.send(
    JSON.stringify({ event: inRegisterEvent, uuid: inPropertyInspectorUUID });
);
```

--------------------------------

### Open URL in Default Browser

Source: https://sdk.key123.vip/en/guide/overview.html/events-sent

This API enables plugins or property inspectors to programmatically open a specified URL in the user's default web browser. It provides a convenient way to direct users to external resources or documentation.

```json
{
    "event": "openUrl",
    "payload": {
        "url": "https://www.example.com"
    }
}
```

```APIDOC
openUrl:
  description: "API to open a URL in the default browser."
  parameters:
    event: "openUrl"
    payload:
      type: "JSON object"
      members:
        url: "The URL to open"
```

--------------------------------

### JavaScript Localization for Property Inspector

Source: https://sdk.key123.vip/en/guide/overview.html/i18n

This JavaScript code demonstrates how to automatically localize strings within a standard JS template for the Property Inspector. It fetches the appropriate language file based on the application's language, parses the 'Localization' section, and then iterates through text nodes and placeholders to replace them with their localized equivalents.

```JavaScript
 if (!$local) return;
    $lang = await new Promise(resolve => {
        const req = new XMLHttpRequest();
        req.open('GET', `../../${JSON.parse(app).application.language}.json`);
        req.send();
        req.onreadystatechange = () => {
            if (req.readyState === 4) {
                resolve(JSON.parse(req.responseText).Localization);
            }
        };
    });

    const walker = document.createTreeWalker($dom.main, NodeFilter.SHOW_TEXT, (e) => {
        return e.data.trim() && NodeFilter.FILTER_ACCEPT;
    });
    while (walker.nextNode()) {
        console.log(walker.currentNode.data);
        walker.currentNode.data = $lang[walker.currentNode.data];
    }
    // placeholder
    const translate = item => {
        if (item.placeholder?.trim()) {
            console.log(item.placeholder);
            item.placeholder = $lang[item.placeholder];
        }
    };
    $('input', true).forEach(translate);
    $('textarea', true).forEach(translate);
```

--------------------------------

### Retrieve Global Persistent Settings and Callback

Source: https://sdk.key123.vip/en/guide/overview.html/events-sent

This API allows plugins and property inspectors to request globally stored persistent data. Upon request, the SDK asynchronously sends a `didReceiveGlobalSettings` event containing the requested global settings. This ensures data consistency between plugin and property inspector components.

```json
{
    "event": "getGlobalSettings",
    "context": uniqueValue
}
```

```APIDOC
getGlobalSettings:
  description: "API to request globally stored persistent data."
  parameters:
    event: "getGlobalSettings"
    context: "If the plugin calls this, the value is the plugin's inPluginUUID, if the property inspector calls this, the value is the property inspector's inPropertyInspectorUUID"
```

```json
{
  "event": "didReceiveGlobalSettings",
  "payload": {
     "settings": {<json data>}
   }
}
```

```APIDOC
didReceiveGlobalSettings:
  description: "Asynchronous callback event containing global settings, received after a getGlobalSettings request."
  payload:
    settings: "The global settings data (JSON object)"
```

--------------------------------

### API Reference for propertyInspectorDidAppear Event

Source: https://sdk.key123.vip/en/guide/overview.html/events-received

Detailed documentation for the `propertyInspectorDidAppear` event, outlining its action, context, and device members.

```APIDOC
action: The unique identifier for the action. Use this value to determine which action triggered the event if your plugin supports multiple actions.
event: propertyInspectorDidAppear
context: Identifier for the instance action
device: Identifier for the device
```

--------------------------------

### setImage Event Structure and API Reference

Source: https://sdk.key123.vip/en/guide/overview.html/events-sent

Defines the JSON structure and parameters for the 'setImage' event, used by plugins to dynamically change an action's image. Includes details on image formats (base64, SVG) and options for target display and state.

```JSON
{
    "event": "setImage",
    "context": uniqueValue,
    "payload": {
        "image": <base64 encoded image>,
        "target": software, hardware or both,
        "state": 0-based integer
    }
}
```

```APIDOC
Event Members:
  event: setImage
  context: Identifier for the action instance
  payload: JSON object

Payload Members:
  image: The base64-encoded image to set
  target: Specifies whether the image should be displayed on hardware and software (0), only on hardware (1), only on software (2), default is 0
  state: An integer value starting from 0, representing the state of an action with multiple states. If not specified, the image will be set for all states
```

```JSON
"data:image/png;base64,avFOdwp0Ksgoe..."
"data:image/jpg;base64,avFOdwp0Ksgoe..."
"data:image/gif;base64,avFOdwp0Ksgoe..."
```

```JSON
{
    "event": "setImage",
    "context": context,
    "payload": {
        "image": "data:image/svg+xml;charset=utf8,<svg></svg>",
        "target": 0
    }
}
```

--------------------------------

### API Reference for applicationDidTerminate Event

Source: https://sdk.key123.vip/en/guide/overview.html/events-received

Detailed documentation for the `applicationDidTerminate` event, outlining its members and the structure of its payload. Note: The source documentation incorrectly lists 'applicationDidLaunch' for the event member.

```APIDOC
event: applicationDidLaunch
payload: A JSON object
  application: The identifier of the terminated application
```

--------------------------------

### showAlert Event Structure and API Reference

Source: https://sdk.key123.vip/en/guide/overview.html/events-sent

Defines the JSON structure and parameters for the 'showAlert' event, used by plugins to display a temporary alert icon on an action instance.

```JSON
{
    "event": "showAlert",
    "context": uniqueValue
}
```

```APIDOC
Event Members:
  event: showAlert
  context: Identifier for the action instance
```

--------------------------------

### Handle Plugin Key Up Event

Source: https://sdk.key123.vip/en/guide/overview.html/events-received

Documents the JSON structure received by a plugin when a user releases a key. It details the action, event type, context, device, and payload, including settings, coordinates, state, and multi-action status.

```JSON
{
  "action": "com.mirabox.demo.action2",
  "event": "keyUp",
  "context": uniqueValue,
  "device": uniqueValue,
  "payload": {
    "settings": {<json data>},
    "coordinates": {
      "column": 0,
      "row": 0
    },
    "state": 0,
    "isInMultiAction": false
  }
}
```

```APIDOC
Event Members:
  action: Unique identifier for the action. If your plugin supports multiple actions, use this value to determine which action was triggered
  event: keyUp
  context: Value that identifies the instance action
  device: Value used to identify the device
  payload: A JSON object
```

```APIDOC
Payload Members:
  settings: This JSON object contains the persistent storage data
  coordinates: Coordinates of the triggered action
  state: Set only if the action has multiple states defined in its manifest.json. The value starting from 0 represents the current state of the action
  isInMultiAction: Boolean value indicating whether the action is within a Multi-Action
```

--------------------------------

### API Reference for propertyInspectorDidDisappear Event

Source: https://sdk.key123.vip/en/guide/overview.html/events-received

Detailed documentation for the `propertyInspectorDidDisappear` event, outlining its action, context, and device members.

```APIDOC
action: The unique identifier for the action. Use this value to determine which action triggered the event if your plugin supports multiple actions.
event: propertyInspectorDidDisappear
context: Identifier for the instance action
device: Identifier for the device
```

--------------------------------

### Handle didReceiveGlobalSettings Event

Source: https://sdk.key123.vip/en/guide/overview.html/events-received

Documents the JSON payload structure for the `didReceiveGlobalSettings` event, triggered when global plugin settings change. It details the event and its payload, specifically the settings object.

```JSON
{
  "event": "didReceiveGlobalSettings",
  "payload": {
   "settings": {<json data>}
  }
}
```

```APIDOC
didReceiveGlobalSettings Event Payload:
  event: string - didReceiveGlobalSettings
  payload: object - A JSON object
    payload.settings: object - This JSON object contains the persistent storage data
```

--------------------------------

### Set Global Persistent Settings

Source: https://sdk.key123.vip/en/guide/overview.html/events-sent

This API allows plugins and property inspectors to save persistent data globally, making it accessible across all actions. It's useful for storing tokens or other shared configuration. When this API is used, the counterpart (plugin or property inspector) automatically receives a `didReceiveGlobalSettings` callback with the updated settings.

```json
{
    "event": "setGlobalSettings",
    "context": uniqueValue,
    "payload": {<json data>}
}
```

```APIDOC
setGlobalSettings:
  description: "API to save persistent data globally for plugins and property inspectors. When the plugin uses this API, the Property Inspector will automatically receive a didReceiveGlobalSettings callback with the new settings. Similarly, when the Property Inspector uses this API, the plugin will automatically receive a didReceiveGlobalSettings callback with the new settings."
  parameters:
    event: "setGlobalSettings"
    context: "If the plugin calls this, the value is the plugin's inPluginUUID, if the property inspector calls this, the value is the property inspector's inPropertyInspectorUUID"
    payload: "Data to be saved (JSON object)"
```

--------------------------------

### Handle didReceiveSettings Event

Source: https://sdk.key123.vip/en/guide/overview.html/events-received

Documents the JSON payload structure for the `didReceiveSettings` event, triggered when plugin settings change. It includes details on the action context, device, and payload contents like settings, coordinates, and multi-action status.

```JSON
{
  "action": "com.mirabox.demo.action1",
  "event": "didReceiveSettings",
  "context": "uniqueValue",
  "device": "uniqueValue",
  "payload": {
   "settings": {<json data>},
    "coordinates": {
      "column": 3,
      "row": 1
    },
    "isInMultiAction": false
  }
}
```

```APIDOC
didReceiveSettings Event Payload:
  action: string - Unique identifier for the action
  event: string - didReceiveSettings
  context: string - Value that identifies the instance action
  device: string - Value used to identify the device
  payload: object - A JSON object
    payload.settings: object - This JSON object contains the persistent storage data
    payload.coordinates: object - Coordinates of the triggered action
      payload.coordinates.column: number
      payload.coordinates.row: number
    payload.state: number - Set only if the action defines multiple states in its `manifest.json`. The value, starting from 0, contains the current state of the action
    payload.isInMultiAction: boolean - Boolean indicating whether the action is within a Multi-Action
```

--------------------------------

### Send setSettings Event to Save Action Instance Data

Source: https://sdk.key123.vip/en/guide/overview.html/events-sent

Plugins and Property Inspectors use this event to permanently save data associated with a specific action instance. The `context` identifies the action instance, and `payload` contains the JSON data to be saved. When this API is used, the other component (plugin or Property Inspector) automatically receives a `didReceiveSettings` callback with the new settings.

```JSON
{
    "event": "setSettings",
    "context": uniqueValue,
    "payload": {<json data>}
}
```

--------------------------------

### setState Event Structure and API Reference

Source: https://sdk.key123.vip/en/guide/overview.html/events-sent

Defines the JSON structure and parameters for the 'setState' event, used by plugins to dynamically change the state of an action instance.

```JSON
{
    "event": "setState",
    "context": uniqueValue,
    "payload": {
        state
    }
}
```

```APIDOC
Event Members:
  event: setState
  context: Identifier for the action instance
  payload: JSON object

Payload Members:
  state: An integer value starting from 0, representing the state of the action with multiple states
```

--------------------------------

### Dynamically Set Action Title

Source: https://sdk.key123.vip/en/guide/overview.html/events-sent

This API allows plugins to dynamically change the title displayed for an action instance. It supports setting titles for specific targets (hardware, software, or both) and for different states of a multi-state action, providing flexibility for UI customization.

```json
{
    "event": "setTitle",
    "context": uniqueValue,
    "payload": {
        "title": "MyTitle",
        "target": 0,
        "state": 0
    }
}
```

```APIDOC
setTitle:
  description: "API to dynamically change the title of an action instance."
  parameters:
    event: "setTitle"
    context: "Identifier for the action instance"
    payload:
      type: "JSON object"
      members:
        title: "The title to set"
        target: "Specifies whether the title should be displayed on hardware and software (0), only on hardware (1), only on software (2), default is 0"
        state: "An integer value starting from 0, representing the state of an action with multiple states. If not specified, the title will be set for all states"
```

--------------------------------

### Stream Dock Property Inspector Connection Function

Source: https://sdk.key123.vip/en/guide/overview.html/property-inspector

This JavaScript function, `connectElgatoStreamDeckSocket`, is crucial for establishing communication between the Property Inspector and the Stream Dock application. It takes several parameters including port, UUID, registration event, and information objects, which are essential for the plugin's interaction with the Stream Dock software and ensuring compatibility with Elgato.

```JavaScript
function connectElgatoStreamDeckSocket(
    inPort,
    inPropertyInspectorUUID,
    inRegisterEvent,
    inInfo,
    inActionInfo
);
```

--------------------------------

### Handle Plugin Key Down Event

Source: https://sdk.key123.vip/en/guide/overview.html/events-received

Documents the JSON structure received by a plugin when a user presses a key. It details the action, event type, context, device, and payload, including settings, coordinates, state, and multi-action status.

```JSON
{
  "action": "com.mirabox.demo.action2",
  "event": "keyDown",
  "context": uniqueValue,
  "device": uniqueValue,
  "payload": {
    "settings": {<json data>},
    "coordinates": {
      "column": 0,
      "row": 0
    },
    "state": 0,
    "isInMultiAction": false
  }
}
```

```APIDOC
Event Members:
  action: Unique identifier for the action. If your plugin supports multiple actions, use this value to determine which action was triggered
  event: keyDown
  context: Value that identifies the instance action
  device: Value used to identify the device
  payload: A JSON object
```

```APIDOC
Payload Members:
  settings: This JSON object contains the persistent storage data
  coordinates: Coordinates of the triggered action
  state: Set only if the action has multiple states defined in its manifest.json. The value starting from 0 represents the current state of the action
  isInMultiAction: Boolean value indicating whether the action is within a Multi-Action
```

--------------------------------

### Handle dialUp Event

Source: https://sdk.key123.vip/en/guide/overview.html/events-received

Documents the JSON payload structure for the `dialUp` event, triggered when a user releases a pressed knob. It includes details on the action context, device, and payload contents like controller type, settings, and coordinates.

```JSON
{
  "action": "com.mirabox.demo.action2",
  "event": "dialUp",
  "context": uniqueValue,
  "device": uniqueValue,
  "payload": {
    "controller": "Encoder",
    "settings": {<json data>},
    "coordinates": {
      "column": 0,
      "row": 0
    }
  }
}
```

```APIDOC
dialUp Event Payload:
  action: string - Unique identifier for the action. If your plugin supports multiple actions, use this value to determine which action was triggered
  event: string - dialUp
  context: string - Value that identifies the instance action
  device: string - Value used to identify the device
  payload: object - A JSON object
    payload.controller: string - Encoder
    payload.settings: object - This JSON object contains the persistent storage data
    payload.coordinates: object - Coordinates of the triggered action
      payload.coordinates.column: number
      payload.coordinates.row: number
```

--------------------------------

### Additional Events Sent by Property Inspectors

Source: https://sdk.key123.vip/en/guide/overview.html/events-sent

This section describes events that are specifically sent by Property Inspectors. Currently, this includes the event for sending data back to the associated plugin.

```APIDOC
Event: sendToPlugin
  Description: Send data to the plugin
```

--------------------------------

### Common Events Sent by Plugins and Property Inspectors

Source: https://sdk.key123.vip/en/guide/overview.html/events-sent

This section lists events that can be sent by both plugins and Property Inspectors to the Stream Dock application. These events facilitate core functionalities like saving and retrieving persistent data, opening URLs, and logging messages.

```APIDOC
Event: setSettings
  Description: Permanently save data for an action instance
Event: getSettings
  Description: Request persistent data for an action instance
Event: setGlobalSettings
  Description: Globally save plugin data
Event: getGlobalSettings
  Description: Request global persistent data
Event: openUrl
  Description: Open a URL in the default browser
Event: logMessage
  Description: Write a debug message to the log file
```

--------------------------------

### Additional Events Sent by Plugins

Source: https://sdk.key123.vip/en/guide/overview.html/events-sent

This section outlines events that are exclusively sent by plugins to the Stream Dock application. These events allow plugins to dynamically modify the appearance and state of action instances on the Stream Deck, such as changing titles, images, or showing alerts.

```APIDOC
Event: setTitle
  Description: Dynamically change the title of an action instance
Event: setImage
  Description: Dynamically change the image of an action instance
Event: showAlert
  Description: Temporarily show an alert icon on the action instance's image
Event: showOk
  Description: Temporarily show an "OK" checkmark icon on the action instance's image
Event: setState
  Description: Change the state of an action instance that supports multiple states
Event: sendToPropertyInspector
  Description: Send data to the Property Inspector
```

--------------------------------

### Vue.js Persistent Settings with Watcher

Source: https://sdk.key123.vip/en/guide/overview.html/property-inspector

This JavaScript snippet illustrates how to implement persistent data handling in a Vue.js Property Inspector. It uses Vue's `watch` function to monitor changes in settings and automatically sends these updates to the Stream Dock server, ensuring that user configurations are saved. The `preventWatch` ref is used to control when updates are sent.

```JavaScript
const preventWatch = ref(false);
const settings = ref(window.argv[4].payload.settings);
watch(
    settings,
    () => {
      if (preventWatch.value) return;
      server.send(
        JSON.stringify({
          event: 'setSettings',
          context: window.argv[1],
          payload: settings.value
        })
      );
    },
    { deep: true }
);
```

--------------------------------

### Handle dialDown Event

Source: https://sdk.key123.vip/en/guide/overview.html/events-received

Documents the JSON payload structure for the `dialDown` event, triggered when a user presses a knob. It includes details on the action context, device, and payload contents like controller type, settings, and coordinates.

```JSON
{
  "action": "com.mirabox.demo.action2",
  "event": "dialDown",
  "context": uniqueValue,
  "device": uniqueValue,
  "payload": {
    "controller": "Encoder",
    "settings": {<json data>},
    "coordinates": {
      "column": 0,
      "row": 0
    }
  }
}
```

```APIDOC
dialDown Event Payload:
  action: string - Unique identifier for the action. If your plugin supports multiple actions, use this value to determine which action was triggered
  event: string - dialDown
  context: string - Value that identifies the instance action
  device: string - Value used to identify the device
  payload: object - A JSON object
    payload.controller: string - Encoder
    payload.settings: object - This JSON object contains the persistent storage data
    payload.coordinates: object - Coordinates of the triggered action
      payload.coordinates.column: number
      payload.coordinates.row: number
```

--------------------------------

### Log Debug Messages

Source: https://sdk.key123.vip/en/guide/overview.html/events-sent

This API allows plugins or property inspectors to print debug messages to the SDK's debug window. This is primarily for temporary debugging purposes and messages are not permanently recorded. For persistent logging, developers should implement local file writing.

```json
{
 "event": "logMessage",
 "payload": {
  "message": "Hello World!"
 }
}
```

```APIDOC
logMessage:
  description: "API to print debug messages to the SDK debug window."
  parameters:
    event: "logMessage"
    payload:
      type: "JSON object"
      members:
        message: "The message to write to the log file"
```

--------------------------------

### Stream Dock Plugin and Property Inspector Received Events API

Source: https://sdk.key123.vip/en/guide/overview.html/events-received

Documents the various events that plugins and Property Inspectors can receive from the Stream Dock application, including settings changes, key presses, dial interactions, device connections, application lifecycle events, and inter-component communication.

```APIDOC
Received Events:
  Common Events (Plugins & Property Inspectors):
    didReceiveSettings: Event received after settings change
    didReceiveGlobalSettings: Event received after globalSettings change

  Plugin-Specific Events:
    keyDown: Event received when a user presses a key
    keyUp: Event received when a user releases a key
    dialDown: Event received when a user presses a dial
    dialUp: Event received when a user releases a pressed dial
    dialRotate: Event received when a user rotates a dial
    willAppear: Event received when an action instance appears on the Stream Dock (e.g., when hardware is first inserted or when entering a folder containing the action)
    willDisappear: Event received when an action instance no longer appears on the Stream Dock (e.g., when switching profiles or folders)
    titleParametersDidChange: Event received when the user changes the title or title parameters
    deviceDidConnect: Event received when a device is inserted into the computer
    deviceDidDisconnect: Event received when a device is removed from the computer
    applicationDidLaunch: Event received when a monitored application is launched
    applicationDidTerminate: Event received when a monitored application terminates
    systemDidWakeUp: Event received when the computer wakes up
    propertyInspectorDidAppear: Event received when the Property Inspector appears in the Stream Dock UI (e.g., when selecting a new instance)
    propertyInspectorDidDisappear: Event received when the Property Inspector is destroyed in the Stream Dock UI (e.g., when selecting a new instance and the old instance triggers this event)
    sendToPlugin: Event received when the Property Inspector uses this event

  Property Inspector-Specific Events:
    sendToPropertyInspector: Event received when the plugin uses this event
```

--------------------------------

### Vue.js `useI18nStore` Hook for Internationalization

Source: https://sdk.key123.vip/en/guide/overview.html/i18n

This TypeScript/JavaScript code defines a Vue.js hook, `useI18nStore`, designed to provide localized strings to Vue components. It retrieves the current application language from `window.argv` and returns a corresponding object of localized strings, defaulting to English if the language is not found.

```TypeScript
export const useI18nStore = () => {
  const language = window.argv[3].application.language;
  const localString = {
    en: {
      test: 'test'
    },
    zh_CN: {
      test: '测试'
    }
  };
  return localString[language] || localString['en'];
};
```

--------------------------------

### Handle dialRotate Event

Source: https://sdk.key123.vip/en/guide/overview.html/events-received

Documents the JSON payload structure for the `dialRotate` event, triggered when a user rotates a knob. It includes details on the action context, device, and payload contents like controller type, settings, coordinates, rotation ticks, and pressed state.

```JSON
{
  "action": "com.mirabox.demo.action2",
  "event": "dialRotate",
  "context": uniqueValue,
  "device": uniqueValue,
  "payload": {
    "controller": "Encoder",
    "settings": {<json data>},
    "coordinates": {
      "column": 0,
      "row": 0
    },
    "ticks": -1,
    "pressed": false
  }
}
```

```APIDOC
dialRotate Event Payload:
  action: string - Unique identifier for the action. If your plugin supports multiple actions, use this value to determine which action was triggered
  event: string - dialRotate
  context: string - Value that identifies the instance action
  device: string - Value used to identify the device
  payload: object - A JSON object
    payload.controller: string - Encoder
    payload.settings: object - This JSON object contains the persistent storage data
    payload.coordinates: object - Coordinates of the triggered action
      payload.coordinates.column: number
      payload.coordinates.row: number
    payload.ticks: number - An integer representing the number of "ticks" during knob rotation. Positive values indicate clockwise rotation, negative values indicate counterclockwise rotation, and zero indicates no rotation
    payload.pressed: boolean - Boolean value indicating whether the knob was in a pressed state during rotation
```

--------------------------------

### Handle Stream Dock Action Disappearance (willDisappear Event)

Source: https://sdk.key123.vip/en/guide/overview.html/events-received

This event is triggered when an action instance stops being displayed on the Stream Dock, such as when switching profiles or folders, or when the user deletes the action. It provides context about the disappearing action, including its settings, coordinates, and controller type.

```APIDOC
willDisappear Event:
  Description: Triggered when an action instance stops being displayed on the Stream Dock.
  Payload:
    action: string - Unique identifier for the action.
    event: string - "willDisappear"
    context: string - Value that identifies the instance action.
    device: string - Value used to identify the device.
    payload: object - Contains detailed information about the action.
      payload.settings: object - This JSON object contains the persistent storage data.
      payload.coordinates: object - Coordinates of the triggered action.
        payload.coordinates.column: number
        payload.coordinates.row: number
      payload.controller: string - Keypad (normal buttons), Information (view-only, no touch or button events), SecondaryScreen (small screen display), Knob (rotary control).
      payload.state: number - Set only if the action has multiple states defined in its manifest.json. The value starting from 0 represents the current state of the action.
      payload.isInMultiAction: boolean - Boolean value indicating whether the action is within a Multi-Action.
  Example JSON:
    {
        "action": "com.mirabox.demo.action1",
        "event": "willDisappear",
        "context": uniqueValue,
        "device": uniqueValue,
        "payload": {
            "settings": {<json data>},
            "coordinates": {
                "column": 3,
                "row": 1
            },
            "controller": "Keypad",
            "state": 0,
            "isInMultiAction": false
        }
    }
```

--------------------------------

### Receive Stream Dock Device Connection Notification (deviceDidConnect Event)

Source: https://sdk.key123.vip/en/guide/overview.html/events-received

This event is triggered when a Stream Dock device is connected to the computer. It provides information about the newly connected device, including its name, type, and the number of rows and columns of keys it has.

```APIDOC
deviceDidConnect Event:
  Description: Triggered when a device is inserted into the computer.
  Payload:
    event: string - "deviceDidConnect"
    device: string - Value used to identify the device.
    deviceInfo: object - Contains information about the connected device.
      deviceInfo.name: string - Name of the device.
      deviceInfo.type: number - Type of the device.
      deviceInfo.size: object - Number of rows and columns of keys the device has.
        deviceInfo.size.columns: number
        deviceInfo.size.rows: number
  Example JSON:
    {
     "event": "deviceDidConnect",
        "device": uniqueValue,
         "deviceInfo": {
            "name": "Device Name",
            "type": 0,
             "size": {
                "columns": 5,
                "rows": 3
            }
        }
    }
```

--------------------------------

### Detect Stream Dock Action Title Parameter Changes (titleParametersDidChange Event)

Source: https://sdk.key123.vip/en/guide/overview.html/events-received

This event is sent to the plugin when the user modifies the title or title parameters of an action instance. It includes the new title and its associated display parameters such as font family, size, style, underline, visibility, alignment, and color.

```APIDOC
titleParametersDidChange Event:
  Description: Triggered when the user changes the title or title parameters of an action instance.
  Payload:
    action: string - Unique identifier for the action.
    event: string - "titleParametersDidChange"
    context: string - Value that identifies the instance action.
    device: string - Value used to identify the device.
    payload: object - Contains information about the title and its parameters.
      payload.coordinates: object - Coordinates of the triggered action.
        payload.coordinates.column: number
        payload.coordinates.row: number
      payload.settings: object - This JSON object contains the persistent storage data.
      payload.state: number - Set only if the action has multiple states defined in its manifest.json. The value starting from 0 represents the current state of the action.
      payload.title: string - New title.
      payload.titleParameters: object - JSON object describing the new title parameters.
        payload.titleParameters.fontFamily: string - Title font.
        payload.titleParameters.fontSize: number - Font size of the title.
        payload.titleParameters.fontStyle: string - Font style of the title.
        payload.titleParameters.fontUnderline: boolean - Boolean value for the title underline.
        payload.titleParameters.showTitle: boolean - Boolean value indicating whether the title is visible.
        payload.titleParameters.titleAlignment: string - Position of the title.
        payload.titleParameters.titleColor: string - Title color.
  Example JSON:
    {
      "action": "com.mirabox.demo.action1",
      "event": "titleParametersDidChange",
      "context": "uniqueValue",
      "device": "uniqueValue",
      "payload": {
        "coordinates": {
          "column": 3,
          "row": 1
        },
        "settings": {<json data>},
        "state": 0,
        "title": "",
        "titleParameters": {
          "fontFamily": "",
          "fontSize": 12,
          "fontStyle": "",
          "fontUnderline": false,
          "showTitle": true,
          "titleAlignment": "bottom",
          "titleColor": "#ffffff"
        }
      }
    }
```

--------------------------------

### Receive Stream Dock Device Disconnection Notification (deviceDidDisconnect Event)

Source: https://sdk.key123.vip/en/guide/overview.html/events-received

This event is triggered when a Stream Dock device is disconnected from the computer. It provides the unique identifier for the disconnected device, allowing the plugin to react to the device's removal.

```APIDOC
deviceDidDisconnect Event:
  Description: Triggered when a device is disconnected from the computer.
  Payload:
    event: string - "deviceDidDisconnect"
    device: string - Value used to identify the device.
  Example JSON:
    {
     "event": "deviceDidDisconnect",
        "device": uniqueValue
    }
```
Tokens:
Raw