StreamPixelApplication() returns an object with five properties. This page describes each one and how to use them.
pixelStreaming
The core streaming instance. Use it to:
- Listen for WebRTC lifecycle events
- Send commands and data to Unreal Engine
- Receive responses from Unreal Engine
- Control connection state
appStream
The application wrapper that manages the DOM, video element, and overlays.
rootElement
appStream.rootElement is the DOM element containing the video player. This is the key element you need to append to your page to display the stream.Lifecycle callbacks
Accessing video and audio elements
Sending data to UE
queueHandler
A function that registers a callback for queue position updates. Queue events fire when all UE instances are busy and the user is waiting.
UIControl
Helper methods for common UI operations:
reconnectStream
An event emitter that reports reconnection state changes:
Next steps
Connection lifecycle
Map every event fired by
pixelStreaming during a session.Reconnection
Handle network drops with the
reconnectStream state machine.