Skip to main content

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.

This page lists common SDK issues, their symptoms, and solutions.

​
Black screen / no video

Symptom: The stream connects but the video area is black or empty.
Solutions:
  • Verify your appId is correct and the project is active in the Streampixel dashboard
  • Ensure the UE application is running and connected
  • Check that you’re appending appStream.rootElement in the onVideoInitialized callback
  • Inspect the DOM to confirm a <video> element exists and has a srcObject

​
Audio not working

Symptom: Stream is playing but there’s no sound.
Solutions:
  • The SDK creates two media elements (video and audio). Both must be unmuted: 
    const video = appStream.stream.videoElementParent.querySelector('video');
const audio = appStream.stream._webRtcController?.streamController?.audioElement;
video.muted = false;
audio.muted = false;
if (audio.paused) audio.play().catch(() => {});
  • Browser autoplay policy requires a user gesture before playing audio. Unmute in response to a button click
  • Use UIControl.toggleAudio() as a shortcut

​
Connection fails behind firewall

Symptom: Connection stalls at “Establishing WebRTC connection…” or “Negotiating stream parameters…”
Solutions:
  • Ensure forceTurn: true is set (this is the default). TURN relays bypass most firewalls
  • Corporate firewalls may block WebSocket connections on non-standard ports. Check with your IT team
  • Verify the browser allows WebRTC (some enterprise browsers disable it)

​
Default Pixel Streaming UI showing through

Symptom: You see unfamiliar buttons, panels, or overlays from the default PS UI.
Solutions:
  • Add CSS to hide the default UI: 
    #uiFeatures { display: none !important; }
#afkOverlay { display: none !important; }
  • Also hide programmatically after initialization: 
    const uiEl = appStream.rootElement?.querySelector('#uiFeatures');
if (uiEl) uiEl.style.display = 'none';
  • The #uiFeatures element may re-appear after onVideoInitialized, so hide it in that callback too

​
Video codec shows raw ID instead of name

Symptom: Stats show something like RTCCodec_1_Inbound_120 instead of H264.
Solution: Resolve the codec ID from the codecs Map: 
pixelStreaming.addEventListener('statsReceived', (e) => {
  const stats = e.data.aggregatedStats;
  const codecId = stats.inboundVideoStats.codecId;
  const codec = stats.codecs.get(codecId);
  console.log('Codec:', codec?.mimeType); // "video/H264"
});

​
Webpack polyfill errors

Symptom: Build errors like Module not found: Error: Can't resolve 'crypto' or similar.
Solution: The SDK requires Node.js polyfills for browser use. See the Installation page for the complete config-overrides.js setup.

​
”StreamPixelApplication called more than once”

Symptom: Console warning and SDK returns empty object {}.
Solution: StreamPixelApplication is a singleton — it can only be initialized once per page. This commonly happens in React when:
  • The component re-renders and calls StreamPixelApplication again
  • useEffect dependencies change, triggering reinitialization
Fix: Use a ref or flag to ensure single initialization: 
const initialized = useRef(false);

useEffect(() => {
  if (initialized.current) return;
  initialized.current = true;

  StreamPixelApplication({ appId }).then(/* ... */);
}, [appId]);

​
Reconnection not working

Symptom: After a disconnect, the SDK doesn’t attempt to reconnect.
Solutions:
  • Automatic reconnection only triggers for WebSocket close codes 1005 and 1006 (abnormal closures). All other codes (project inactive, max runtime, etc.) are intentional disconnects
  • The reconnection window is 60 seconds. If the server doesn’t respond within that time, reconnection fails with code 4007
  • Listen to reconnectStream.on('state', ...) to see the exact state transitions and codes

​
Mobile disconnects when switching apps

Symptom: On iOS/Android, the stream disconnects when the user switches to another app.
Explanation: This is intentional. The SDK disconnects after 60 seconds of the browser tab being hidden to free resources. When the user returns within 60 seconds, the stream continues normally. After 60 seconds, they will need to reconnect.

​
Stream works locally but not in production

Symptom: Everything works on localhost but fails when deployed.
Solutions:
  • The SDK validates window.location.origin against the project’s allowed URLs list in the dashboard. Add your production domain to the validPathUrl setting
  • localhost is always allowed for development
  • Wildcard patterns are supported (e.g., *.example.com)

​
Next steps

reconnectStream API

Inspect reconnection state and disconnect codes.

Stream statistics

Use stats to diagnose codec, bitrate, and packet loss issues.