Skip to main content

index/interfaces/StreamStatusEvent.md

WebSocket event: stream_status

Emitted when stream status changes (goes live, ends, or status changes). This is the PRIMARY event for real-time stream state updates.

Since​

5.1.0 - Added based on backend review (HIGH PRIORITY)

Properties​

PropertyTypeDescription
aspectRatio?stringVideo aspect ratio (e.g., "16:9", "9:16") Only present when stream becomes ACTIVE, cleared when IDLE Since 5.5.0
isLivebooleanWhether stream is currently live
playbackIdstring | nullPlayback ID (null when not active)
statusStreamStatusCurrent stream status
tokenNamestringToken name (lowercase)