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.

Configure from Project Settings → Session Rules. These limits apply to every viewer of your project — regardless of whether they connect via the share link, an iframe, or the Web SDK.

​
Max runtime

How long a single session can stay connected before being disconnected automatically.
PropertyValue
Default30 minutes
Range1 – 1440 minutes (24 hours max)
When a session hits the limit, the viewer is disconnected with code 4004 (max runtime reached). Use this to prevent forgotten tabs from holding a worker indefinitely.

​
Inactivity timeout (AFK)

How long a viewer can go without input before being disconnected.
PropertyValue
Default300 seconds (5 minutes)
Range1 – 7200 seconds (2 hours max)
Inactivity is measured from the last input event (mouse, keyboard, touch, gamepad). When the timeout fires, the viewer is disconnected — freeing the worker for the next person in queue.
Set the inactivity timeout aggressively if your CCU is constrained. An idle viewer holds a full GPU worker.

​
Auto-delete cache

A toggle in the same Session Rules tab. When on, locally cached application data is cleared at the end of every session. Use it for privacy-sensitive deployments (configurators with customer data, kiosk demos, internal tools) where you don’t want the next viewer to inherit anything.

​
Where these rules apply

These are project-level settings stored on Streampixel. You don’t need to set them again in your iframe or SDK code — they’re enforced server-side, on every session, no matter how the viewer connected. The Web SDK does expose hooks (AFK / idle timeout) so you can show a custom warning UI before the disconnect, but the underlying timeout is the one set here.

​
Next

Disconnect codes

What 4004 and other codes mean.

AFK timeout in the SDK

Hook into idle/disconnect events for a custom UI.