CreatorCreator
Home
Getting Started
  • 中文简体
  • English
Home
Getting Started
  • 中文简体
  • English
  • Creator

    • Getting Started
  • Stream Dock

    • Plugin SDK
    • Icon Pack

      • Overview
      • Terminology
      • Creating an Icon Pack
      • Icon Specifications
    • Scene Configuration

      • What is a Scenario Configuration?
      • Exporting
      • Use Cases
  • mPanel

    • Plugin SDK
  • Linux StreamDock SDK

    • Cpp SDK

      • Overview
      • Dependency
      • Device Manager
      • StreamDock Base Class
      • StreamDock293
      • Communication transmission
      • Example
      • Source code
    • Python SDK

      • Overview
      • Dependency
      • DeviceManager
      • StreamDock Base Class
      • StreamDock293
      • Example
      • Source Code
  • Windows StreamDock SDK

    • WebSocket SDK

      • Overview
      • Getting Started
      • Events to Send
      • Received Events
    • Cpp SDK

      • Overview
      • Dependency
      • Device manager
      • StreamDock Base Class
      • StreamDock293
      • Transport
      • Example
      • Source Code
  • Support

    • Help and Bug Reporting

Getting Started

Clone the Repository

git clone git@github.com:MiraboxSpace/Windows-StreamDock-SDK.git

Warehouse Portal

Launch streamDockSDK.exe with a Parameter

Manual launch example:

Windows StreamDock SDK

Node.js launch example:

const { execFile } = require('child_process');
//WebSocket port number
let port = 9002;
execFile('streamDockSDK.exe', [port], (error, stdout, stderr) => {
    if (error) {
        console.error('Error:', error.message);
        return;
    }
    console.log('Stdout:', stdout);
});

Connect to WebSocket

const ws = new WebSocket('ws://127.0.0.1:9002')
ws.onopen = () => {
    console.log("open")
};

ws.onmessage = (e) => {
    console.log(JSON.parse(e.data))
};

ws.onclose = () => {
    console.log("close")
};
Last Updated:
Contributors: Heart
Prev
Overview
Next
Events to Send