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.
Complete reference of all StreamPixelApplication configuration options, organized by category.
All options except appId are optional. When omitted, values default to your Streampixel dashboard configuration.
Connection Parameter Type Default Valid values Description appIdstringRequired — Project ID from Streampixel dashboard AutoConnectbooleanfalsetrue, falseAuto-connect on initialization streamerIdstringUUID (auto) Any string Target specific UE instance sfuHoststring"false""true", "false"SFU host mode (one-to-many) sfuPlayerstring"false""true", "false"SFU viewer mode forceTurnbooleantruetrue, falseForce TURN relay
Codec Parameter Type Default Valid values Description primaryCodecstringDashboard "H264", "VP8", "VP9", "AV1"Preferred video codec fallBackCodecstringDashboard "H264", "VP8", "VP9", "AV1"Fallback if primary unavailable
Resolution Parameter Type Default Valid values Description maxStreamQualitystring"1080p (1920x1080)"Resolution presets Maximum resolution ceiling startResolutionstring"1080p (1920x1080)"Resolution presets Desktop starting resolution startResolutionMobilestring"480p (854x480)"Resolution presets Mobile starting resolution startResolutionTabstring"720p (1280x720)"Resolution presets Tablet starting resolution resolutionModestring"Fixed Resolution Mode"See below How resolution adapts showResolutionbooleanDashboard true, falseShow resolution UI control
Resolution presets use the format "LABELp (WIDTHxHEIGHT)" — for example, "1080p (1920x1080)". Available presets: "360p (640x360)", "480p (854x480)", "720p (1280x720)", "1080p (1920x1080)", "1440p (2560x1440)", "4K (3840x2160)".
Resolution modes:
"Fixed Resolution Mode" — Exact resolution sent to UE"Dynamic Resolution Mode" — Adapts to viewport, respects max quality"Crop on Resize Mode" — Scales proportionally to fit viewport
Bitrate and quality Parameter Type Default Valid values Description minBitratenumber11–100 Minimum bitrate (Mbps) maxBitratenumber1001–100 Maximum bitrate (Mbps) minQPnumber201–51 Min quantization (lower = better quality) maxQPnumber-1-1 or 1–51 Max quantization (-1 = no limit)
Parameter Type Default Valid values Description mouseInputbooleantruetrue, falseMouse clicks and movement keyBoardInputbooleantruetrue, falseKeyboard events touchInputbooleantruetrue, falseTouch events gamepadInputbooleantruetrue, falseGamepad/controller input xrInputbooleantruetrue, falseWebXR (VR/AR) input hoverMousebooleantruetrue, falseMouse hover events (no button press) fakeMouseWithTouchesbooleanfalsetrue, falseConvert touch to mouse events
Audio and camera Parameter Type Default Valid values Description useMicbooleantruetrue, falseEnable microphone input to UE useCamerabooleantruetrue, falseEnable camera input to UE
AFK Parameter Type Default Valid values Description afktimeoutnumber1201–7200 Idle timeout in seconds
Next steps
StreamPixelApplication SDK entry point signature and return value.
pixelStreaming API Methods and lifecycle events on the streaming instance.
