chore(docs): Update API ref

This commit is contained in:
Luan
2024-11-22 04:25:16 -03:00
parent fc5571629e
commit 4e9d64404e
927 changed files with 26023 additions and 9839 deletions

View File

@@ -29,7 +29,7 @@
#### Defined in
[src/core/mixins/MediaInfo.ts:40](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/MediaInfo.ts#L40)
[src/core/mixins/MediaInfo.ts:48](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/MediaInfo.ts#L48)
## Properties
@@ -39,7 +39,7 @@
#### Defined in
[src/core/mixins/MediaInfo.ts:31](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/MediaInfo.ts#L31)
[src/core/mixins/MediaInfo.ts:39](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/MediaInfo.ts#L39)
***
@@ -181,7 +181,7 @@
#### Defined in
[src/core/mixins/MediaInfo.ts:30](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/MediaInfo.ts#L30)
[src/core/mixins/MediaInfo.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/MediaInfo.ts#L38)
***
@@ -191,7 +191,7 @@
#### Defined in
[src/core/mixins/MediaInfo.ts:34](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/MediaInfo.ts#L34)
[src/core/mixins/MediaInfo.ts:42](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/MediaInfo.ts#L42)
***
@@ -201,7 +201,7 @@
#### Defined in
[src/core/mixins/MediaInfo.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/MediaInfo.ts#L35)
[src/core/mixins/MediaInfo.ts:43](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/MediaInfo.ts#L43)
***
@@ -211,7 +211,7 @@
#### Defined in
[src/core/mixins/MediaInfo.ts:33](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/MediaInfo.ts#L33)
[src/core/mixins/MediaInfo.ts:41](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/MediaInfo.ts#L41)
***
@@ -221,7 +221,7 @@
#### Defined in
[src/core/mixins/MediaInfo.ts:37](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/MediaInfo.ts#L37)
[src/core/mixins/MediaInfo.ts:45](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/MediaInfo.ts#L45)
***
@@ -231,17 +231,17 @@
#### Defined in
[src/core/mixins/MediaInfo.ts:38](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/MediaInfo.ts#L38)
[src/core/mixins/MediaInfo.ts:46](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/MediaInfo.ts#L46)
***
### storyboards?
> `optional` **storyboards**: [`PlayerLiveStoryboardSpec`](../../YTNodes/classes/PlayerLiveStoryboardSpec.md) \| [`PlayerStoryboardSpec`](../../YTNodes/classes/PlayerStoryboardSpec.md)
> `optional` **storyboards**: [`PlayerStoryboardSpec`](../../YTNodes/classes/PlayerStoryboardSpec.md) \| [`PlayerLiveStoryboardSpec`](../../YTNodes/classes/PlayerLiveStoryboardSpec.md)
#### Defined in
[src/core/mixins/MediaInfo.ts:32](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/MediaInfo.ts#L32)
[src/core/mixins/MediaInfo.ts:40](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/MediaInfo.ts#L40)
***
@@ -251,7 +251,7 @@
#### Defined in
[src/core/mixins/MediaInfo.ts:36](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/MediaInfo.ts#L36)
[src/core/mixins/MediaInfo.ts:44](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/MediaInfo.ts#L44)
## Accessors
@@ -259,15 +259,13 @@
> `get` **actions**(): [`Actions`](../../../classes/Actions.md)
Actions instance.
#### Returns
[`Actions`](../../../classes/Actions.md)
#### Defined in
[src/core/mixins/MediaInfo.ts:223](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/MediaInfo.ts#L223)
[src/core/mixins/MediaInfo.ts:226](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/MediaInfo.ts#L226)
***
@@ -283,7 +281,7 @@ Content Playback Nonce.
#### Defined in
[src/core/mixins/MediaInfo.ts:230](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/MediaInfo.ts#L230)
[src/core/mixins/MediaInfo.ts:233](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/MediaInfo.ts#L233)
***
@@ -291,7 +289,7 @@ Content Playback Nonce.
> `get` **page**(): [[`IPlayerResponse`](../../APIResponseTypes/type-aliases/IPlayerResponse.md), `INextResponse?`]
Original parsed InnerTube response.
Parsed InnerTube response.
#### Returns
@@ -299,7 +297,7 @@ Original parsed InnerTube response.
#### Defined in
[src/core/mixins/MediaInfo.ts:237](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/MediaInfo.ts#L237)
[src/core/mixins/MediaInfo.ts:240](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/MediaInfo.ts#L240)
## Methods
@@ -323,7 +321,7 @@ Adds video to the watch history.
#### Defined in
[src/core/mixins/MediaInfo.ts:199](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/MediaInfo.ts#L199)
[src/core/mixins/MediaInfo.ts:207](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/MediaInfo.ts#L207)
***
@@ -345,7 +343,7 @@ Options
#### Defined in
[src/core/mixins/MediaInfo.ts:149](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/MediaInfo.ts#L149)
[src/core/mixins/MediaInfo.ts:157](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/MediaInfo.ts#L157)
***
@@ -367,7 +365,7 @@ Download options.
#### Defined in
[src/core/mixins/MediaInfo.ts:157](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/MediaInfo.ts#L157)
[src/core/mixins/MediaInfo.ts:165](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/MediaInfo.ts#L165)
***
@@ -389,7 +387,7 @@ Get a cleaned up representation of the adaptive_formats
#### Defined in
[src/core/mixins/MediaInfo.ts:132](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/MediaInfo.ts#L132)
[src/core/mixins/MediaInfo.ts:140](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/MediaInfo.ts#L140)
***
@@ -405,7 +403,7 @@ Retrieves the video's transcript.
#### Defined in
[src/core/mixins/MediaInfo.ts:170](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/MediaInfo.ts#L170)
[src/core/mixins/MediaInfo.ts:178](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/MediaInfo.ts#L178)
***
@@ -437,4 +435,4 @@ DASH manifest
#### Defined in
[src/core/mixins/MediaInfo.ts:97](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/mixins/MediaInfo.ts#L97)
[src/core/mixins/MediaInfo.ts:105](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/mixins/MediaInfo.ts#L105)