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

chore(docs): Update API ref [skip ci]

Browse Source
This commit is contained in:
Luan
2024-11-25 03:25:27 -03:00
parent 4729016fb9
commit fcd65b4dba
756 changed files with 7232 additions and 7009 deletions
Download Patch File Download Diff File Expand all files Collapse all files

84
docs/api/namespaces/YT/classes/VideoInfo.md
View File

@@ -30,7 +30,7 @@
#### Defined in
[src/parser/youtube/VideoInfo.ts:47](https://github.com/LuanRT/YouTube.js/blob/cf09f7bab14fcca99e1f3ae428c7337fea58cfa5/src/parser/youtube/VideoInfo.ts#L47)
[src/parser/youtube/VideoInfo.ts:47](https://github.com/LuanRT/YouTube.js/blob/4729016fb98e7045ee4043857be7eef780c01e35/src/parser/youtube/VideoInfo.ts#L47)
## Properties
@@ -44,7 +44,7 @@
#### Defined in
[src/core/mixins/MediaInfo.ts:40](https://github.com/LuanRT/YouTube.js/blob/cf09f7bab14fcca99e1f3ae428c7337fea58cfa5/src/core/mixins/MediaInfo.ts#L40)
[src/core/mixins/MediaInfo.ts:40](https://github.com/LuanRT/YouTube.js/blob/4729016fb98e7045ee4043857be7eef780c01e35/src/core/mixins/MediaInfo.ts#L40)
***
@@ -66,7 +66,7 @@
#### Defined in
[src/parser/youtube/VideoInfo.ts:43](https://github.com/LuanRT/YouTube.js/blob/cf09f7bab14fcca99e1f3ae428c7337fea58cfa5/src/parser/youtube/VideoInfo.ts#L43)
[src/parser/youtube/VideoInfo.ts:43](https://github.com/LuanRT/YouTube.js/blob/4729016fb98e7045ee4043857be7eef780c01e35/src/parser/youtube/VideoInfo.ts#L43)
***
@@ -212,7 +212,7 @@
#### Defined in
[src/core/mixins/MediaInfo.ts:39](https://github.com/LuanRT/YouTube.js/blob/cf09f7bab14fcca99e1f3ae428c7337fea58cfa5/src/core/mixins/MediaInfo.ts#L39)
[src/core/mixins/MediaInfo.ts:39](https://github.com/LuanRT/YouTube.js/blob/4729016fb98e7045ee4043857be7eef780c01e35/src/core/mixins/MediaInfo.ts#L39)
***
@@ -226,7 +226,7 @@
#### Defined in
[src/core/mixins/MediaInfo.ts:43](https://github.com/LuanRT/YouTube.js/blob/cf09f7bab14fcca99e1f3ae428c7337fea58cfa5/src/core/mixins/MediaInfo.ts#L43)
[src/core/mixins/MediaInfo.ts:43](https://github.com/LuanRT/YouTube.js/blob/4729016fb98e7045ee4043857be7eef780c01e35/src/core/mixins/MediaInfo.ts#L43)
***
@@ -240,7 +240,7 @@
#### Defined in
[src/core/mixins/MediaInfo.ts:44](https://github.com/LuanRT/YouTube.js/blob/cf09f7bab14fcca99e1f3ae428c7337fea58cfa5/src/core/mixins/MediaInfo.ts#L44)
[src/core/mixins/MediaInfo.ts:44](https://github.com/LuanRT/YouTube.js/blob/4729016fb98e7045ee4043857be7eef780c01e35/src/core/mixins/MediaInfo.ts#L44)
***
@@ -250,7 +250,7 @@
#### Defined in
[src/parser/youtube/VideoInfo.ts:41](https://github.com/LuanRT/YouTube.js/blob/cf09f7bab14fcca99e1f3ae428c7337fea58cfa5/src/parser/youtube/VideoInfo.ts#L41)
[src/parser/youtube/VideoInfo.ts:41](https://github.com/LuanRT/YouTube.js/blob/4729016fb98e7045ee4043857be7eef780c01e35/src/parser/youtube/VideoInfo.ts#L41)
***
@@ -264,7 +264,7 @@
#### Defined in
[src/core/mixins/MediaInfo.ts:42](https://github.com/LuanRT/YouTube.js/blob/cf09f7bab14fcca99e1f3ae428c7337fea58cfa5/src/core/mixins/MediaInfo.ts#L42)
[src/core/mixins/MediaInfo.ts:42](https://github.com/LuanRT/YouTube.js/blob/4729016fb98e7045ee4043857be7eef780c01e35/src/core/mixins/MediaInfo.ts#L42)
***
@@ -282,7 +282,7 @@
#### Defined in
[src/parser/youtube/VideoInfo.ts:36](https://github.com/LuanRT/YouTube.js/blob/cf09f7bab14fcca99e1f3ae428c7337fea58cfa5/src/parser/youtube/VideoInfo.ts#L36)
[src/parser/youtube/VideoInfo.ts:36](https://github.com/LuanRT/YouTube.js/blob/4729016fb98e7045ee4043857be7eef780c01e35/src/parser/youtube/VideoInfo.ts#L36)
***
@@ -292,7 +292,7 @@
#### Defined in
[src/parser/youtube/VideoInfo.ts:42](https://github.com/LuanRT/YouTube.js/blob/cf09f7bab14fcca99e1f3ae428c7337fea58cfa5/src/parser/youtube/VideoInfo.ts#L42)
[src/parser/youtube/VideoInfo.ts:42](https://github.com/LuanRT/YouTube.js/blob/4729016fb98e7045ee4043857be7eef780c01e35/src/parser/youtube/VideoInfo.ts#L42)
***
@@ -302,7 +302,7 @@
#### Defined in
[src/parser/youtube/VideoInfo.ts:37](https://github.com/LuanRT/YouTube.js/blob/cf09f7bab14fcca99e1f3ae428c7337fea58cfa5/src/parser/youtube/VideoInfo.ts#L37)
[src/parser/youtube/VideoInfo.ts:37](https://github.com/LuanRT/YouTube.js/blob/4729016fb98e7045ee4043857be7eef780c01e35/src/parser/youtube/VideoInfo.ts#L37)
***
@@ -316,7 +316,7 @@
#### Defined in
[src/core/mixins/MediaInfo.ts:46](https://github.com/LuanRT/YouTube.js/blob/cf09f7bab14fcca99e1f3ae428c7337fea58cfa5/src/core/mixins/MediaInfo.ts#L46)
[src/core/mixins/MediaInfo.ts:46](https://github.com/LuanRT/YouTube.js/blob/4729016fb98e7045ee4043857be7eef780c01e35/src/core/mixins/MediaInfo.ts#L46)
***
@@ -330,7 +330,7 @@
#### Defined in
[src/core/mixins/MediaInfo.ts:47](https://github.com/LuanRT/YouTube.js/blob/cf09f7bab14fcca99e1f3ae428c7337fea58cfa5/src/core/mixins/MediaInfo.ts#L47)
[src/core/mixins/MediaInfo.ts:47](https://github.com/LuanRT/YouTube.js/blob/4729016fb98e7045ee4043857be7eef780c01e35/src/core/mixins/MediaInfo.ts#L47)
***
@@ -340,7 +340,7 @@
#### Defined in
[src/parser/youtube/VideoInfo.ts:40](https://github.com/LuanRT/YouTube.js/blob/cf09f7bab14fcca99e1f3ae428c7337fea58cfa5/src/parser/youtube/VideoInfo.ts#L40)
[src/parser/youtube/VideoInfo.ts:40](https://github.com/LuanRT/YouTube.js/blob/4729016fb98e7045ee4043857be7eef780c01e35/src/parser/youtube/VideoInfo.ts#L40)
***
@@ -378,7 +378,7 @@
#### Defined in
[src/parser/youtube/VideoInfo.ts:35](https://github.com/LuanRT/YouTube.js/blob/cf09f7bab14fcca99e1f3ae428c7337fea58cfa5/src/parser/youtube/VideoInfo.ts#L35)
[src/parser/youtube/VideoInfo.ts:35](https://github.com/LuanRT/YouTube.js/blob/4729016fb98e7045ee4043857be7eef780c01e35/src/parser/youtube/VideoInfo.ts#L35)
***
@@ -388,7 +388,7 @@
#### Defined in
[src/parser/youtube/VideoInfo.ts:33](https://github.com/LuanRT/YouTube.js/blob/cf09f7bab14fcca99e1f3ae428c7337fea58cfa5/src/parser/youtube/VideoInfo.ts#L33)
[src/parser/youtube/VideoInfo.ts:33](https://github.com/LuanRT/YouTube.js/blob/4729016fb98e7045ee4043857be7eef780c01e35/src/parser/youtube/VideoInfo.ts#L33)
***
@@ -398,7 +398,7 @@
#### Defined in
[src/parser/youtube/VideoInfo.ts:38](https://github.com/LuanRT/YouTube.js/blob/cf09f7bab14fcca99e1f3ae428c7337fea58cfa5/src/parser/youtube/VideoInfo.ts#L38)
[src/parser/youtube/VideoInfo.ts:38](https://github.com/LuanRT/YouTube.js/blob/4729016fb98e7045ee4043857be7eef780c01e35/src/parser/youtube/VideoInfo.ts#L38)
***
@@ -408,7 +408,7 @@
#### Defined in
[src/parser/youtube/VideoInfo.ts:34](https://github.com/LuanRT/YouTube.js/blob/cf09f7bab14fcca99e1f3ae428c7337fea58cfa5/src/parser/youtube/VideoInfo.ts#L34)
[src/parser/youtube/VideoInfo.ts:34](https://github.com/LuanRT/YouTube.js/blob/4729016fb98e7045ee4043857be7eef780c01e35/src/parser/youtube/VideoInfo.ts#L34)
***
@@ -422,7 +422,7 @@
#### Defined in
[src/core/mixins/MediaInfo.ts:41](https://github.com/LuanRT/YouTube.js/blob/cf09f7bab14fcca99e1f3ae428c7337fea58cfa5/src/core/mixins/MediaInfo.ts#L41)
[src/core/mixins/MediaInfo.ts:41](https://github.com/LuanRT/YouTube.js/blob/4729016fb98e7045ee4043857be7eef780c01e35/src/core/mixins/MediaInfo.ts#L41)
***
@@ -436,7 +436,7 @@
#### Defined in
[src/core/mixins/MediaInfo.ts:45](https://github.com/LuanRT/YouTube.js/blob/cf09f7bab14fcca99e1f3ae428c7337fea58cfa5/src/core/mixins/MediaInfo.ts#L45)
[src/core/mixins/MediaInfo.ts:45](https://github.com/LuanRT/YouTube.js/blob/4729016fb98e7045ee4043857be7eef780c01e35/src/core/mixins/MediaInfo.ts#L45)
***
@@ -446,7 +446,7 @@
#### Defined in
[src/parser/youtube/VideoInfo.ts:39](https://github.com/LuanRT/YouTube.js/blob/cf09f7bab14fcca99e1f3ae428c7337fea58cfa5/src/parser/youtube/VideoInfo.ts#L39)
[src/parser/youtube/VideoInfo.ts:39](https://github.com/LuanRT/YouTube.js/blob/4729016fb98e7045ee4043857be7eef780c01e35/src/parser/youtube/VideoInfo.ts#L39)
## Accessors
@@ -464,7 +464,7 @@
#### Defined in
[src/core/mixins/MediaInfo.ts:227](https://github.com/LuanRT/YouTube.js/blob/cf09f7bab14fcca99e1f3ae428c7337fea58cfa5/src/core/mixins/MediaInfo.ts#L227)
[src/core/mixins/MediaInfo.ts:227](https://github.com/LuanRT/YouTube.js/blob/4729016fb98e7045ee4043857be7eef780c01e35/src/core/mixins/MediaInfo.ts#L227)
***
@@ -480,7 +480,7 @@ Gets the endpoint of the autoplay video
#### Defined in
[src/parser/youtube/VideoInfo.ts:363](https://github.com/LuanRT/YouTube.js/blob/cf09f7bab14fcca99e1f3ae428c7337fea58cfa5/src/parser/youtube/VideoInfo.ts#L363)
[src/parser/youtube/VideoInfo.ts:363](https://github.com/LuanRT/YouTube.js/blob/4729016fb98e7045ee4043857be7eef780c01e35/src/parser/youtube/VideoInfo.ts#L363)
***
@@ -500,7 +500,7 @@ Content Playback Nonce.
#### Defined in
[src/core/mixins/MediaInfo.ts:234](https://github.com/LuanRT/YouTube.js/blob/cf09f7bab14fcca99e1f3ae428c7337fea58cfa5/src/core/mixins/MediaInfo.ts#L234)
[src/core/mixins/MediaInfo.ts:234](https://github.com/LuanRT/YouTube.js/blob/4729016fb98e7045ee4043857be7eef780c01e35/src/core/mixins/MediaInfo.ts#L234)
***
@@ -516,7 +516,7 @@ Watch next feed filters.
#### Defined in
[src/parser/youtube/VideoInfo.ts:349](https://github.com/LuanRT/YouTube.js/blob/cf09f7bab14fcca99e1f3ae428c7337fea58cfa5/src/parser/youtube/VideoInfo.ts#L349)
[src/parser/youtube/VideoInfo.ts:349](https://github.com/LuanRT/YouTube.js/blob/4729016fb98e7045ee4043857be7eef780c01e35/src/parser/youtube/VideoInfo.ts#L349)
***
@@ -532,7 +532,7 @@ Checks if trailer is available.
#### Defined in
[src/parser/youtube/VideoInfo.ts:370](https://github.com/LuanRT/YouTube.js/blob/cf09f7bab14fcca99e1f3ae428c7337fea58cfa5/src/parser/youtube/VideoInfo.ts#L370)
[src/parser/youtube/VideoInfo.ts:370](https://github.com/LuanRT/YouTube.js/blob/4729016fb98e7045ee4043857be7eef780c01e35/src/parser/youtube/VideoInfo.ts#L370)
***
@@ -548,7 +548,7 @@ Get songs used in the video.
#### Defined in
[src/parser/youtube/VideoInfo.ts:377](https://github.com/LuanRT/YouTube.js/blob/cf09f7bab14fcca99e1f3ae428c7337fea58cfa5/src/parser/youtube/VideoInfo.ts#L377)
[src/parser/youtube/VideoInfo.ts:377](https://github.com/LuanRT/YouTube.js/blob/4729016fb98e7045ee4043857be7eef780c01e35/src/parser/youtube/VideoInfo.ts#L377)
***
@@ -568,7 +568,7 @@ Parsed InnerTube response.
#### Defined in
[src/core/mixins/MediaInfo.ts:241](https://github.com/LuanRT/YouTube.js/blob/cf09f7bab14fcca99e1f3ae428c7337fea58cfa5/src/core/mixins/MediaInfo.ts#L241)
[src/core/mixins/MediaInfo.ts:241](https://github.com/LuanRT/YouTube.js/blob/4729016fb98e7045ee4043857be7eef780c01e35/src/core/mixins/MediaInfo.ts#L241)
***
@@ -584,7 +584,7 @@ Checks if continuation is available for the watch next feed.
#### Defined in
[src/parser/youtube/VideoInfo.ts:356](https://github.com/LuanRT/YouTube.js/blob/cf09f7bab14fcca99e1f3ae428c7337fea58cfa5/src/parser/youtube/VideoInfo.ts#L356)
[src/parser/youtube/VideoInfo.ts:356](https://github.com/LuanRT/YouTube.js/blob/4729016fb98e7045ee4043857be7eef780c01e35/src/parser/youtube/VideoInfo.ts#L356)
## Methods
@@ -604,7 +604,7 @@ Adds video to the watch history.
#### Defined in
[src/parser/youtube/VideoInfo.ts:170](https://github.com/LuanRT/YouTube.js/blob/cf09f7bab14fcca99e1f3ae428c7337fea58cfa5/src/parser/youtube/VideoInfo.ts#L170)
[src/parser/youtube/VideoInfo.ts:170](https://github.com/LuanRT/YouTube.js/blob/4729016fb98e7045ee4043857be7eef780c01e35/src/parser/youtube/VideoInfo.ts#L170)
***
@@ -630,7 +630,7 @@ Options
#### Defined in
[src/core/mixins/MediaInfo.ts:158](https://github.com/LuanRT/YouTube.js/blob/cf09f7bab14fcca99e1f3ae428c7337fea58cfa5/src/core/mixins/MediaInfo.ts#L158)
[src/core/mixins/MediaInfo.ts:158](https://github.com/LuanRT/YouTube.js/blob/4729016fb98e7045ee4043857be7eef780c01e35/src/core/mixins/MediaInfo.ts#L158)
***
@@ -646,7 +646,7 @@ Dislikes the video.
#### Defined in
[src/parser/youtube/VideoInfo.ts:237](https://github.com/LuanRT/YouTube.js/blob/cf09f7bab14fcca99e1f3ae428c7337fea58cfa5/src/parser/youtube/VideoInfo.ts#L237)
[src/parser/youtube/VideoInfo.ts:237](https://github.com/LuanRT/YouTube.js/blob/4729016fb98e7045ee4043857be7eef780c01e35/src/parser/youtube/VideoInfo.ts#L237)
***
@@ -672,7 +672,7 @@ Download options.
#### Defined in
[src/core/mixins/MediaInfo.ts:166](https://github.com/LuanRT/YouTube.js/blob/cf09f7bab14fcca99e1f3ae428c7337fea58cfa5/src/core/mixins/MediaInfo.ts#L166)
[src/core/mixins/MediaInfo.ts:166](https://github.com/LuanRT/YouTube.js/blob/4729016fb98e7045ee4043857be7eef780c01e35/src/core/mixins/MediaInfo.ts#L166)
***
@@ -688,7 +688,7 @@ Retrieves Live Chat if available.
#### Defined in
[src/parser/youtube/VideoInfo.ts:326](https://github.com/LuanRT/YouTube.js/blob/cf09f7bab14fcca99e1f3ae428c7337fea58cfa5/src/parser/youtube/VideoInfo.ts#L326)
[src/parser/youtube/VideoInfo.ts:326](https://github.com/LuanRT/YouTube.js/blob/4729016fb98e7045ee4043857be7eef780c01e35/src/parser/youtube/VideoInfo.ts#L326)
***
@@ -714,7 +714,7 @@ Get a cleaned up representation of the adaptive_formats
#### Defined in
[src/core/mixins/MediaInfo.ts:141](https://github.com/LuanRT/YouTube.js/blob/cf09f7bab14fcca99e1f3ae428c7337fea58cfa5/src/core/mixins/MediaInfo.ts#L141)
[src/core/mixins/MediaInfo.ts:141](https://github.com/LuanRT/YouTube.js/blob/4729016fb98e7045ee4043857be7eef780c01e35/src/core/mixins/MediaInfo.ts#L141)
***
@@ -732,7 +732,7 @@ Retrieves trailer info if available (typically for non-purchased movies or films
#### Defined in
[src/parser/youtube/VideoInfo.ts:336](https://github.com/LuanRT/YouTube.js/blob/cf09f7bab14fcca99e1f3ae428c7337fea58cfa5/src/parser/youtube/VideoInfo.ts#L336)
[src/parser/youtube/VideoInfo.ts:336](https://github.com/LuanRT/YouTube.js/blob/4729016fb98e7045ee4043857be7eef780c01e35/src/parser/youtube/VideoInfo.ts#L336)
***
@@ -752,7 +752,7 @@ Retrieves the video's transcript.
#### Defined in
[src/core/mixins/MediaInfo.ts:179](https://github.com/LuanRT/YouTube.js/blob/cf09f7bab14fcca99e1f3ae428c7337fea58cfa5/src/core/mixins/MediaInfo.ts#L179)
[src/core/mixins/MediaInfo.ts:179](https://github.com/LuanRT/YouTube.js/blob/4729016fb98e7045ee4043857be7eef780c01e35/src/core/mixins/MediaInfo.ts#L179)
***
@@ -768,7 +768,7 @@ Retrieves watch next feed continuation.
#### Defined in
[src/parser/youtube/VideoInfo.ts:177](https://github.com/LuanRT/YouTube.js/blob/cf09f7bab14fcca99e1f3ae428c7337fea58cfa5/src/parser/youtube/VideoInfo.ts#L177)
[src/parser/youtube/VideoInfo.ts:177](https://github.com/LuanRT/YouTube.js/blob/4729016fb98e7045ee4043857be7eef780c01e35/src/parser/youtube/VideoInfo.ts#L177)
***
@@ -784,7 +784,7 @@ Likes the video.
#### Defined in
[src/parser/youtube/VideoInfo.ts:200](https://github.com/LuanRT/YouTube.js/blob/cf09f7bab14fcca99e1f3ae428c7337fea58cfa5/src/parser/youtube/VideoInfo.ts#L200)
[src/parser/youtube/VideoInfo.ts:200](https://github.com/LuanRT/YouTube.js/blob/4729016fb98e7045ee4043857be7eef780c01e35/src/parser/youtube/VideoInfo.ts#L200)
***
@@ -800,7 +800,7 @@ Removes like/dislike.
#### Defined in
[src/parser/youtube/VideoInfo.ts:274](https://github.com/LuanRT/YouTube.js/blob/cf09f7bab14fcca99e1f3ae428c7337fea58cfa5/src/parser/youtube/VideoInfo.ts#L274)
[src/parser/youtube/VideoInfo.ts:274](https://github.com/LuanRT/YouTube.js/blob/4729016fb98e7045ee4043857be7eef780c01e35/src/parser/youtube/VideoInfo.ts#L274)
***
@@ -822,7 +822,7 @@ Filter to apply.
#### Defined in
[src/parser/youtube/VideoInfo.ts:138](https://github.com/LuanRT/YouTube.js/blob/cf09f7bab14fcca99e1f3ae428c7337fea58cfa5/src/parser/youtube/VideoInfo.ts#L138)
[src/parser/youtube/VideoInfo.ts:138](https://github.com/LuanRT/YouTube.js/blob/4729016fb98e7045ee4043857be7eef780c01e35/src/parser/youtube/VideoInfo.ts#L138)
***
@@ -858,4 +858,4 @@ DASH manifest
#### Defined in
[src/core/mixins/MediaInfo.ts:106](https://github.com/LuanRT/YouTube.js/blob/cf09f7bab14fcca99e1f3ae428c7337fea58cfa5/src/core/mixins/MediaInfo.ts#L106)
[src/core/mixins/MediaInfo.ts:106](https://github.com/LuanRT/YouTube.js/blob/4729016fb98e7045ee4043857be7eef780c01e35/src/core/mixins/MediaInfo.ts#L106)