Overview
Properties
averageFps
Type:
number
The average FPS (frames per second) that are shown on the
stream.
channel
The channel where the stream is shown.
delay
Type:
number
The delay of the stream, in seconds.
game
Type:
string
The game played on the stream.
id
Type:
string
The ID of the stream.
isPlaylist
Type:
boolean
Whether the stream is running a playlist.
startDate
Type:
Date
The time when the stream started.
type
The type of the stream.
videoHeight
Type:
number
The height of the stream video.
viewers
Type:
number
The current number of concurrent viewers.
Methods
getPreviewUrl(size)
Gets the URL of a preview image for the stream.
| Parameter |
Type |
Required |
Default |
Description |
| size |
StreamPreviewSize
The possible sizes for a stream preview.
Aliased type:
"small"
|
"medium"
|
"large"
|
"template"
|
|
none |
The size of the image. |
Return type:
string