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.

The full surface of the Streampixel Web SDK. Each page documents one object or function — its constructor, methods, events, and types.

Top-level entry

StreamPixelApplication

The factory function that boots a stream session. Start here.

Configuration options

Every option you can pass to StreamPixelApplication.

Returned objects

pixelStreaming

Core streaming controller — events, send/receive, lifecycle.

UIControl

Mute, fullscreen, resolution, mouse visibility, and other UI actions.

StreamPixelVoiceChat

Voice chat instance — join, leave, mute, and listen for events.

Helpers

reconnectStream

Trigger a manual reconnect after a dropped session.