Skip to main content
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
See Connection Lifecycle for all events and Communicating with Unreal Engine for data exchange.

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

The SDK creates two separate media elements: a <video> element for the stream and a separate <audio> element. If you need to control volume or muting, make sure you account for both 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.
See Queue System for details.

UIControl

Helper methods for common UI operations:
See UIControl API Reference for full details.

reconnectStream

An event emitter that reports reconnection state changes:
See Reconnection for the full state machine and disconnect codes.

Next steps

Connection lifecycle

Map every event fired by pixelStreaming during a session.

Reconnection

Handle network drops with the reconnectStream state machine.