Skip to main content

Interface: StreamStatusEvent

Gala Launchpad SDK 9.0.0-rc.5


Gala Launchpad SDK 9.0.0-rc.5 / index / StreamStatusEvent

Interface: StreamStatusEvent

Defined in: packages/launchpad-sdk/dist/types/streaming.dto.d.ts:289

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​

aspectRatio?​

optional aspectRatio?: string

Defined in: packages/launchpad-sdk/dist/types/streaming.dto.d.ts:303

Video aspect ratio (e.g., "16:9", "9:16") Only present when stream becomes ACTIVE, cleared when IDLE

Since​

5.5.0


isLive​

isLive: boolean

Defined in: packages/launchpad-sdk/dist/types/streaming.dto.d.ts:297

Whether stream is currently live


playbackId​

playbackId: string | null

Defined in: packages/launchpad-sdk/dist/types/streaming.dto.d.ts:295

Playback ID (null when not active)


status​

status: StreamStatus

Defined in: packages/launchpad-sdk/dist/types/streaming.dto.d.ts:293

Current stream status


tokenName​

tokenName: string

Defined in: packages/launchpad-sdk/dist/types/streaming.dto.d.ts:291

Token name (lowercase)