Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface VideoOptions

Hierarchy

  • VideoOptions

Index

Properties

Properties

Optional channel

channel?: YouTubeChannel

YouTube Video's uploader Channel Data

chapters

chapters: VideoChapter[]

The chapters for this video

If the video doesn't have any chapters or if the video object wasn't created by video_basic_info or video_info this will be an empty array.

Optional description

description?: string

YouTube Video description.

Optional discretionAdvised

discretionAdvised?: boolean

true if the video has been identified by the YouTube community as inappropriate or offensive to some audiences and viewer discretion is advised

durationInSec

durationInSec: number

YouTube Video Duration in seconds

durationRaw

durationRaw: string

YouTube Video Duration Formatted

Optional id

id?: string

YouTube Video ID

likes

likes: number

YouTube Video's likes

live

live: boolean

YouTube Video live status

Optional music

music?: VideoMusic[]

Gives info about music content in that video.

The property names of VideoMusic change depending on your region's language.

private

private: boolean

YouTube Video private status

tags

tags: string[]

YouTube Video tags

Optional thumbnail

thumbnail?: { height: undefined | number; url: undefined | string; width: undefined | number }

YouTube Thumbnail Data

Type declaration

  • height: undefined | number
  • url: undefined | string
  • width: undefined | number

Optional title

title?: string

YouTube Video title

Optional upcoming

upcoming?: true | Date

If the video is upcoming or a premiere that isn't currently live, this will contain the premiere date, for watch page playlists this will be true, it defaults to undefined

Optional uploadedAt

uploadedAt?: string

YouTube Video Uploaded Date

url

url: string

YouTube video url

views

views: number

YouTube Views

Generated using TypeDoc