Skip to main content

Class: Video

Represents a Video, usually returned from client.getVideo()

Hierarchy​

Implements​

  • VideoProperties

Properties​

captions​

• captions: null | VideoCaptions

Captions helper class of this video (if caption exists in this video)

Inherited from​

BaseVideo.captions

channel​

• channel: BaseChannel

The channel that uploaded this video

Implementation of​

VideoProperties.channel

Inherited from​

BaseVideo.channel

chapters​

• chapters: Chapter[]

Chapters on this video if exists

Implementation of​

VideoProperties.chapters

client​

• client: Client

An instance of Client

Implementation of​

VideoProperties.client

Inherited from​

BaseVideo.client

comments​

• comments: VideoComments

Continuable of videos inside a Video

Implementation of​

VideoProperties.comments

description​

• description: string

The description of this video

Implementation of​

VideoProperties.description

Inherited from​

BaseVideo.description

duration​

• duration: number

The duration of this video in second

Implementation of​

VideoProperties.duration

id​

• id: string

Implementation of​

VideoProperties.id

Inherited from​

BaseVideo.id

isLiveContent​

• isLiveContent: boolean

Whether this video is a live content or not

Implementation of​

VideoProperties.isLiveContent

Inherited from​

BaseVideo.isLiveContent

likeCount​

• likeCount: null | number

How many like does this video have, null if the like count is hidden

Implementation of​

VideoProperties.likeCount

Inherited from​

BaseVideo.likeCount

• related: VideoRelated

Continuable of videos / playlists related to this video

Inherited from​

BaseVideo.related

tags​

• tags: string[]

The tags of this video

Implementation of​

VideoProperties.tags

Inherited from​

BaseVideo.tags

thumbnails​

• thumbnails: Thumbnails

Thumbnails of the video with different sizes

Implementation of​

VideoProperties.thumbnails

Inherited from​

BaseVideo.thumbnails

title​

• title: string

The title of this video

Implementation of​

VideoProperties.title

Inherited from​

BaseVideo.title

uploadDate​

• uploadDate: string

The date this video is uploaded at

Implementation of​

VideoProperties.uploadDate

Inherited from​

BaseVideo.uploadDate

viewCount​

• viewCount: null | number

How many view does this video have, null if the view count is hidden

Implementation of​

VideoProperties.viewCount

Inherited from​

BaseVideo.viewCount

Accessors​

upNext​

• get upNext(): VideoCompact | PlaylistCompact

Video / playlist to play next after this video, alias to

video.related.items[0]

Returns​

VideoCompact | PlaylistCompact

Inherited from​

BaseVideo.upNext

Methods​

getTranscript​

▸ getTranscript(languageCode?): Promise<undefined | Caption[]>

Get Video transcript (if exists)

Deprecated

use video.captions.get() instead

Parameters​

NameType
languageCode?string

Returns​

Promise<undefined | Caption[]>