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

Clip

@Serializable

data class Clip(val id: String, val url: String, val embedUrl: String, val broadcasterId: String, val broadcasterName: String, val creatorId: String, val creatorName: String, val videoId: String = "", val gameId: String = "", val language: String = "", val title: String, val viewCount: Int = 0, val createdAt: Instant, val thumbnailUrl: String, val duration: Double = 0.0, val vodOffset: Int? = null, val isFeatured: Boolean = false)

Twitch API: Clip

Constructors

constructor(id: String, url: String, embedUrl: String, broadcasterId: String, broadcasterName: String, creatorId: String, creatorName: String, videoId: String = "", gameId: String = "", language: String = "", title: String, viewCount: Int = 0, createdAt: Instant, thumbnailUrl: String, duration: Double = 0.0, vodOffset: Int? = null, isFeatured: Boolean = false)

Properties

@SerialName(value = "broadcaster_id")

val broadcasterId: String

the broadcaster's user ID.

broadcasterName

@SerialName(value = "broadcaster_name")

val broadcasterName: String

the broadcaster's display name.

@SerialName(value = "created_at")

val createdAt: Instant

when the clip was created.

@SerialName(value = "creator_id")

val creatorId: String

the user ID of the clip creator.

@SerialName(value = "creator_name")

val creatorName: String

the display name of the clip creator.

val duration: Double

the clip duration in seconds.

@SerialName(value = "embed_url")

val embedUrl: String

the embeddable clip URL.

@SerialName(value = "game_id")

val gameId: String

the game/category ID.

the clip ID.

@SerialName(value = "is_featured")

val isFeatured: Boolean

whether the clip is featured.

val language: String

the language of the stream when the clip was created.

@SerialName(value = "thumbnail_url")

val thumbnailUrl: String

the clip thumbnail URL.

val title: String

the clip title.

val url: String

the clip URL.

@SerialName(value = "video_id")

val videoId: String

the VOD ID the clip was created from; empty if the VOD has been deleted.

@SerialName(value = "view_count")

val viewCount: Int

the number of times the clip has been viewed.

@SerialName(value = "vod_offset")

val vodOffset: Int?

the offset in the VOD where the clip starts; null if unknown.