Overview
Properties
displayName
Type: string
The display name of the channel.
gameId
Type: string
The ID of the game currently played on the channel.
gameName
Type: string
The name of the game currently played on the channel.
id
Type: string
The ID of the channel.
isLive
Type: boolean
Whether the channel is currently live.
language
Type: string
The language of the channel.
name
Type: string
The name of the channel.
startDate
Type: Date | null
The start date of the stream. Returns null
if the stream is not live.
tagIds
Type: Array<string>
The IDs of the tags set on the channel.
thumbnailUrl
Type: string
The thumbnail URL of the stream.
Methods
getGame()
asyncRetrieves information about the game that is being played on the stream.
getUser()
asyncRetrieves additional information about the owner of the channel.