The Streampixel Web SDK is a browser-based JavaScript SDK that streams Unreal Engine content to any web browser via WebRTC. Built on top of Epic Games’ Pixel Streaming, the SDK adds automatic server management, reconnection handling, voice chat, and a richer set of frontend hooks.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.
How it works
Your app imports the SDK
Call
StreamPixelApplication with your appId from the Streampixel dashboard.The SDK connects to the signaling server
Your
appId resolves all server-side configuration — signaling URLs, TURN credentials, instance pool, and authentication.A UE instance is matched to your session
The signaling server picks an available Unreal Engine instance from your project’s pool.
A WebRTC connection is established
Direct peer-to-peer when possible; the SDK falls back to a TURN relay automatically when blocked by firewalls or NAT.
Key concepts
| Term | Meaning |
|---|---|
| appId | Project identifier from the dashboard. Resolves all server-side config. |
| Signaling server | WebSocket server that coordinates WebRTC connection setup. |
| TURN server | Relay server used when direct peer-to-peer is blocked. |
| SFU | Selective Forwarding Unit. Enables one-to-many streaming from a single UE instance. |
| AFK | Idle timeout system that disconnects inactive users to free server resources. |
| Pixel Streaming | Epic Games’ technology for streaming UE applications via WebRTC. |
Prerequisites
- A Streampixel account with a deployed project (you’ll need the
appIdfrom the dashboard) - Node.js 16 or later
- A modern browser (Chrome, Firefox, Edge, Safari)
Get started
Installation
Install the SDK via npm or yarn.
Quick start
A minimal working example to embed your first stream.
Resources
SDK on GitHub
Source, releases, and changelog.
Example app
A working reference implementation.