# Streampixel

## Docs

- [Frequently asked questions](https://docs.streampixel.io/frequently-asked-questions.md): Answers to the most common questions about Streampixel — platform, hardware, regions, and troubleshooting.
- [Streampixel Docs](https://docs.streampixel.io/index.md): Stream Unreal Engine projects to any browser. No installs, no plugins, no headaches.
- [Hide / unhide touch controls](https://docs.streampixel.io/resources/additional-unreal-engine-features/hide-unhide-touch-controls.md): Detect when a viewer is on a touch device and toggle your in-game touch UI accordingly.
- [Overview](https://docs.streampixel.io/resources/additional-unreal-engine-features/overview.md): Optional Unreal Engine setup for richer Streampixel experiences.
- [Playing media files](https://docs.streampixel.io/resources/additional-unreal-engine-features/playing-media-files.md): Stream video files from inside an Unreal Engine project to the browser using a File Media Source and Media Plate actor.
- [Virtual keyboard for text input](https://docs.streampixel.io/resources/additional-unreal-engine-features/virtual-keyboard.md): How editable text fields in Unreal trigger the on-screen keyboard in the browser, automatically from UE 5.3+.
- [API authentication](https://docs.streampixel.io/resources/api-reference/api-authentication.md): Generate, use, and rotate your Streampixel API key. The key is passed in the request body of every call.
- [Distribute File API](https://docs.streampixel.io/resources/api-reference/distribute-file-api.md): Push an uploaded build to Streampixel's streaming servers. Only needed when autoRelease is false or for re-distribution.
- [Finding your user and project IDs](https://docs.streampixel.io/resources/api-reference/finding-your-user-and-project-ids.md): Locate the userId and projectId values you'll pass on every API request.
- [List Projects](https://docs.streampixel.io/resources/api-reference/list-projects.md): Retrieve a paginated list of all projects you own, with summary information for each.
- [Overview](https://docs.streampixel.io/resources/api-reference/overview.md): Automate builds, distribution, and webhooks via the REST API.
- [Rate limits & error codes](https://docs.streampixel.io/resources/api-reference/rate-limits-and-errors.md): Rate limit windows, HTTP status codes, and the standard error response format used across all Streampixel endpoints.
- [Test Webhook API](https://docs.streampixel.io/resources/api-reference/test-webhook-api.md): Programmatically send a `webhook.test` event to your configured webhook URL to verify your endpoint is reachable.
- [Upload File API](https://docs.streampixel.io/resources/api-reference/upload-file-api.md): Submit a packaged Unreal Engine build to a Streampixel project by providing a public download URL.
- [Webhook event reference](https://docs.streampixel.io/resources/api-reference/webhook-events.md): Complete reference for every webhook event Streampixel sends — names, payloads, and the build state that triggers each.
- [Overview](https://docs.streampixel.io/resources/api-reference/webhooks.md): Receive real-time HTTP notifications when builds are uploaded, approved, rejected, or distributed.
- [Build lifecycle](https://docs.streampixel.io/resources/concepts/build-lifecycle.md): What each build state means, what fires a webhook, and what to do when a build is rejected.
- [Network requirements](https://docs.streampixel.io/resources/concepts/network-requirements.md): Ports, protocols, and STUN/TURN IP ranges that need to be reachable for Streampixel to deliver low-latency streams.
- [Regions](https://docs.streampixel.io/resources/concepts/regions.md): Three regions to deploy in. How to pick one for your audience.
- [Session lifecycle](https://docs.streampixel.io/resources/concepts/session-lifecycle.md): What happens from the moment a viewer opens your stream — queue, connect, AFK, disconnect.
- [Troubleshooting](https://docs.streampixel.io/resources/concepts/troubleshooting.md): Diagnose stream quality, connection, and audio issues — with or without the Web SDK.
- [Reading your analytics](https://docs.streampixel.io/resources/dashboard/analytics-interpretation.md): How to interpret session counts, latency, FPS, and other metrics in the analytics dashboard.
- [API keys](https://docs.streampixel.io/resources/dashboard/api-keys.md): Generate, manage, and rotate API keys to authenticate REST API requests.
- [Billing](https://docs.streampixel.io/resources/dashboard/billing.md): Plan, payment method, and invoices.
- [Branding](https://docs.streampixel.io/resources/dashboard/branding.md): Logo, splash screen, loading animation, and messages — everything viewers see before the stream starts.
- [Builds](https://docs.streampixel.io/resources/dashboard/builds.md): Manage every build in a project — track progress, set the live build, and organize your version history.
- [Capacity & CCU](https://docs.streampixel.io/resources/dashboard/capacity.md): Manage how many viewers can stream concurrently across your projects.
- [Custom domains](https://docs.streampixel.io/resources/dashboard/custom-domains.md): Serve your stream from your own domain instead of streampixel.io.
- [Project overview](https://docs.streampixel.io/resources/dashboard/project-overview.md): The dashboard tab that gives you a project's live status, share link, build, and CCU at a glance.
- [Team members](https://docs.streampixel.io/resources/dashboard/team-members.md): Invite teammates with Editor, Finance, or Viewer roles.
- [Quickstart](https://docs.streampixel.io/resources/get-started/quickstart.md): From zero to a live, shareable Unreal Engine stream in 10 minutes.
- [Basic embed](https://docs.streampixel.io/resources/iframe-integration/basic-iframe-integration.md): Embed the Streampixel iframe into your frontend, configure input handling, and manage focus for custom UI controls.
- [Frontend and application communication](https://docs.streampixel.io/resources/iframe-integration/frontend-and-application-communication.md): Send and receive messages between your frontend, the Streampixel iframe, and the Unreal Engine application using postMessage.
- [Overview](https://docs.streampixel.io/resources/iframe-integration/overview.md): Embed a Streampixel stream into your site with a single iframe.
- [Sample code for HTML and React](https://docs.streampixel.io/resources/iframe-integration/sample-code-for-html-and-react.md): Copy-paste HTML/JavaScript and React examples that embed the Streampixel iframe with a loading screen and stream controls.
- [Stream control commands](https://docs.streampixel.io/resources/iframe-integration/stream-control-commands.md): Manage your Streampixel stream dynamically with programmatic controls for resolution, audio, session, chat, cursor, screenshots, and custom messages.
- [Stream states](https://docs.streampixel.io/resources/iframe-integration/stream-states.md): Intercept real-time stream state and metadata messages from the Streampixel iframe to power custom loading UIs and analytics.
- [Frontend side - sending and receiving JSON](https://docs.streampixel.io/resources/json-message-communication/frontend-side-sending-and-receiving-json.md): Send JSON messages from your frontend into Unreal via URL or the WebSDK/Iframe API, and listen for messages sent back from Unreal.
- [Overview](https://docs.streampixel.io/resources/json-message-communication/overview.md): How to send and receive JSON between your page and Unreal — three paths, each with its own API.
- [Unreal side - sending and receiving JSON](https://docs.streampixel.io/resources/json-message-communication/unreal-side-sending-and-receiving-json.md): Set up Unreal Engine blueprints to receive JSON messages from the Streampixel frontend and send messages back.
- [Other project controls](https://docs.streampixel.io/resources/quick-start-guide/additional-settings.md): Activate/disable a project, change concurrent users, cancel a subscription.
- [Analytics](https://docs.streampixel.io/resources/quick-start-guide/analytics-feature.md): Real-time and historical session metrics — latency, FPS, viewer location, devices.
- [Voice and text chat](https://docs.streampixel.io/resources/quick-start-guide/built-in-voice-and-text-chat.md): Enable real-time chat between viewers in the same session.
- [Codec settings](https://docs.streampixel.io/resources/quick-start-guide/codec-settings.md): Pick a primary and fallback codec for your stream.
- [Create a project](https://docs.streampixel.io/resources/quick-start-guide/configuring-your-project.md): Create a Streampixel project, pick a region, understand the free trial.
- [Default frontend](https://docs.streampixel.io/resources/quick-start-guide/default-frontend.md): What the share link does out of the box — no SDK, no iframe code, no custom frontend.
- [Disconnect codes](https://docs.streampixel.io/resources/quick-start-guide/disconnect-codes.md): Reference for disconnect codes that explain why a streaming session ended or failed.
- [Input & UI controls](https://docs.streampixel.io/resources/quick-start-guide/frontend-settings.md): Toggle input devices and which UI buttons appear over the stream.
- [Meeting rooms](https://docs.streampixel.io/resources/quick-start-guide/meeting-rooms.md): One Host runs the Unreal app; many Guests watch and chat. Only the Host counts toward CCU.
- [Mouse settings](https://docs.streampixel.io/resources/quick-start-guide/mouse-settings.md): Configure mouse behavior — hide the in-engine cursor for web UI, lock the cursor for in-game UI.
- [Prepare a VR experience](https://docs.streampixel.io/resources/quick-start-guide/prepare-your-unreal-engine-project-for-vr.md): In-engine changes for delivering a VR Streampixel experience.
- [Prepare your Unreal build](https://docs.streampixel.io/resources/quick-start-guide/prepare-your-unreal-engine-project-for-windows.md): Enable Pixel Streaming and package your Unreal project for Streampixel.
- [Register and sign in](https://docs.streampixel.io/resources/quick-start-guide/register-and-sign-in.md): Sign in with Google, Microsoft, or email — and add billing details before the trial.
- [Resolution settings](https://docs.streampixel.io/resources/quick-start-guide/resolution-settings.md): Resolution mode, max quality, and per-device defaults.
- [Screenshots](https://docs.streampixel.io/resources/quick-start-guide/screenshot-functionality.md): Capture the current video frame and download it to the viewer's device.
- [Security & access control](https://docs.streampixel.io/resources/quick-start-guide/security-control.md): Password-protect your stream and restrict which domains can embed it.
- [Session rules](https://docs.streampixel.io/resources/quick-start-guide/session-rules.md): Limit how long a session can run and how long viewers can sit idle.
- [Share and embed](https://docs.streampixel.io/resources/quick-start-guide/sharing-and-embedding.md): Distribute your stream via a public share link or embed it inside your own site with an iframe.
- [Upload your build](https://docs.streampixel.io/resources/quick-start-guide/uploading-your-build.md): Upload your packaged Unreal `.zip` to Streampixel.
- [CI/CD: ship a build on every commit](https://docs.streampixel.io/resources/recipes/ci-cd-pipeline.md): Auto-upload Unreal builds to Streampixel from GitHub Actions and trigger distribution after approval.
- [Mobile streaming](https://docs.streampixel.io/resources/recipes/mobile-streaming.md): Optimize your stream for iOS and Android browsers, including touch input and bandwidth constraints.
- [Multiplayer: one Unreal app, many viewers](https://docs.streampixel.io/resources/recipes/multiplayer-streaming.md): Stream a single Unreal Engine instance to multiple users in the same scene using SFU mode.
- [Overview](https://docs.streampixel.io/resources/recipes/overview.md): End-to-end recipes for shipping production Streampixel integrations.
- [Performance tuning](https://docs.streampixel.io/resources/recipes/performance-tuning.md): Hit your latency, FPS, and bitrate targets across regions and devices.
- [Security hardening](https://docs.streampixel.io/resources/recipes/security-hardening.md): Protect your stream from unauthorized access, abuse, and credential leaks.
- [VR on the web](https://docs.streampixel.io/resources/recipes/vr-web-integration.md): Deliver a VR Unreal experience to any WebXR-capable browser headset — Quest, Vision Pro, and others.
- [Glossary](https://docs.streampixel.io/resources/reference/glossary.md): Definitions for the terms used throughout the Streampixel docs.
- [Configuration options](https://docs.streampixel.io/resources/web-sdk/api-reference/configuration-options.md): Complete reference of all StreamPixelApplication configuration options, organized by connection, codec, resolution, bitrate, input, audio, and AFK.
- [Overview](https://docs.streampixel.io/resources/web-sdk/api-reference/overview.md): Every SDK object, method, event, and config option.
- [pixelStreaming](https://docs.streampixel.io/resources/web-sdk/api-reference/pixelstreaming.md): API reference for the pixelStreaming instance: connection methods, UE messaging, microphone and camera, and lifecycle events.
- [reconnectStream](https://docs.streampixel.io/resources/web-sdk/api-reference/reconnectstream.md): API reference for the reconnectStream event emitter: state events, callback data, and reconnection behavior.
- [StreamPixelApplication](https://docs.streampixel.io/resources/web-sdk/api-reference/streampixelapplication.md): API reference for StreamPixelApplication: signature, settings, and the returned pixelStreaming, appStream, and helpers.
- [UIControl](https://docs.streampixel.io/resources/web-sdk/api-reference/uicontrol.md): API reference for UIControl: audio toggling, resolution control, hover mouse, and stream statistics helpers.
- [StreamPixelVoiceChat](https://docs.streampixel.io/resources/web-sdk/api-reference/voicechat.md): API reference for StreamPixelVoiceChat: constructor, room control, mic and message methods, and participant callbacks.
- [Connection lifecycle](https://docs.streampixel.io/resources/web-sdk/core-concepts/connection-lifecycle.md): The events fired during stream setup, how to listen for them, and how to handle failures and manual connection control.
- [Initialization and configuration](https://docs.streampixel.io/resources/web-sdk/core-concepts/initialization.md): Reference for the StreamPixelApplication function, the appId parameter, and all available configuration options.
- [Core concepts](https://docs.streampixel.io/resources/web-sdk/core-concepts/overview.md): How the SDK boots, what it returns, and the session lifecycle.
- [Return values](https://docs.streampixel.io/resources/web-sdk/core-concepts/return-values.md): Reference for the five objects returned by StreamPixelApplication: pixelStreaming, appStream, queueHandler, UIControl, and reconnectStream.
- [AFK (idle timeout)](https://docs.streampixel.io/resources/web-sdk/features/afk-idle-timeout.md): Configure away-from-keyboard detection to disconnect inactive users and free up Unreal Engine instances for others.
- [Audio and media input](https://docs.streampixel.io/resources/web-sdk/features/audio-media-input.md): Manage stream audio playback and forward the user's microphone and camera input to the Unreal Engine application.
- [Communicating with Unreal Engine](https://docs.streampixel.io/resources/web-sdk/features/communicating-with-ue.md): Send and receive data between your web app and Unreal Engine using the Web SDK.
- [Input controls](https://docs.streampixel.io/resources/web-sdk/features/input-controls.md): Configure mouse, keyboard, touch, gamepad, WebXR, and text input forwarding from the browser to the Unreal Engine application.
- [Overview](https://docs.streampixel.io/resources/web-sdk/features/overview.md): Every SDK capability, grouped by concern. Read only what you need.
- [Queue system](https://docs.streampixel.io/resources/web-sdk/features/queue-system.md): Receive queue position updates when all Unreal Engine instances are busy and display waiting UI to users.
- [Reconnection](https://docs.streampixel.io/resources/web-sdk/features/reconnection.md): Automatic reconnection state machine for WebSocket drops, including disconnect codes, reasons, and parent window messages.
- [SFU (one-to-many streaming)](https://docs.streampixel.io/resources/web-sdk/features/sfu-streaming.md): Stream a single Unreal Engine instance to many viewers using a Selective Forwarding Unit, with one host and multiple watch-only players.
- [Stream statistics](https://docs.streampixel.io/resources/web-sdk/features/stream-statistics.md): Monitor WebRTC stream quality, bitrate, frame rates, and codecs using UIControl helpers and the statsReceived event.
- [Video, codecs, and resolution](https://docs.streampixel.io/resources/web-sdk/features/video-codecs-resolution.md): Reference for supported codecs, codec negotiation, resolution presets, resolution modes, and bitrate or QP controls.
- [Voice and text chat](https://docs.streampixel.io/resources/web-sdk/features/voice-text-chat.md): Add real-time voice and text chat between users using the LiveKit-powered StreamPixelVoiceChat module.
- [Installation](https://docs.streampixel.io/resources/web-sdk/getting-started/installation.md): Install the Streampixel Web SDK, import it into your project, and verify a working setup.
- [Introduction](https://docs.streampixel.io/resources/web-sdk/getting-started/overview.md): JavaScript SDK for streaming Unreal Engine to the browser.
- [Quick start](https://docs.streampixel.io/resources/web-sdk/getting-started/quick-start.md): A minimal working integration of the Streampixel Web SDK with a video container, plus an overview of what StreamPixelApplication returns.
- [Example app walkthrough](https://docs.streampixel.io/resources/web-sdk/guides/example-app-walkthrough.md): Walk through the Streampixel SDK Example React app, including project structure, loading config, lifecycle wiring, and developer tools.
- [Overview](https://docs.streampixel.io/resources/web-sdk/guides/overview.md): Walkthroughs and troubleshooting for the Web SDK.
- [SDK troubleshooting](https://docs.streampixel.io/resources/web-sdk/guides/troubleshooting.md): Web SDK code-level issues — Webpack polyfills, singleton initialization, codec ID resolution, reconnection state, and allowed-origin validation.
- [Custom loading screen](https://docs.streampixel.io/resources/web-sdk/ui-and-customization/custom-loading-screen.md): Build a custom loading screen driven by WebRTC lifecycle events, queue position updates, and reconnection state.
- [Mounting the stream](https://docs.streampixel.io/resources/web-sdk/ui-and-customization/mounting-the-stream.md): Append the SDK's rootElement to your DOM, configure the video element, and hide the default Pixel Streaming UI.
- [Overlays and UI components](https://docs.streampixel.io/resources/web-sdk/ui-and-customization/overlays-ui-components.md): Use the SDK's built-in overlays or replace them with custom UI components driven by SDK events.
- [Overview](https://docs.streampixel.io/resources/web-sdk/ui-and-customization/overview.md): Mount the stream, replace the loading UI, and layer overlays on top.

## OpenAPI Specs

- [api-reference-openapi](https://docs.streampixel.io/api-reference-openapi.json)
- [openapi](https://docs.streampixel.io/api-reference/openapi.json)