Overview
Properties
gameId
Type: string
The game ID, or an empty string if the stream doesn't currently have a game.
gameName
Type: string
The game name, or an empty string if the stream doesn't currently have a game.
id
Type: string
The stream ID.
isMature
Type: boolean
Whether the stream is set to be targeted to mature audiences only.
language
Type: string
The language of the stream.
startDate
Type: Date
The time when the stream started.
tagIds
Type: Array<string>
The IDs of the tags of the stream.
thumbnailUrl
Type: string
The URL of the thumbnail of the stream.
title
Type: string
The title of the stream.
type
The type of the stream.
userDisplayName
Type: string
The user's display name.
userId
Type: string
The user ID.
userName
Type: string
The user's name.
viewers
Type: number
The number of viewers the stream currently has.
Methods
getGame()
asyncRetrieves information about the game that is being played on the stream.
Returns null if the stream doesn't currently have a game.
getThumbnailUrl(width, height)
Builds the thumbnail URL of the stream using the given dimensions.
| Parameter | Type | Required | Default | Description |
|---|
| width | number | | none | The width of the thumbnail. |
| height | number | | none | The height of the thumbnail. |
Return type: string
getUser()
asyncRetrieves information about the user broadcasting the stream.