Overview
Properties
creationDate
Type: Date
The date when the video was created.
description
Type: string
The description of the video.
duration
Type: string
The duration of the video, as formatted by Twitch.
durationInSeconds
Type: number
The duration of the video, in seconds.
id
Type: string
The ID of the video.
isPublic
Type: boolean
Whether the video is public or not.
language
Type: string
The language of the video.
mutedSegmentData
The raw data of muted segments of the video.
publishDate
Type: Date
The date when the video was published.
streamId
Type: string | null
The ID of the stream this video belongs to.
Returns null if the video is not an archived stream.
thumbnailUrl
Type: string
The URL of the thumbnail of the video.
title
Type: string
The title of the video.
type
Type: HelixVideoTypeAliased type: "upload" | "archive" | "highlight"
The type of the video.
url
Type: string
The URL of the video.
userDisplayName
Type: string
The display name of the user who created the video.
userId
Type: string
The ID of the user who created the video.
userName
Type: string
The name of the user who created the video.
views
Type: number
The number of views of the video.
Methods
getUser()
asyncRetrieves information about the user who created the video.
isMutedAt(offset, duration, partial)
Checks whether the video is muted at a given offset or range.
| Parameter | Type | Required | Default | Description |
|---|
| offset | number | | none | The start of your range, in seconds from the start of the video,
or if no duration is given, the exact offset that is checked. |
| duration | number | | none | The duration of your range, in seconds. |
| partial | boolean | | false | Whether the range check is only partial. By default, this function returns true only if the passed range is entirely contained in a muted segment. |
Return type: boolean