When you share a project link likeDocumentation Index
Fetch the complete documentation index at: https://docs.streampixel.io/llms.txt
Use this file to discover all available pages before exploring further.
https://share.streampixel.io/{projectId}, viewers get a fully working frontend with built-in handlers for messages from your Unreal app. You don’t need to write any frontend code to use these — they’re handled automatically.
What the default frontend handles
| Behavior | When it triggers |
|---|---|
| Open external URL | UE sends a URL string via Send Pixel Streaming Response. The frontend opens it in a new browser tab. |
| Take a screenshot | UE sends {"message": "requestScreenshot"}. The frontend captures the current frame and downloads it. |
| Show on-screen keyboard | UE sends showOnScreenKeyboard. The frontend opens a text input modal and sends the entered text back. |
| Toggle hovering mouse | UE sends {"message": {"type": "togglehoveringmouse", "value": true/false}}. The frontend shows or hides the browser cursor. |
| Built-in voice/text chat | If enabled in project settings — chat UI appears automatically or on app trigger. See voice and text chat. |
Sending data from your page to UE (URL params)
If you only need to pass values once at session start, append them as query params to the share URL — no frontend code needed.When to leave the default frontend
The default frontend is enough for most demos, configurators, and simple interactive experiences. Move to a custom frontend only when you need:| Need | Use |
|---|---|
| Send messages during the session (not just at launch) | Iframe or Web SDK |
| React to UE events programmatically (custom JSON, not just URL opens or screenshots) | Iframe or Web SDK |
| Custom HUD overlays, branded loading screens, complex UI | Web SDK |
| Embed in your own site without changing your frontend | Iframe |
Next
JSON messaging
All three communication paths compared: URL params, iframe, SDK.
Branding
Customize logo, splash, and loading messages on the default frontend.