TwitchClipInfo interface
Information about a Twitch clip
Signature:
export interface TwitchClipInfo
Remarks
This is the same data as the Twitch API provides with the addition of:
isValid
which you must check in the response to ensure the input was valid and Twitch was able to find the data
videoUrl
which you can pass to VideoComponent.prepareVideo() to play the clip
Properties
Property | Modifiers | Type | Description |
---|---|---|---|
broadcasterId | readonly | string | Id of the user who's stream the clip was created from |
broadcasterName | readonly | string | Display name of the user who's stream the clip was created from |
createdAt | readonly | Date | The time at which the clip was created |
creatorId | readonly | string | Id of the user who created the clip |
creatorName | readonly | string | Display name of the user who created the clip |
duration | readonly | number | Duration of the Clip in seconds (up to 0.1 precision) |
embedUrl | readonly | string | URL to embed the clip |
gameId | readonly | string | Id of the game featured in this clip |
id | readonly | string | Twitch id of the clip |
isValid | readonly | boolean | False if the request failed Could be a service / network outage but more likely the input was invalid |
language | readonly | string | Language of the stream from which the clip was created. A language value is either the ISO 639-1 two-letter code for a supported stream language or “other” |
thumbnailUrl | readonly | string | URL of the clip thumbnail |
title | readonly | string | Title of the clip |
url | readonly | string | URL where the clip can be viewed |
videoUrl | readonly | string | URL of the clip video |
viewCount | readonly | number | Number of times the clip has been viewed |
TwitchClipInfo.broadcasterId property
Id of the user who's stream the clip was created from
Signature:
readonly broadcasterId: string;
TwitchClipInfo.broadcasterName property
Display name of the user who's stream the clip was created from
Signature:
readonly broadcasterName: string;
TwitchClipInfo.createdAt property
The time at which the clip was created
Signature:
readonly createdAt: Date;
TwitchClipInfo.creatorId property
Id of the user who created the clip
Signature:
readonly creatorId: string;
TwitchClipInfo.creatorName property
Display name of the user who created the clip
Signature:
readonly creatorName: string;
TwitchClipInfo.duration property
Duration of the Clip in seconds (up to 0.1 precision)
Signature:
readonly duration: number;
TwitchClipInfo.embedUrl property
URL to embed the clip
Signature:
readonly embedUrl: string;
TwitchClipInfo.gameId property
Id of the game featured in this clip
Signature:
readonly gameId: string;
TwitchClipInfo.id property
Twitch id of the clip
Signature:
readonly id: string;
TwitchClipInfo.isValid property
False if the request failed
Could be a service / network outage but more likely the input was invalid
Signature:
readonly isValid: boolean;
TwitchClipInfo.language property
Language of the stream from which the clip was created. A language value is either the ISO 639-1 two-letter code for a supported stream language or “other”
Signature:
readonly language: string;
TwitchClipInfo.thumbnailUrl property
URL of the clip thumbnail
Signature:
readonly thumbnailUrl: string;
TwitchClipInfo.title property
Title of the clip
Signature:
readonly title: string;
TwitchClipInfo.url property
URL where the clip can be viewed
Signature:
readonly url: string;
TwitchClipInfo.videoUrl property
URL of the clip video
Signature:
readonly videoUrl: string;
TwitchClipInfo.viewCount property
Number of times the clip has been viewed
Signature:
readonly viewCount: number;
Updated 7 months ago