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.

This guide takes you from a fresh Streampixel account to a live Unreal Engine stream embedded in a web page. By the end, you will have created a project, uploaded a packaged build, and embedded the resulting share link in an iframe.

​
Before you begin

RequirementNotes
Streampixel accountSign in with Google at streampixel.io.
Packaged Unreal buildA .zip of a Windows or VR-ready package. See prepare your Unreal Engine project.
Public download URLRequired only if you upload via the API. Any direct-download link works (S3, GCS, etc.).

​
Steps

1

Sign in

Open streampixel.io and sign in with your Google account. First-time sign-in provisions your user automatically through Auth0.
2

Create a project and pick a region

From the dashboard, click New Project. Choose one of three deployment regions:
RegionCodeBest for
US-East-1us-east-1North America
EuropeeuropeEMEA
Asia Pacificasia-pacificAPAC
Pick the region closest to most of your end users. Region is fixed for the life of the project — see Regions for details.
3

Package an Unreal build

From the Unreal Editor, package your project for Windows (or use the VR setup guide for VR builds). Compress the resulting folder into a single .zip file.
Keep builds under the default 30 GB limit. Cooked content, unused plugins, and editor symbols are the usual culprits when builds get large.
4

Upload the build

You can upload through the dashboard or directly via the REST API.
  1. Open your project’s Builds tab.
  2. Click Upload Build and either drag the .zip in or paste a public download URL.
  3. Submit. The build immediately enters the build lifecycle.
Walkthrough: uploading your build.
5

Wait for approval

The build moves through eight states — pending, Downloading Files, Extracting & Scanning, Saving to Repository, Distribute, then Approved (or Reject). Watch progress on the dashboard or subscribe to webhooks.
Configure a webhook URL in Project Settings to get notified when the build hits build.approved. See Webhooks.
6

Grab the share link

Once the build is approved and distributed, the project’s Share panel exposes a hosted URL. Open it in a browser to verify the stream works end-to-end.
7

Embed via iframe

Drop the share URL into an iframe on any web page:
<iframe
  src="https://share.streampixel.io/[YOUR_PROJECT_ID]"
  width="1280"
  height="720"
  allow="autoplay; fullscreen; microphone; camera; xr-spatial-tracking; gamepad"
  allowfullscreen
></iframe>
The allow attribute matters. Without microphone, voice chat will be blocked. Without xr-spatial-tracking, WebXR sessions will fail.
For richer control — programmatic input, JSON messaging, custom UI — use the Web SDK instead.

​
Verify the stream

Open the share URL in Chrome on a desktop machine. You should see:
  • A loading screen while a worker is assigned.
  • The Unreal Engine viewport, streamed as WebRTC video.
  • Mouse, keyboard, and touch input flowing back into the build.
If you see a queue or “no worker available” message, your project’s worker pool is busy — see session lifecycle.

​
What’s next

Web SDK

Embed streams with full programmatic control: input, JSON messaging, custom UI, voice chat.

Configuring your project

Tune codecs, resolution, AFK timeouts, and worker count.

Webhooks

Get notified at every stage of the build pipeline.

How Streampixel works

The architecture behind the share link you just embedded.