jirayu_sri/YouTube.js
1
0
Fork 0
mirror of https://github.com/LuanRT/YouTube.js.git synced 2026-07-04 03:51:00 +00:00
Code Issues Packages Projects Releases Wiki Activity

chore(docs): update

Browse Source
This commit is contained in:
LuanRT
2026-05-07 14:38:16 -03:00
parent faaf5fc5c1
commit 03cb4d6801
859 changed files with 11610 additions and 9101 deletions
Download Patch File Download Diff File Expand all files Collapse all files

70
docs/api/youtubei.js/namespaces/YTShorts/classes/ShortFormVideoInfo.md
View File

@@ -2,7 +2,7 @@
# Class: ShortFormVideoInfo
Defined in: [src/parser/ytshorts/ShortFormVideoInfo.ts:9](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/ytshorts/ShortFormVideoInfo.ts#L9)
Defined in: [src/parser/ytshorts/ShortFormVideoInfo.ts:9](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/ytshorts/ShortFormVideoInfo.ts#L9)
## Extends
@@ -14,7 +14,7 @@ Defined in: [src/parser/ytshorts/ShortFormVideoInfo.ts:9](https://github.com/Lua
> **new ShortFormVideoInfo**(`data`, `actions`, `cpn`, `reel_watch_sequence_response`): `ShortFormVideoInfo`
Defined in: [src/parser/ytshorts/ShortFormVideoInfo.ts:15](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/ytshorts/ShortFormVideoInfo.ts#L15)
Defined in: [src/parser/ytshorts/ShortFormVideoInfo.ts:15](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/ytshorts/ShortFormVideoInfo.ts#L15)
#### Parameters
@@ -48,7 +48,7 @@ Defined in: [src/parser/ytshorts/ShortFormVideoInfo.ts:15](https://github.com/Lu
> `optional` **annotations**: [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`PlayerAnnotationsExpanded`](../../YTNodes/classes/PlayerAnnotationsExpanded.md)\>
Defined in: [src/core/mixins/MediaInfo.ts:40](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/core/mixins/MediaInfo.ts#L40)
Defined in: [src/core/mixins/MediaInfo.ts:40](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/core/mixins/MediaInfo.ts#L40)
#### Inherited from
@@ -60,7 +60,7 @@ Defined in: [src/core/mixins/MediaInfo.ts:40](https://github.com/LuanRT/YouTube.
> **basic\_info**: `object`
Defined in: [src/core/mixins/MediaInfo.ts:39](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/core/mixins/MediaInfo.ts#L39)
Defined in: [src/core/mixins/MediaInfo.ts:39](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/core/mixins/MediaInfo.ts#L39)
#### allow\_ratings?
@@ -204,7 +204,7 @@ Defined in: [src/core/mixins/MediaInfo.ts:39](https://github.com/LuanRT/YouTube.
> `optional` **captions**: [`PlayerCaptionsTracklist`](../../YTNodes/classes/PlayerCaptionsTracklist.md)
Defined in: [src/core/mixins/MediaInfo.ts:43](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/core/mixins/MediaInfo.ts#L43)
Defined in: [src/core/mixins/MediaInfo.ts:43](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/core/mixins/MediaInfo.ts#L43)
#### Inherited from
@@ -216,7 +216,7 @@ Defined in: [src/core/mixins/MediaInfo.ts:43](https://github.com/LuanRT/YouTube.
> `optional` **cards**: [`CardCollection`](../../YTNodes/classes/CardCollection.md)
Defined in: [src/core/mixins/MediaInfo.ts:44](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/core/mixins/MediaInfo.ts#L44)
Defined in: [src/core/mixins/MediaInfo.ts:44](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/core/mixins/MediaInfo.ts#L44)
#### Inherited from
@@ -228,7 +228,7 @@ Defined in: [src/core/mixins/MediaInfo.ts:44](https://github.com/LuanRT/YouTube.
> `optional` **current\_video\_endpoint**: [`NavigationEndpoint`](../../YTNodes/classes/NavigationEndpoint.md)
Defined in: [src/parser/ytshorts/ShortFormVideoInfo.ts:12](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/ytshorts/ShortFormVideoInfo.ts#L12)
Defined in: [src/parser/ytshorts/ShortFormVideoInfo.ts:12](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/ytshorts/ShortFormVideoInfo.ts#L12)
***
@@ -236,7 +236,7 @@ Defined in: [src/parser/ytshorts/ShortFormVideoInfo.ts:12](https://github.com/Lu
> `optional` **endscreen**: [`Endscreen`](../../YTNodes/classes/Endscreen.md)
Defined in: [src/core/mixins/MediaInfo.ts:42](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/core/mixins/MediaInfo.ts#L42)
Defined in: [src/core/mixins/MediaInfo.ts:42](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/core/mixins/MediaInfo.ts#L42)
#### Inherited from
@@ -248,7 +248,7 @@ Defined in: [src/core/mixins/MediaInfo.ts:42](https://github.com/LuanRT/YouTube.
> `optional` **playability\_status**: [`IPlayabilityStatus`](../../../../interfaces/IPlayabilityStatus.md)
Defined in: [src/core/mixins/MediaInfo.ts:46](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/core/mixins/MediaInfo.ts#L46)
Defined in: [src/core/mixins/MediaInfo.ts:46](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/core/mixins/MediaInfo.ts#L46)
#### Inherited from
@@ -260,7 +260,7 @@ Defined in: [src/core/mixins/MediaInfo.ts:46](https://github.com/LuanRT/YouTube.
> `optional` **player\_config**: [`IPlayerConfig`](../../../../interfaces/IPlayerConfig.md)
Defined in: [src/core/mixins/MediaInfo.ts:47](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/core/mixins/MediaInfo.ts#L47)
Defined in: [src/core/mixins/MediaInfo.ts:47](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/core/mixins/MediaInfo.ts#L47)
#### Inherited from
@@ -272,7 +272,7 @@ Defined in: [src/core/mixins/MediaInfo.ts:47](https://github.com/LuanRT/YouTube.
> `optional` **player\_overlays**: [`PlayerOverlay`](../../YTNodes/classes/PlayerOverlay.md)
Defined in: [src/parser/ytshorts/ShortFormVideoInfo.ts:13](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/ytshorts/ShortFormVideoInfo.ts#L13)
Defined in: [src/parser/ytshorts/ShortFormVideoInfo.ts:13](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/ytshorts/ShortFormVideoInfo.ts#L13)
***
@@ -280,7 +280,7 @@ Defined in: [src/parser/ytshorts/ShortFormVideoInfo.ts:13](https://github.com/Lu
> `optional` **storyboards**: [`PlayerStoryboardSpec`](../../YTNodes/classes/PlayerStoryboardSpec.md) \| [`PlayerLiveStoryboardSpec`](../../YTNodes/classes/PlayerLiveStoryboardSpec.md)
Defined in: [src/core/mixins/MediaInfo.ts:41](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/core/mixins/MediaInfo.ts#L41)
Defined in: [src/core/mixins/MediaInfo.ts:41](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/core/mixins/MediaInfo.ts#L41)
#### Inherited from
@@ -292,7 +292,7 @@ Defined in: [src/core/mixins/MediaInfo.ts:41](https://github.com/LuanRT/YouTube.
> `optional` **streaming\_data**: [`IStreamingData`](../../../../interfaces/IStreamingData.md)
Defined in: [src/core/mixins/MediaInfo.ts:45](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/core/mixins/MediaInfo.ts#L45)
Defined in: [src/core/mixins/MediaInfo.ts:45](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/core/mixins/MediaInfo.ts#L45)
#### Inherited from
@@ -304,7 +304,7 @@ Defined in: [src/core/mixins/MediaInfo.ts:45](https://github.com/LuanRT/YouTube.
> `optional` **watch\_next\_feed**: [`NavigationEndpoint`](../../YTNodes/classes/NavigationEndpoint.md)[]
Defined in: [src/parser/ytshorts/ShortFormVideoInfo.ts:11](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/ytshorts/ShortFormVideoInfo.ts#L11)
Defined in: [src/parser/ytshorts/ShortFormVideoInfo.ts:11](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/ytshorts/ShortFormVideoInfo.ts#L11)
## Accessors
@@ -314,7 +314,7 @@ Defined in: [src/parser/ytshorts/ShortFormVideoInfo.ts:11](https://github.com/Lu
> **get** **actions**(): [`Actions`](../../../../classes/Actions.md)
Defined in: [src/core/mixins/MediaInfo.ts:247](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/core/mixins/MediaInfo.ts#L247)
Defined in: [src/core/mixins/MediaInfo.ts:247](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/core/mixins/MediaInfo.ts#L247)
##### Returns
@@ -332,7 +332,7 @@ Defined in: [src/core/mixins/MediaInfo.ts:247](https://github.com/LuanRT/YouTube
> **get** **cpn**(): `string`
Defined in: [src/core/mixins/MediaInfo.ts:254](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/core/mixins/MediaInfo.ts#L254)
Defined in: [src/core/mixins/MediaInfo.ts:254](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/core/mixins/MediaInfo.ts#L254)
Content Playback Nonce.
@@ -352,7 +352,7 @@ Content Playback Nonce.
> **get** **page**(): \[[`IPlayerResponse`](../../../../type-aliases/IPlayerResponse.md), [`INextResponse`](../../../../type-aliases/INextResponse.md)?\]
Defined in: [src/core/mixins/MediaInfo.ts:261](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/core/mixins/MediaInfo.ts#L261)
Defined in: [src/core/mixins/MediaInfo.ts:261](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/core/mixins/MediaInfo.ts#L261)
Parsed InnerTube response.
@@ -372,7 +372,7 @@ Parsed InnerTube response.
> **get** **wn\_has\_continuation**(): `boolean`
Defined in: [src/parser/ytshorts/ShortFormVideoInfo.ts:47](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/ytshorts/ShortFormVideoInfo.ts#L47)
Defined in: [src/parser/ytshorts/ShortFormVideoInfo.ts:47](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/ytshorts/ShortFormVideoInfo.ts#L47)
Checks if continuation is available for the watch next feed.
@@ -386,7 +386,7 @@ Checks if continuation is available for the watch next feed.
> **addToWatchHistory**(`client_name?`, `client_version?`, `replacement?`): `Promise`\<`Response`\>
Defined in: [src/core/mixins/MediaInfo.ts:208](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/core/mixins/MediaInfo.ts#L208)
Defined in: [src/core/mixins/MediaInfo.ts:208](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/core/mixins/MediaInfo.ts#L208)
#### Parameters
@@ -416,7 +416,7 @@ Defined in: [src/core/mixins/MediaInfo.ts:208](https://github.com/LuanRT/YouTube
> **chooseFormat**(`options`): [`Format`](../../Misc/classes/Format.md)
Defined in: [src/core/mixins/MediaInfo.ts:161](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/core/mixins/MediaInfo.ts#L161)
Defined in: [src/core/mixins/MediaInfo.ts:161](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/core/mixins/MediaInfo.ts#L161)
Selects the format that best matches the given options.
@@ -440,15 +440,15 @@ Options
### download()
> **download**(`options`): `Promise`\<`ReadableStream`\<`Uint8Array`\>\>
> **download**(`options?`): `Promise`\<`ReadableStream`\<`Uint8Array`\<`ArrayBufferLike`\>\>\>
Defined in: [src/core/mixins/MediaInfo.ts:169](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/core/mixins/MediaInfo.ts#L169)
Defined in: [src/core/mixins/MediaInfo.ts:169](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/core/mixins/MediaInfo.ts#L169)
Downloads the video.
#### Parameters
##### options
##### options?
[`DownloadOptions`](../../Types/interfaces/DownloadOptions.md) = `{}`
@@ -456,7 +456,7 @@ Download options.
#### Returns
`Promise`\<`ReadableStream`\<`Uint8Array`\>\>
`Promise`\<`ReadableStream`\<`Uint8Array`\<`ArrayBufferLike`\>\>\>
#### Inherited from
@@ -468,7 +468,7 @@ Download options.
> **getStreamingInfo**(`url_transformer?`, `format_filter?`): `Promise`\<`StreamingInfo`\>
Defined in: [src/core/mixins/MediaInfo.ts:144](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/core/mixins/MediaInfo.ts#L144)
Defined in: [src/core/mixins/MediaInfo.ts:144](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/core/mixins/MediaInfo.ts#L144)
Get a cleaned up representation of the adaptive_formats
@@ -496,7 +496,7 @@ Get a cleaned up representation of the adaptive_formats
> **getTranscript**(): `Promise`\<[`TranscriptInfo`](../../YT/classes/TranscriptInfo.md)\>
Defined in: [src/core/mixins/MediaInfo.ts:182](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/core/mixins/MediaInfo.ts#L182)
Defined in: [src/core/mixins/MediaInfo.ts:182](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/core/mixins/MediaInfo.ts#L182)
Retrieves the video's transcript.
@@ -514,7 +514,7 @@ Retrieves the video's transcript.
> **getWatchNextContinuation**(): `Promise`\<`ShortFormVideoInfo`\>
Defined in: [src/parser/ytshorts/ShortFormVideoInfo.ts:27](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/ytshorts/ShortFormVideoInfo.ts#L27)
Defined in: [src/parser/ytshorts/ShortFormVideoInfo.ts:27](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/ytshorts/ShortFormVideoInfo.ts#L27)
#### Returns
@@ -524,15 +524,15 @@ Defined in: [src/parser/ytshorts/ShortFormVideoInfo.ts:27](https://github.com/Lu
### toDash()
> **toDash**(`options`): `Promise`\<`string`\>
> **toDash**(`options?`): `Promise`\<`string`\>
Defined in: [src/core/mixins/MediaInfo.ts:104](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/core/mixins/MediaInfo.ts#L104)
Defined in: [src/core/mixins/MediaInfo.ts:104](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/core/mixins/MediaInfo.ts#L104)
Generates a DASH manifest from the streaming data.
#### Parameters
##### options
##### options?
###### format_filter?
@@ -560,9 +560,9 @@ DASH manifest
### updateWatchTime()
> **updateWatchTime**(`startTime`, `client_name`, `client_version`, `replacement`): `Promise`\<`Response`\>
> **updateWatchTime**(`startTime`, `client_name?`, `client_version?`, `replacement?`): `Promise`\<`Response`\>
Defined in: [src/core/mixins/MediaInfo.ts:227](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/core/mixins/MediaInfo.ts#L227)
Defined in: [src/core/mixins/MediaInfo.ts:227](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/core/mixins/MediaInfo.ts#L227)
#### Parameters
@@ -570,15 +570,15 @@ Defined in: [src/core/mixins/MediaInfo.ts:227](https://github.com/LuanRT/YouTube
`number`
##### client\_name
##### client\_name?
`string` = `Constants.CLIENTS.WEB.NAME`
##### client\_version
##### client\_version?
`string` = `Constants.CLIENTS.WEB.VERSION`
##### replacement
##### replacement?
`string` = `'https://www.'`