youtubei.js / YTKids / VideoInfo

new VideoInfo(data, actions, cpn): VideoInfo

Defined in: src/parser/ytkids/VideoInfo.ts:17

Parameters

data

[ApiResponse, ApiResponse?]

actions

Actions

cpn

string

Returns

VideoInfo

Overrides

MediaInfo.constructor

Properties

annotations?

optional annotations?: ObservedArray<PlayerAnnotationsExpanded>

Defined in: src/core/mixins/MediaInfo.ts:40

Inherited from

MediaInfo.annotations

basic_info

basic_info: object

Defined in: src/core/mixins/MediaInfo.ts:39

allow_ratings?

optional allow_ratings?: boolean

author?

optional author?: string

channel

channel: { id: string; name: string; url: string; } | null

channel_id?

optional channel_id?: string

duration?

optional duration?: number

embed

embed: { flash_secure_url: string; flash_url: string; height: any; iframe_url: string; width: any; } | null | undefined

end_timestamp

end_timestamp: Date | null

has_ypc_metadata

has_ypc_metadata: boolean | null

id?

optional id?: string

is_crawlable?

optional is_crawlable?: boolean

is_disliked

is_disliked: boolean | undefined

is_family_safe

is_family_safe: boolean | undefined = info.microformat.is_family_safe

is_liked

is_liked: boolean | undefined

is_live?

optional is_live?: boolean

is_live_content?

optional is_live_content?: boolean

is_live_dvr_enabled?

optional is_live_dvr_enabled?: boolean

is_low_latency_live_stream?

optional is_low_latency_live_stream?: boolean

is_owner_viewing?

optional is_owner_viewing?: boolean

is_post_live_dvr?

optional is_post_live_dvr?: boolean

is_private?

optional is_private?: boolean

is_unlisted

is_unlisted: boolean | undefined = info.microformat.is_unlisted

is_upcoming?

optional is_upcoming?: boolean

keywords?

optional keywords?: string[]

like_count

like_count: number | undefined

live_chunk_readahead?

optional live_chunk_readahead?: number

publish_date

publish_date: string | null

short_description?

optional short_description?: string

start_timestamp

start_timestamp: Date | null

thumbnail?

optional thumbnail?: Thumbnail[]

title?

optional title?: string

upload_date

upload_date: string | null

url_canonical

url_canonical: string | null

view_count

view_count: number | undefined

Inherited from

MediaInfo.basic_info

captions?

optional captions?: PlayerCaptionsTracklist

Defined in: src/core/mixins/MediaInfo.ts:43

Inherited from

MediaInfo.captions

cards?

optional cards?: CardCollection

Defined in: src/core/mixins/MediaInfo.ts:44

Inherited from

MediaInfo.cards

current_video_endpoint?

optional current_video_endpoint?: NavigationEndpoint

Defined in: src/parser/ytkids/VideoInfo.ts:14

endscreen?

optional endscreen?: Endscreen

Defined in: src/core/mixins/MediaInfo.ts:42

Inherited from

MediaInfo.endscreen

playability_status?

optional playability_status?: IPlayabilityStatus

Defined in: src/core/mixins/MediaInfo.ts:46

Inherited from

MediaInfo.playability_status

player_config?

optional player_config?: IPlayerConfig

Defined in: src/core/mixins/MediaInfo.ts:47

Inherited from

MediaInfo.player_config

player_overlays?

optional player_overlays?: PlayerOverlay

Defined in: src/parser/ytkids/VideoInfo.ts:15

slim_video_metadata?

optional slim_video_metadata?: SlimVideoMetadata

Defined in: src/parser/ytkids/VideoInfo.ts:12

storyboards?

optional storyboards?: PlayerStoryboardSpec | PlayerLiveStoryboardSpec

Defined in: src/core/mixins/MediaInfo.ts:41

Inherited from

MediaInfo.storyboards

streaming_data?

optional streaming_data?: IStreamingData

Defined in: src/core/mixins/MediaInfo.ts:45

Inherited from

MediaInfo.streaming_data

watch_next_feed?

optional watch_next_feed?: ObservedArray<YTNode>

Defined in: src/parser/ytkids/VideoInfo.ts:13

Accessors

actions

Get Signature

get actions(): Actions

Defined in: src/core/mixins/MediaInfo.ts:249

Returns

Actions

Inherited from

MediaInfo.actions

cpn

Get Signature

get cpn(): string

Defined in: src/core/mixins/MediaInfo.ts:256

Content Playback Nonce.

Returns

string

Inherited from

MediaInfo.cpn

Methods

addToWatchHistory()

addToWatchHistory(client_name?, client_version?, replacement?): Promise<Response>

Defined in: src/core/mixins/MediaInfo.ts:210

Parameters

client_name?

string

client_version?

string

replacement?

string = 'https://www.'

Returns

Promise<Response>

Inherited from

MediaInfo.addToWatchHistory

chooseFormat()

chooseFormat(options): Format

Defined in: src/core/mixins/MediaInfo.ts:163

Selects the format that best matches the given options.

Parameters

options

FormatOptions

Options

Returns

Format

Inherited from

MediaInfo.chooseFormat

download()

download(options?): Promise<ReadableStream<Uint8Array<ArrayBufferLike>>>

Defined in: src/core/mixins/MediaInfo.ts:171

Downloads the video.

Parameters

options?

DownloadOptions = {}

Download options.

Returns

Promise<ReadableStream<Uint8Array<ArrayBufferLike>>>

Inherited from

MediaInfo.download

getStreamingInfo()

getStreamingInfo(url_transformer?, format_filter?): Promise<StreamingInfo>

Defined in: src/core/mixins/MediaInfo.ts:146

Get a cleaned up representation of the adaptive_formats

Parameters

url_transformer?

URLTransformer

format_filter?

FormatFilter

Returns

Promise<StreamingInfo>

Inherited from

MediaInfo.getStreamingInfo

getTranscript()

getTranscript(): Promise<TranscriptInfo>

Defined in: src/core/mixins/MediaInfo.ts:184

Retrieves the video's transcript.

Returns

Promise<TranscriptInfo>

Inherited from

MediaInfo.getTranscript

toDash()

toDash(options?): Promise<string>

Defined in: src/core/mixins/MediaInfo.ts:106

Generates a DASH manifest from the streaming data.

Parameters

options?

format_filter?

FormatFilter

manifest_options?

DashOptions

url_transformer?

URLTransformer

Returns

Promise<string>

DASH manifest

Inherited from

MediaInfo.toDash

updateWatchTime()

updateWatchTime(startTime, client_name?, client_version?, replacement?): Promise<Response>

Defined in: src/core/mixins/MediaInfo.ts:229

Parameters

startTime

number

client_name?

string = Constants.CLIENTS.WEB.NAME

client_version?

string = Constants.CLIENTS.WEB.VERSION

replacement?

string = 'https://www.'

Returns

Promise<Response>

Inherited from

MediaInfo.updateWatchTime