Clip

Represents a Twitch clip.

Extends

• BaseClip<T>

Type parameters

Type parameter
T extends EventSubConnection

Constructors

new Clip()

new Clip<T>(chatbot: ChatBot<T>, data: GetClip): Clip<T>

Creates a new instance of the clip.

Parameters

Parameter	Type	Description
chatbot	ChatBot<T>	The current instance of the chatbot.
data	GetClip	The data of the clip returned from the API.

Returns

Clip<T>

Overrides

BaseClip.constructor

Source

twitchfy/packages/chatbot/src/structures/Clip.ts:78

Properties

Property	Modifier	Type	Description	Inherited from
broadcaster	readonly	BaseUserWithoutUsername<T>	The user who broadcasted the clip. The user will not have an username because Twitch limitations.	-
chatbot	readonly	ChatBot<T>	The current instance of the chatbot.	BaseClip.chatbot
creator	readonly	BaseUserWithoutUsername<T>	The user who created the clip. The user will not have an username because Twitch limitations.	-
duration	readonly	number	The duration of the clip in seconds.	-
embedURL	readonly	string	The URL to embed the clip in a frame.	-
gameId	readonly	string	The Id of the game which was played in the clip.	-
id	readonly	string	The id of the clip.	BaseClip.id
isFeatured	readonly	boolean	Whether the clip is featured.	-
language	readonly	string	The language of the clip.	-
thumbnailURL	readonly	string	The URL to the thumbnail of the clip.	-
title	readonly	string	The title of the clip.	-
url	readonly	string	The url of the clip.	BaseClip.url
viewCount	readonly	number	The view count of the clip.	-
vodOffset	readonly	null | number	The offset in the VOD where the clip starts. If the clip is not from a VOD, this will be null.	-

Accessors

createdAt

get createdAt(): Date

When the clip was created. Returns a JavaScript Date object.

Returns

Date

Source

twitchfy/packages/chatbot/src/structures/Clip.ts:97

---

videoId

get videoId(): null | string

The Id of the video of the clip.

Returns

null | string

Source

twitchfy/packages/chatbot/src/structures/Clip.ts:104

Methods

download()

download(): Promise<object>

Downloads the clip’s video data. For this to work, the bot has to be an editor of the clip’s channel and the user token must have the editor:manage:clips scope or channel:manage:clips if the bot is the broadcaster of the channel.

Returns

Promise<object>

An object of buffers containing the clip’s video data in either portrait or landscape format. The field is null if the download URL doesn’t exist or the fetch fails.

Member	Type
landscape	null | Buffer
portrait	null | Buffer

Source

twitchfy/packages/chatbot/src/structures/Clip.ts:142

---

fetch()

fetch(): Promise<null | Clip<T>>

Fetches the information of the clip from the API.

Returns

Promise<null | Clip<T>>

The fetched clip. Returns null if the clip was not found (probably because it was not cached yet).

Inherited from

BaseClip.fetch

Source

twitchfy/packages/chatbot/src/structures/BaseClip.ts:47

---

getDownloadURL()

getDownloadURL(): Promise<object>

Fetches the download URLs of the clip. Either landscape or portrait. For this to work, the bot has to be an editor of the clip’s channel and the user token must have the editor:manage:clips scope or channel:manage:clips if the bot is the broadcaster of the channel.

Returns

Promise<object>

An object with each download URL. The field is null if the download URL doesn’t exist.

Member	Type
landscape	null | string
portrait	null | string

Source

twitchfy/packages/chatbot/src/structures/Clip.ts:130

---

stream()

stream(): Promise<null | Stream<T>>

Fetches the stream of the broadcaster of the clip.

Returns

Promise<null | Stream<T>>

The stream of the broadcaster of the clip. If the stream is offline, it will return null.

Source

twitchfy/packages/chatbot/src/structures/Clip.ts:121

---

toString()

toString(): string

Returns

string

The url of the clip.

Inherited from

BaseClip.toString

Source

twitchfy/packages/chatbot/src/structures/BaseClip.ts:39

---

video()

video(): Promise<null | Video<T>>

Fetches the video of the clip.

Returns

Promise<null | Video<T>>

The video of the clip. Returns null if the video doesn’t exist.

Source

twitchfy/packages/chatbot/src/structures/Clip.ts:112