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
  • Cpp SDK

    • Overview
    • Dependency Installation
    • Device Manager
    • StreamDock Base Class
    • Communication Transport
    • Example
    • API Reference
    • Source Code
  • Python SDK

    • Overview
    • Dependency Installation
    • Device Manager
    • StreamDock Base Class
    • API Reference
    • Examples
    • Source Code
  • Windows-WebSocket SDK

    • Overview
    • Getting Started
    • Events Sent
    • Events Received
    • Source Code
  • Support

    • Help and Bug Reporting

Linux System

On Linux, the required dependencies can be installed as follows:

System Dependencies Installation

Basic Dependencies

sudo apt update
sudo apt install -y build-essential cmake

HID Device Related Dependencies

sudo apt install -y libudev-dev libusb-1.0-0-dev libhidapi-libusb0

Image Processing Library Dependencies

sudo apt install -y libgif-dev

OpenCV Library

sudo apt install libopencv-dev

Note

If devices can be detected but operations cannot be performed, try using sudo for privilege escalation.

macOS System

On macOS, the required dependencies can be installed as follows:

Dependencies Installation

Using Homebrew (Recommended)

# Install Homebrew if not already installed
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"

# Install required dependencies
brew install cmake
brew install hidapi
brew install jpeg
brew install libpng
brew install opencv

Manual Installation

If you prefer manual installation or need specific versions:

CMake

Download and install from cmake.org

HIDAPI

# Clone and build HIDAPI
git clone https://github.com/libusb/hidapi.git
cd hidapi
./bootstrap
make
sudo make install

Image Processing Libraries

# Install libjpeg
brew install jpeg

# Install libpng
brew install libpng

# Install OpenCV
brew install opencv

Note

Navigate to the ImgProcesser/third_party directory and run the following script to create symbolic links for OpenCV libraries:

bash link_opencv_symlinks.sh

This script will create necessary symbolic links in opencv/mac/lib to allow CMake to correctly locate OpenCV libraries.

Windows System

On Windows, StreamDock SDK provides pre-compiled library files, simplifying the installation process.

System Requirements

  • Windows 10/11 (64-bit)
  • Visual Studio 2022 (Recommended)
  • CMake 3.16 or higher

Pre-compiled Libraries

The SDK includes the following pre-compiled libraries:

Transport DLL

  • transport.dll - Release version
  • transport.lib - Release import library
  • OpenCV libraries

Located in ImgProcesser/third_party/opencv/windows/x64/vc17/ directory:

  • opencv_core4120.dll - OpenCV core module
  • opencv_imgcodecs4120.dll - Image codec module
  • opencv_imgproc4120.dll - Image processing module

Compilation and Building

Using Batch Script

# Run the provided batch script
build.bat

Manual Building

# Create build directory
mkdir build
cd build

# Generate Visual Studio project files
cmake -G "Visual Studio 17 2022" -A x64 ..

# Build Release version
cmake --build . --config Release

# Build Debug version
cmake --build . --config Debug

Runtime Dependencies

When running the program, ensure the following DLL files are in the same directory as the executable or in the system PATH:

  • transport.dll
  • opencv_core4120.dll
  • opencv_imgcodecs4120.dll
  • opencv_imgproc4120.dll

DLL Integration

// Windows platform automatically loads transport.dll
// No additional configuration needed, SDK handles it automatically
TransportCWrapper transport(deviceInfo);
Last Updated:
Contributors: JKWTCN
Prev
Overview
Next
Device Manager