Overview
Properties
Methods
Properties
thumbnailUrl
Type: string
The URL of the thumbnail of the stream.
This URL includes the placeholders {width}
and {height}
which you must replace with the desired dimensions of the thumbnail (in pixels).
You can also use HelixStream#getThumbnailUrl to do this replacement.
Methods
getGame()
asyncGets information about the game that is being played on the stream.
Returns null if the stream doesn't currently have a game.
Return type: HelixGame | null
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