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.

Streampixel uses a messaging channel between your frontend and the Unreal Engine app to exchange JSON. This page covers the two ways to send messages, then links to platform-specific guides for sending and receiving.

​
Direction of messages

Unreal → Frontend

Status updates, gameplay events, analytics, and any data the app wants to surface to the page.

Frontend → Unreal

Configuration, runtime commands, user input, and dynamic state the app should react to.

​
Two ways to send messages from the frontend

A one-time JSON payload passed as a URL parameter when launching the app. Delivered automatically at session start. No frontend JavaScript required — useful for static configuration like locale, level ID, or feature flags.
Both methods deliver messages into Unreal through the same Pixel Streaming system. From Unreal’s perspective the handling is identical — branch on the JSON content.

​
Platform guides

Unreal side

Set up Blueprints to receive and send JSON in Unreal Engine.

Frontend side

Send messages from your web app and listen for responses from Unreal.