OBSBOT SDK (Lumia Fork)

Node.js native wrapper for OBSBOT cameras used by Lumia plugins.

Prerequisites

• Node.js >=22.18.0 (matches package.json)
• Build tools for native addons:
  • macOS: Xcode Command Line Tools
  • Windows: Visual Studio Build Tools + Python
  • Linux: build-essential, Python, and compiler toolchain

Build On Each Platform

Run these steps on each target OS/arch machine (for example: darwin-arm64, win32-x64):

npm install
npm run build

What this does:

• npm run build compiles build/Release/obsbot_native.node and stages prebuilds
• staging copies platform binaries into:
  • prebuilds/<platform>-<arch>/obsbot_native.node
  • and runtime libs (libdev.dylib, libdev.dll, w32-pthreads.dll, or libdev.so*) when applicable

If you need to re-stage without rebuilding, run:

npm run stage-prebuild

Optional Mirror To Another Repo

To mirror staged prebuilds into another directory while staging:

OBSBOT_PREBUILD_MIRROR=/absolute/path/to/third_party/obsbot-sdk/prebuilds npm run stage-prebuild

This writes to <mirror>/<platform>-<arch>/.

Validate The Result

After staging, verify expected files exist:

ls -la prebuilds/$(node -p "process.platform + '-' + process.arch")

Expected at minimum:

• obsbot_native.node
• platform runtime library files for that OS

Using In The OBSBOT Plugin

If the plugin depends on npm package @lumiastream/obsbot-sdk, publish/update the package, then update plugin dependency version.

For local testing without publishing:

npm pack
# then in plugin repo:
# npm install /absolute/path/to/obsbot-sdk/<generated-tarball>.tgz