helix/io.github.captnblubber.twitchkt.helix.model/Stream

Stream

@Serializable

data class Stream(val id: String, val userId: String, val userLogin: String, val userName: String, val gameId: String = "", val gameName: String = "", val type: String = "", val title: String = "", val tags: List<String>? = null, val viewerCount: Int = 0, val startedAt: Instant? = null, val language: String = "", val thumbnailUrl: String = "", val isMature: Boolean = false)

Represents a live stream on Twitch.

Constructors

Stream

constructor(id: String, userId: String, userLogin: String, userName: String, gameId: String = "", gameName: String = "", type: String = "", title: String = "", tags: List<String>? = null, viewerCount: Int = 0, startedAt: Instant? = null, language: String = "", thumbnailUrl: String = "", isMature: Boolean = false)

Properties

gameId

@SerialName(value = "game_id")

val gameId: String

the ID of the category or game being played.

gameName

@SerialName(value = "game_name")

val gameName: String

the name of the category or game being played.

val id: String

an ID that identifies the stream. You can use this ID later to look up the video on demand (VOD).

isMature

@SerialName(value = "is_mature")

val ~~isMature~~: Boolean

Deprecated. This field is deprecated and returns only false.

language

val language: String

the language that the stream uses. This is an ISO 639-1 two-letter language code or other if the stream uses a language not in the list of supported stream languages.

startedAt

@SerialName(value = "started_at")

val startedAt: Instant?

the UTC date and time of when the broadcast began.

Stream

See also

Constructors

Properties