Skip to main content
The pixelStreaming object is the core streaming instance returned by StreamPixelApplication().

Methods

addEventListener(event, callback)

Register a listener for WebRTC lifecycle events.

connect()

Manually initiate a connection (use when AutoConnect is false).
You only need to call connect() when AutoConnect is set to false. If AutoConnect is true, the connection is established automatically on initialization.

disconnect()

Disconnect the stream.

reconnect()

Reconnect after a disconnect.

emitConsoleCommand(command)

Send a console command to Unreal Engine.

addResponseEventListener(name, callback)

Listen for custom responses sent from UE to the web application.

unmuteMicrophone(enabled)

Enable or disable microphone input to UE.

unmuteCamera(enabled)

Enable or disable camera input to UE.

Events

Connection lifecycle

Failure

AFK

Statistics

Next steps

UIControl API

Audio, resolution, and stats helper methods.

reconnectStream API

Listen to reconnection state changes.