Overview
Properties
channelDisplayName
Type: string
The display name of the channel the video was uploaded to.
channelId
Type: string
The ID of the channel the video was uploaded to.
channelName
Type: string
The name of the channel the video was uploaded to.
creationDate
Type: Date
The date when the video was created.
description
Type: string
The description of the video.
gameName
Type: string
The name of the game shown in the video.
htmlDescription
Type: string
The description of the video in HTML.
id
Type: string
The ID of the video.
isPublic
Type: boolean
Whether the video is public.
language
Type: string
The language of the video.
length
Type: number
The length of the video, in seconds.
mutedSegments
Type: Array<VideoMutedSegment>
The muted segments of the video.
publishDate
Type: Date
The date when the video was published.
resolutions
Type: Record<string, string>
The resolutions the video is available in.
status
Type: string
The status of the video.
title
Type: string
The title of the video.
url
Type: string
The URL of the video.
viewabilityDate
Type: Date | null
The time when the video will be viewable publicly.
views
Type: number
The number of views of the video.
Methods
getChannel()
asyncRetrieves more information about the channel the video was uploaded to.
getFps(resolution)
Gets the FPS (frames per second) of the video for a given resolution.
| Parameter | Type | Required | Default | Description |
|---|
| resolution | string | | none | The resolution to get FPS for. This is the key of the resolutions object. |
Return type: ?number
getPreview(size)
Gets the URL for a given size of the video.
| Parameter | Type | Required | Default | Description |
|---|
| size | VideoThumbSize | | none | The size of the preview. |
Return type: string
getThumbnails(size)
Gets a list of thumbnails for a given size of the video.
| Parameter | Type | Required | Default | Description |
|---|
| size | VideoThumbSize | | none | |
Return type: Array<VideoThumbnail>