Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.streampixel.io/llms.txt

Use this file to discover all available pages before exploring further.

The Streampixel Web SDK is a JavaScript library for embedding your Unreal Engine stream into any web page — with full programmatic control over UI, events, voice chat, and lifecycle. Use it when an iframe isn’t enough.

What you’ll need

  • A Streampixel account with a project (you’ll need the appId from the dashboard)
  • Node.js 16 or later
  • A modern browser (Chrome, Firefox, Edge, Safari)

Start here

InstallationInstall via npm or yarn.
Quick startA minimal working example.
Core conceptsHow initialization, return values, and the connection lifecycle work.

Resources

SDK on GitHub

Source, releases, changelog.

Example app

A working reference implementation.