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.

Built-in voice and text chat lets viewers in the same room talk to each other while watching your stream. Configure from Project Settings → Communication.

​
Settings

SettingOptionsWhat it does
Text ChatOn / OffReal-time message window.
Voice ChatOn / OffLow-latency voice over WebRTC.
Chat UI PositionLeft / RightSide of the screen.
Chat UI ThemeLight / DarkMatch your branding.
Mute on EntryOn / OffAuto-mute mics when users join.
Startup BehaviorOn Session Begin / On App TriggerWhen the chat UI appears.

​
Startup behavior

OptionBehavior
On Session BeginChat UI appears as soon as the stream starts. Streampixel auto-assigns a temporary name and avatar if you don’t provide one.
On App TriggerChat UI only appears when triggered from your Unreal app, iframe, or Web SDK. Use this when you want to set the user’s identity first.

​
Programmatic control

To start or stop chat at runtime — and pass a real display name, avatar, and room — set Startup Behavior to On App Trigger and send a JSON message from your Unreal app or frontend.

​
Connect

{
  "message": {
    "type": "comms",
    "value": {
      "name": "Alice",
      "pfpUrl": "https://example.com/avatar.jpg",
      "roomId": "room-123"
    }
  }
}
FieldPurpose
nameDisplay name shown in chat.
pfpUrlAvatar URL shown next to messages.
roomIdUsers with the same roomId see each other. Omit for one-room-per-project.

​
Disconnect

{
  "message": {
    "type": "comms",
    "value": "disconnect"
  }
}

​
Sending the message

Use the Send Pixel Streaming Response Blueprint node with the JSON as a string.
JSON must be exact — missing quotes or brackets break the parser.