search

Web SDK

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 technology, the SDK enhances the core experience with automatic server management, reconnection handling, voice chat, and more.

hashtag
How It Works

The high-level architecture follows this flow:

  1. Your web app imports the SDK and calls StreamPixelApplication with your appId.

  2. The SDK connects to Streampixel's signaling server using your appId to identify your project.

  3. The signaling server matches you to an available Unreal Engine instance from your project's instance pool.

  4. A WebRTC peer connection is established between the browser and the UE instance. If a direct peer-to-peer connection is not possible (due to firewalls or NAT), the SDK automatically falls back to a TURN relay server.

  5. Video and audio stream from UE to the browser, while user input (mouse, keyboard, touch, gamepad) flows from the browser back to UE in real time.

hashtag
Key Concepts

  • appId: Your project identifier from the Streampixel dashboard. This single ID resolves all server-side configuration including signaling URLs, TURN credentials, UE instance pool, and authentication.

  • Signaling Server: A WebSocket server that coordinates WebRTC connection setup between the browser and the UE instance.

  • TURN Server: A relay server that forwards media when a direct peer-to-peer connection is not possible due to firewalls or NAT.

  • SFU (Selective Forwarding Unit): Enables one-to-many streaming where a single UE instance serves multiple viewers simultaneously.

  • AFK (Away From Keyboard): An idle timeout system that disconnects inactive users to free up server resources.

  • Pixel Streaming: Epic Games' technology for streaming Unreal Engine applications to browsers via WebRTC.

hashtag
Prerequisites

  • A Streampixel account with a deployed project (you will need the appId from your dashboard)

  • Node.js 16 or later

  • A modern browser (Chrome, Firefox, Edge, Safari)

hashtag
Get Started

Installationchevron-rightQuick Startchevron-right

hashtag
Links

PreviousAdditional SettingsNextInstallation

Last updated