youtubei.js / YTShorts / ShortFormVideoInfo

Class: ShortFormVideoInfo

Extends

MediaInfo

Constructors

new ShortFormVideoInfo()

new ShortFormVideoInfo(data, actions, cpn, reel_watch_sequence_response): ShortFormVideoInfo

Parameters

• data: [ApiResponse, ApiResponse?]

• actions: Actions

• cpn: string

• reel_watch_sequence_response: ApiResponse

Properties

annotations?

optional annotations: ObservedArray<PlayerAnnotationsExpanded>

Inherited from

MediaInfo.annotations

Defined in

src/core/mixins/MediaInfo.ts:31

basic_info

basic_info: object

allow_ratings?

optional allow_ratings: boolean

author?

optional author: string

channel

channel: null | object

channel_id?

optional channel_id: string

duration?

optional duration: number

embed

embed: undefined | null | object

end_timestamp

end_timestamp: null | Date

has_ypc_metadata

has_ypc_metadata: null | boolean

id?

optional id: string

is_crawlable?

optional is_crawlable: boolean

is_disliked

is_disliked: undefined | boolean

is_family_safe

is_family_safe: undefined | boolean = info.microformat.is_family_safe

is_liked

is_liked: undefined | boolean

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: undefined | boolean = info.microformat.is_unlisted

is_upcoming?

optional is_upcoming: boolean

keywords?

optional keywords: string[]

like_count

like_count: undefined | number

live_chunk_readahead?

optional live_chunk_readahead: number

short_description?

optional short_description: string

start_timestamp

start_timestamp: null | Date

thumbnail?

optional thumbnail: Thumbnail[]

title?

optional title: string

url_canonical

url_canonical: null | string

view_count

view_count: undefined | number

Inherited from

MediaInfo.basic_info

Defined in

src/core/mixins/MediaInfo.ts:30

captions?

optional captions: PlayerCaptionsTracklist

Inherited from

MediaInfo.captions

Defined in

src/core/mixins/MediaInfo.ts:34

cards?

optional cards: CardCollection

Inherited from

MediaInfo.cards

Defined in

src/core/mixins/MediaInfo.ts:35

current_video_endpoint?

optional current_video_endpoint: NavigationEndpoint

Defined in

src/parser/ytshorts/ShortFormVideoInfo.ts:13

endscreen?

optional endscreen: Endscreen

Inherited from

MediaInfo.endscreen

Defined in

src/core/mixins/MediaInfo.ts:33

playability_status?

optional playability_status: IPlayabilityStatus

Inherited from

MediaInfo.playability_status

Defined in

src/core/mixins/MediaInfo.ts:37

player_config?

optional player_config: IPlayerConfig

Inherited from

MediaInfo.player_config

Defined in

src/core/mixins/MediaInfo.ts:38

player_overlays?

optional player_overlays: PlayerOverlay

Defined in

src/parser/ytshorts/ShortFormVideoInfo.ts:14

storyboards?

optional storyboards: PlayerLiveStoryboardSpec | PlayerStoryboardSpec

Inherited from

MediaInfo.storyboards

Defined in

src/core/mixins/MediaInfo.ts:32

streaming_data?

optional streaming_data: IStreamingData

Inherited from

MediaInfo.streaming_data

Defined in

src/core/mixins/MediaInfo.ts:36

watch_next_feed?

optional watch_next_feed: NavigationEndpoint[]

Defined in

src/parser/ytshorts/ShortFormVideoInfo.ts:12

Accessors

actions

get actions(): Actions

Actions instance.

Returns

Actions

Inherited from

MediaInfo.actions

Defined in

src/core/mixins/MediaInfo.ts:223

cpn

get cpn(): string

Content Playback Nonce.

Returns

string

Inherited from

MediaInfo.cpn

Defined in

src/core/mixins/MediaInfo.ts:230

wn_has_continuation

get wn_has_continuation(): boolean

Checks if continuation is available for the watch next feed.

Returns

boolean

Defined in

src/parser/ytshorts/ShortFormVideoInfo.ts:52

Methods

addToWatchHistory()

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

Adds video to the watch history.

Parameters

• client_name: string = Constants.CLIENTS.WEB.NAME

• client_version: string = Constants.CLIENTS.WEB.VERSION

• replacement: string = 'https://www.'

Returns

Promise<Response>

Inherited from

MediaInfo.addToWatchHistory

Defined in

src/core/mixins/MediaInfo.ts:199

chooseFormat()

chooseFormat(options): Format

Selects the format that best matches the given options.

Parameters

• options: FormatOptions

Options

Returns

Format

Inherited from

MediaInfo.chooseFormat

Defined in

src/core/mixins/MediaInfo.ts:149

download()

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

Downloads the video.

Parameters

• options: DownloadOptions = {}

Download options.

Returns

Promise<ReadableStream<Uint8Array>>

Inherited from

MediaInfo.download

Defined in

src/core/mixins/MediaInfo.ts:157

getStreamingInfo()

getStreamingInfo(url_transformer?, format_filter?): StreamingInfo

Get a cleaned up representation of the adaptive_formats

Parameters

• url_transformer?: URLTransformer

• format_filter?: FormatFilter

Returns

StreamingInfo

Inherited from

MediaInfo.getStreamingInfo

Defined in

src/core/mixins/MediaInfo.ts:132

getTranscript()

getTranscript(): Promise<TranscriptInfo>

Retrieves the video's transcript.

Returns

Promise<TranscriptInfo>

Inherited from

MediaInfo.getTranscript

Defined in

src/core/mixins/MediaInfo.ts:170

getWatchNextContinuation()

getWatchNextContinuation(): Promise<ShortFormVideoInfo>

Returns

Promise<ShortFormVideoInfo>

Defined in

src/parser/ytshorts/ShortFormVideoInfo.ts:28

toDash()

toDash(url_transformer?, format_filter?, options?): Promise<string>

Generates a DASH manifest from the streaming data.

Parameters

• url_transformer?: URLTransformer

Function to transform the URLs.

• format_filter?: FormatFilter

Function to filter the formats.

• options?: DashOptions = ...

Additional options to customise the manifest generation

Returns

Promise<string>

DASH manifest

Inherited from

MediaInfo.toDash

Defined in

src/core/mixins/MediaInfo.ts:97