youtubei.js / Mixins / MediaInfo

Class: MediaInfo

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

Extended by

Constructors

Constructor

new MediaInfo(data, actions, cpn): MediaInfo

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

Parameters

data

[ApiResponse, ApiResponse?]

actions

Actions

cpn

string

Returns

MediaInfo

Properties

annotations?

optional annotations: ObservedArray<PlayerAnnotationsExpanded>

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

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

short_description?

optional short_description: string

start_timestamp

start_timestamp: Date | null

thumbnail?

optional thumbnail: Thumbnail[]

title?

optional title: string

url_canonical

url_canonical: string | null

view_count

view_count: number | undefined

captions?

optional captions: PlayerCaptionsTracklist

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

cards?

optional cards: CardCollection

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

endscreen?

optional endscreen: Endscreen

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

playability_status?

optional playability_status: IPlayabilityStatus

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

player_config?

optional player_config: IPlayerConfig

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

storyboards?

optional storyboards: PlayerStoryboardSpec | PlayerLiveStoryboardSpec

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

streaming_data?

optional streaming_data: IStreamingData

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

Accessors

actions

Get Signature

get actions(): Actions

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

Returns

Actions

cpn

Get Signature

get cpn(): string

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

Content Playback Nonce.

Returns

string

Methods

addToWatchHistory()

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

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

Parameters

client_name?

string

client_version?

string

replacement?

string = 'https://www.'

Returns

Promise<Response>

chooseFormat()

chooseFormat(options): Format

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

Selects the format that best matches the given options.

Parameters

options

FormatOptions

Options

Returns

Format

download()

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

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

Downloads the video.

Parameters

options

DownloadOptions = {}

Download options.

Returns

Promise<ReadableStream<Uint8Array>>

getStreamingInfo()

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

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

Get a cleaned up representation of the adaptive_formats

Parameters

url_transformer?

URLTransformer

format_filter?

FormatFilter

Returns

Promise<StreamingInfo>

getTranscript()

getTranscript(): Promise<TranscriptInfo>

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

Retrieves the video's transcript.

Returns

Promise<TranscriptInfo>

toDash()

toDash(options): Promise<string>

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

Generates a DASH manifest from the streaming data.

Parameters

options

format_filter?

FormatFilter

manifest_options?

DashOptions

url_transformer?

URLTransformer

Returns

Promise<string>

DASH manifest

updateWatchTime()

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

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

Parameters

startTime

number

client_name

string = Constants.CLIENTS.WEB.NAME

client_version

string = Constants.CLIENTS.WEB.VERSION

replacement

string = 'https://www.'

Returns

Promise<Response>