twitcheasy-twitch-bottwitch-authtwitch-auth-tmitwitch-chat-clienttwitch-eventsubtwitch-pubsub-clienttwitch-webhooks
Welcome

HelixStream

A Twitch stream.

Overview

Properties

gameId

Type: string

The game ID.

gameName

Type: string

The game name.

id

Type: string

The stream ID.

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

Type: HelixStreamType

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()

async

Retrieves information about the game that is being played on the stream.

Return type: HelixGame | null

getTags()

async

Retrieves the tags of the stream.

Return type: Array<HelixTag>

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()

async

Retrieves information about the user broadcasting the stream.

Return type: HelixUser | null