This page covers the SDK’s built-in overlay components, how to hide them, and how to build your own UI driven by SDK events.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.
Built-in overlays
The SDK includes several overlay components inherited from the Epic Games Pixel Streaming UI library:| Overlay | Purpose |
|---|---|
ConnectOverlay | Shown during initial connection |
DisconnectOverlay | Shown when the stream disconnects, with reconnect option |
AFKOverlay | Shown during AFK warning countdown |
PlayOverlay | Shown before the stream starts (click to play) |
InfoOverlay | Generic information text display |
ErrorOverlay | Error messages |
Hiding default overlays
Most applications replace the default overlays with custom UI. The built-in overlays are useful for prototyping, but you will typically hide them and build your own for production.
Showing overlays programmatically
The SDK provides methods to show overlays:Building custom UI
Instead of using the built-in overlays, build your own UI components and drive them with SDK events. This gives you full control over appearance and behavior.Custom controls toolbar
Custom AFK warning
See AFK (idle timeout) for a complete custom AFK overlay example.Custom loading screen
See Custom loading screen for building a loading screen driven by lifecycle events.CSS class reference (from example app)
The example app uses these CSS classes that you can reference or adapt:Loading screen
.loading-overlay— Full-screen loading container.loading-spinner— CSS spinner animation.loading-title— Main heading.loading-subtitle— Description text.loading-progress-track— Progress bar track.loading-progress-fill— Progress bar fill (animated width).loading-status— Current status message.loading-queue— Queue position container.loading-queue-badge— Queue position number badge
Stream controls
.stream-controls— Controls container (fixed, bottom-right).control-btn— Individual control button.control-btn-active— Active state for toggle buttons
Stats popup
.stats-popup— Stats panel container.stats-row— Individual stat row.stats-label— Stat name.stats-value— Stat value
AFK warning
.afk-overlay— Full-screen AFK backdrop.afk-card— Warning card.afk-countdown— Countdown number.afk-btn— Dismiss button
Settings
.settings-popup— Settings panel.settings-option— Individual option.settings-option-active— Currently selected option
Developer tools
.dev-tools-popup— Dev tools panel.dev-tools-section— Grouped section.dev-tools-input— Text input field.dev-tools-btn— Action button
Next steps
Custom loading screen
Build a loading screen driven by lifecycle events.
Example app walkthrough
See custom overlays and toolbars in a working app.