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

StreamDock Base Class

All specific device control classes need to inherit from the StreamDock base class. The StreamDock base class provides the following methods:

Get Device Firmware Version

unsigned char *streamDock::getFirmVersion(int length)

Open Device

int streamDock::open()

Disconnect Device

int streamDock::disconnected()

Set Device Screen Brightness

int streamDock::setBrightness(int percent)

Set Device Screen Background Image

int streamDock::setBackgroundImg(std::string path)

Receive Information from Device

unsigned char * streamDock::read()

Set Device Key Icon

int streamDock::setKeyImg(std::string path, int key)

Clear Specific Key Icon

int streamDock::clearIcon(int index)

Clear All Key Icons

int streamDock::clearAllIcon()

Wake Screen

int streamDock::wakeScreen()

Refresh Display After Data Transfer

int streamDock::refresh()
Last Updated:
Contributors: JKWTCN
Prev
Device Manager
Next
Communication Transport