/streamlabs-overlay

Primary LanguageC++GNU General Public License v2.0GPL-2.0

Overlay

overlay - it is a window what try to stay over any other windows( even fullscreen games ) and show content of some source.

source - can be other window like chat or cpu monitor.

It should be build as nodejs module.

NodeJS Module

Build

There is cmake project file in repository what can be used to make node module.

To setup env

yarn install

To configure a build

mkdir build
cd build
cmake -G "Visual Studio 16 2019" -A x64  ../

And to make a build

cmake --build . --config Release

Requirements

  • node
  • yarn
  • msbuild (vs studio make tools )

Module use examples

Examples to show api usage for simple usecases.

yarn electron examples\example_with_offscreen.js	  
yarn electron examples\example_interactivity_console.js
yarn electron examples\example_interactivity_window.js

Module API

Each overlay has ID by which it can be adressed in api.

Thread what control overlays have to be started and stoped explicitly by module user

  • start()
  • stop()

For now overlays can be shown and hidden all together

  • show()
  • hide()

To get basic info about overlays

  • getCount()
  • getIds() it return list of overlay ids.
  • getInfo(overlay_id)

To create, setup and remove overlay

  • addHWND(hwnd) return overlay id
  • setPosition(overlay_id, x, y, width, height)
  • setTransparency(overlay_id, transparency) from 0 to 255 like in SetLayeredWindowAttributes
  • reload(overlay_id) send web view a command to reload current page
  • remove(overlay_id)
  • paintOverlay(overlay_id, width, height, bitmap)

For interective mode set callbacks and switch on/off. See examples\example_with_hwnd_node.js.

  • setMouseCallback(callback)
  • setKeyabordCallback(callback)
  • switchInteractiveMode()