index/interfaces/StreamInfo.md
Stream information returned from GET /live/:tokenName
Properties
| Property | Type | Description |
|---|---|---|
aspectRatio? | string | Video aspect ratio (e.g., "16:9", "9:16") Captured from Mux when stream goes active Since 5.5.0 |
createdAt | string | Stream creation timestamp (ISO 8601) |
creatorAddress | AddressFormat | Creator wallet address |
description? | string | Stream description |
enabled | boolean | Whether streaming is enabled for this token |
isLive | boolean | Whether the stream is currently live |
language? | string | Stream language (ISO 639-1 code, e.g., "en", "es", "ja") Consolidated from /stream/settings endpoint Note: Field name is 'language' to match backend (not 'streamLanguage') Since 5.7.0 |
nextLiveStreamAt? | string | null | Next scheduled live stream time (ISO 8601 string) or null if not set Consolidated from /stream/settings endpoint Since 5.7.0 |
playbackId | string | null | Playback ID for viewers (available when stream is active) |
status | StreamStatus | Current stream status |
streamKey? | string | Stream key for broadcasting (only available to stream owner) |
title? | string | Stream title |
tokenName | string | Token name (lowercase) |
updatedAt | string | Last update timestamp (ISO 8601) |
viewerCount? | number | Current viewer count |
aspect ratio created at creator address format is live next stream playback id status key token name updated viewer count