Skip to main content

index/interfaces/StreamInfo.md

Stream information returned from GET /live/:tokenName

Properties​

PropertyTypeDescription
aspectRatio?stringVideo aspect ratio (e.g., "16:9", "9:16") Captured from Mux when stream goes active Since 5.5.0
createdAtstringStream creation timestamp (ISO 8601)
creatorAddressAddressFormatCreator wallet address
description?stringStream description
enabledbooleanWhether streaming is enabled for this token
isLivebooleanWhether the stream is currently live
language?stringStream 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 | nullNext scheduled live stream time (ISO 8601 string) or null if not set Consolidated from /stream/settings endpoint Since 5.7.0
playbackIdstring | nullPlayback ID for viewers (available when stream is active)
statusStreamStatusCurrent stream status
streamKey?stringStream key for broadcasting (only available to stream owner)
title?stringStream title
tokenNamestringToken name (lowercase)
updatedAtstringLast update timestamp (ISO 8601)
viewerCount?numberCurrent viewer count