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

Video

@Serializable

data class Video(val id: String, val streamId: String? = null, val userId: String, val userLogin: String, val userName: String, val title: String, val description: String = "", val createdAt: Instant, val publishedAt: Instant, val url: String, val thumbnailUrl: String, val viewable: String = "public", val viewCount: Int = 0, val language: String = "", val type: String = "", val duration: String = "", val mutedSegments: List<MutedSegment>? = null)

Represents a published video on Twitch.

Constructors

Video

constructor(id: String, streamId: String? = null, userId: String, userLogin: String, userName: String, title: String, description: String = "", createdAt: Instant, publishedAt: Instant, url: String, thumbnailUrl: String, viewable: String = "public", viewCount: Int = 0, language: String = "", type: String = "", duration: String = "", mutedSegments: List<MutedSegment>? = null)

Properties

createdAt

@SerialName(value = "created_at")

val createdAt: Instant

the date and time, in UTC, of when the video was created.

description

val description: String

the video's description.

duration

val duration: String

the video's length in ISO 8601 duration format. For example, 3m21s represents 3 minutes, 21 seconds.

val id: String

an ID that identifies the video.

language

val language: String

the ISO 639-1 two-letter language code that the video was broadcast in. The language value is other if the video was broadcast in a language not in the list of supported languages.

mutedSegments

@SerialName(value = "muted_segments")

val mutedSegments: List<MutedSegment>?

the segments that Twitch Audio Recognition muted; otherwise, null.

publishedAt

@SerialName(value = "published_at")

val publishedAt: Instant

the date and time, in UTC, of when the video was published.

streamId

@SerialName(value = "stream_id")

val streamId: String?

the ID of the stream that the video originated from if the video's type is archive; otherwise, null.

thumbnailUrl

@SerialName(value = "thumbnail_url")

val thumbnailUrl: String

a URL to a thumbnail image of the video. Before using the URL, you must replace the %{width} and %{height} placeholders with the width and height of the thumbnail you want returned.

title

val title: String

the video's title.

type

val type: String

the video's type. Possible values are: archive (VOD of a past stream), highlight (highlight reel of a past stream), upload (externally uploaded video).

url

val url: String

the video's URL.

userId