chore(docs): finish most of v2's documentation

This commit is contained in:
LuanRT
2022-09-01 05:10:16 -03:00
parent b9e6e16ce9
commit 898cb56c71
7 changed files with 874 additions and 47 deletions

112
docs/API/account.md Normal file
View File

@@ -0,0 +1,112 @@
# Account
YouTube account manager.
## API
* Account
* [.channel](#channel)
* [.getInfo()](#getinfo)
* [.getTimeWatched()](#gettimewatched)
* [.getSettings()](#getsettings)
* [.getAnalytics](#getanalytics)
<a name="channel"></a>
### channel
Channel settings.
**Returns:** `object`
<details>
<summary>Methods & Getters</summary>
<p>
- `<channel>#editName(new_name)`
- Edits the name of the channel.
- `<channel>#editDescription(new_description)`
- Edits channel description.
- `<channel>#getBasicAnalytics()`
- Alias for [`Account#getAnalytics()`](#getanalytics) — returns basic channel analytics.
</p>
</details>
<a name="getinfo"></a>
### getInfo()
Retrieves account information.
**Returns:** `Promise.<AccountInfo>`
<details>
<summary>Methods & Getters</summary>
<p>
- `<accountinfo>#page`
- Returns original InnerTube response (sanitized).
</p>
</details>
<a name="gettimewatched"></a>
### getTimeWatched()
Retrieves time watched statistics.
**Returns:** `Promise.<TimeWatched>`
<details>
<summary>Methods & Getters</summary>
<p>
- `<timewatched>#page`
- Returns original InnerTube response (sanitized).
</p>
</details>
<a name="getsettings"></a>
### getSettings()
Retrieves YouTube settings.
**Returns:** `Promise.<Settings>`
<details>
<summary>Methods & Getters</summary>
<p>
- `<settings>#selectSidebarItem(name)`
- Selects an item from the sidebar menu. Use `settings#sidebar_items` to see available items.
- `<settings>#getSettingOption(name)`
- Finds a setting by name and returns it. Use `settings#setting_options` to see available options.
- `<settings>#setting_options`
- Returns settings available in the page.
- `<settings>#sidebar_items`
- Returns options available in the sidebar menu.
</p>
</details>
<a name="getanalytics"></a>
### getAnalytics()
Retrieves basic channel analytics.
**Returns:** `Promise.<Analytics>`
<details>
<summary>Methods & Getters</summary>
<p>
- `<analytics>#page`
- Returns original InnerTube response (sanitized).
</p>
</details>

View File

@@ -0,0 +1,108 @@
# InteractionManager
Handles direct interactions.
## API
* InteractionManager
* [.like(video_id)](#like)
* [.dislike(video_id)](#dislike)
* [.removeLike(video_id)](#removelike)
* [.subscribe(video_id)](#subscribe)
* [.unsubscribe(video_id)](#unsubscribe)
* [.comment(video_id, text)](#comment)
* [.translate(text, target_language, args?)](#translate)
* [.setNotificationPreferences(channel_id, type)](#setnotificationpreferences)
<a name="like"></a>
### like(video_id)
Likes given video.
**Returns:** `Promise.<ActionsResponse>`
| Param | Type | Description |
| --- | --- | --- |
| video_id | `string` | Video id |
<a name="dislike"></a>
### dislike(video_id)
Dislikes given video.
**Returns:** `Promise.<ActionsResponse>`
| Param | Type | Description |
| --- | --- | --- |
| video_id | `string` | Video id |
<a name="removelike"></a>
### removeLike(video_id)
Remover like/dislike.
**Returns:** `Promise.<ActionsResponse>`
| Param | Type | Description |
| --- | --- | --- |
| video_id | `string` | Video id |
<a name="subscribe"></a>
### subscribe(channel_id)
Subscribes to given channel.
**Returns:** `Promise.<ActionsResponse>`
| Param | Type | Description |
| --- | --- | --- |
| channel_id | `string` | Channel id |
<a name="unsubscribe"></a>
### unsubscribe(channel_id)
Unsubscribes from given channel.
**Returns:** `Promise.<ActionsResponse>`
| Param | Type | Description |
| --- | --- | --- |
| channel_id | `string` | Channel id |
<a name="comment"></a>
### comment(video_id, text)
Posts a comment on given video.
**Returns:** `Promise.<ActionsResponse>`
| Param | Type | Description |
| --- | --- | --- |
| video_id | `string` | Video id |
| text | `string` | Comment content |
<a name="translate"></a>
### translate(text, target_language, args?)
Translates given text using YouTube's comment translation feature.
**Returns:** `Promise.<ActionsResponse>`
| Param | Type | Description |
| --- | --- | --- |
| text | `string` | Text to be translated |
| target_language | `string` | ISO language code |
| args? | `object` | Additional arguments |
<a name="setnotificationpreferences"></a>
### setNotificationPreferences(channel_id, type)
Changes notification preferences for a given channel.
Only works with channels you are subscribed to.
**Returns:** `Promise.<ActionsResponse>`
| Param | Type | Description |
| --- | --- | --- |
| channel_id | `string` | Channel id |
| type | `string` | `PERSONALIZED`, `ALL` or `NONE` |

250
docs/API/music.md Normal file
View File

@@ -0,0 +1,250 @@
# Music
YouTube Music class.
## API
* Music
* [.getInfo(video_id)](#getinfo)
* [.search(query, [filters?])](#search)
* [.getHomeFeed()](#gethomefeed)
* [.getExplore()](#getexplore)
* [.getLibrary()](#getlibrary)
* [.getArtist(artist_id)](#getartist)
* [.getAlbum(album_id)](#getalbum)
* [.getPlaylist(playlist_id)](#getplaylist)
* [.getLyrics(video_id)](#getlyrics)
* [.getUpNext(video_id)](#getupnext)
* [.getRelated(video_id)](#getrelated)
* [.getSearchSuggestions(query)](#getsearchsuggestions)
<a name="getinfo"></a>
### getInfo(video_id)
Retrieves track info.
**Returns:** `Promise.<TrackInfo>`
| Param | Type | Description |
| --- | --- | --- |
| video_id | `string` | Video id |
<a name="search"></a>
### search(query, [filters?])
Searches on YouTube Music.
**Returns:** `Promise.<Search>`
| Param | Type | Description |
| --- | --- | --- |
| query | `string` | Search query |
| filters? | `object` | Search filters |
<details>
<summary>Methods & Getters</summary>
<p>
- `<search>#getMore(shelf)`
- Equivalent to clicking on the shelf to load more items.
- `<search>#getContinuation()`
- Retrieves continuation, only works for individual sections or filtered results.
- `<search>#selectFilter(name)`
- Applies given filter to the search.
- `<search>#has_continuation`
- Checks if continuation is available.
- `<search>#filters`
- Returns available filters.
- `<search>#songs`
- Returns songs shelf.
- `<search>#videos`
- Returns videos shelf.
- `<search>#albums`
- Returns albums shelf.
- `<search>#artists`
- Returns artists shelf.
- `<search>#playlists`
- Returns songs shelf.
- `<search>#page`
- Returns original InnerTube response (sanitized).
</p>
</details>
<a name="gethomefeed"></a>
### getHomeFeed()
Retrieves home feed.
**Returns:** `Promise.<HomeFeed>`
<details>
<summary>Methods & Getters</summary>
<p>
- `<homefeed>#getContinuation()`
- Retrieves continuation, only works for individual sections or filtered results.
- `<homefeed>#has_continuation`
- Checks if continuation is available.
- `<homefeed>#page`
- Returns original InnerTube response (sanitized).
</p>
</details>
<a name="getexplore"></a>
### getExplore()
Retrieves “Explore” feed.
**Returns:** `Promise.<Explore>`
<details>
<summary>Methods & Getters</summary>
<p>
- `<explore>#page`
- Returns original InnerTube response (sanitized).
</p>
</details>
<a name="getlibrary"></a>
### getLibrary()
Retrieves library.
**Returns:** `Promise.<Library>`
<!-- TODO: document Library's methods and getters. -->
<a name="getartist"></a>
### getArtist(artist_id)
Retrieves artist's info & content.
**Returns:** `Promise.<Artist>`
| Param | Type | Description |
| --- | --- | --- |
| artist_id | `string` | Artist id |
<details>
<summary>Methods & Getters</summary>
<p>
- `<artist>#page`
- Returns original InnerTube response (sanitized).
</p>
</details>
<a name="getalbum"></a>
### getAlbum(album_id)
Retrieves given album.
**Returns:** `Promise.<Album>`
| Param | Type | Description |
| --- | --- | --- |
| album_id | `string` | Album id |
<details>
<summary>Methods & Getters</summary>
<p>
- `<album>#page`
- Returns original InnerTube response (sanitized).
</p>
</details>
<a name="getplaylist"></a>
### getPlaylist(playlist_id)
Retrieves given playlist.
**Returns:** `Promise.<Playlist>`
| Param | Type | Description |
| --- | --- | --- |
| playlist_id | `string` | Playlist id |
<details>
<summary>Methods & Getters</summary>
<p>
- `<playlist#getRelated()`
- Retrieves related playlists.
- `<playlist#getSuggestions()`
- Retrieves playlist suggestions.
- `<playlist#getContinuation()`
- Retrieves continuation.
- `<playlist>#has_continuation`
- Checks if continuation is available.
- `<playlist>#page`
- Returns original InnerTube response (sanitized).
</p>
</details>
<a name="getlyrics"></a>
### getLyrics(video_id)
Retrieves song lyrics.
**Returns:** `Promise.<{ text: string; footer: object; }>`
| Param | Type | Description |
| --- | --- | --- |
| video_id | `string` | Video id |
<a name="getupnext"></a>
### getUpNext(video_id)
Retrieves up next content.
**Returns:** `Promise.<PlaylistPanel>`
| Param | Type | Description |
| --- | --- | --- |
| video_id | `string` | Video id |
<a name="getrelated"></a>
### getRelated(video_id)
Retrieves related content.
**Returns:** `Promise.<Array.<MusicCarouselShelf | MusicDescriptionShelf>>`
| Param | Type | Description |
| --- | --- | --- |
| video_id | `string` | Video id |
<a name="getsearchsuggestions"></a>
### getSearchSuggestions(query)
Retrieves search suggestions.
**Returns:** `Promise.<Array.<SearchSuggestion | HistorySuggestion>>`
| Param | Type | Description |
| --- | --- | --- |
| query | `string` | Search query |

72
docs/API/playlist.md Normal file
View File

@@ -0,0 +1,72 @@
# PlaylistManager
Playlist management class.
## API
* PlaylistManager
* [.create(title, video_ids)](#create)
* [.delete(playlist_id)](#delete)
* [.addVideos(playlist_id, video_ids)](#addvideos)
* [.removeVideos(playlist_id, video_ids)](#removevideos)
* [.moveVideo(playlist_id, moved_video_id, predecessor_video_id)](#movevideo)
<a name="create"></a>
### create(title, video_ids)
Creates a playlist.
**Returns:** `Promise.<ActionsResponse>`
| Param | Type | Description |
| --- | --- | --- |
| title | `string` | Playlist name |
| video_ids | `string[]` | array of videos |
<a name="delete"></a>
### delete(playlist_id)
Deletes given playlist.
**Returns:** `Promise.<ActionsResponse>`
| Param | Type | Description |
| --- | --- | --- |
| playlist_id | `string` | Playlist id |
<a name="addvideos"></a>
### addVideos(playlist_id, video_ids)
Adds videos to given playlist.
**Returns:** `Promise.<{ playlist_id: string; action_result: any[] }>`
| Param | Type | Description |
| --- | --- | --- |
| playlist_id | `string` | Playlist id |
| video_ids | `string` | array of videos |
<a name="removevideos"></a>
### removeVideos(playlist_id, video_ids)
Removes videos from given playlist.
**Returns:** `Promise.<{ playlist_id: string; action_result: any[] }>`
| Param | Type | Description |
| --- | --- | --- |
| playlist_id | `string` | Playlist id |
| video_ids | `string` | array of videos |
<a name="movevideo"></a>
### moveVideo(playlist_id, moved_video_id, predecessor_video_id)
Moves a video to a new position within a given playlist.
**Returns:** `Promise.<{ playlist_id: string; action_result: any[] }>`
| Param | Type | Description |
| --- | --- | --- |
| playlist_id | `string` | Playlist id |
| moved_video_id | `string` | the video to be moved |
| predecessor_video_id | `string` | the video present in the target position |

83
docs/API/session.md Normal file
View File

@@ -0,0 +1,83 @@
# Session
Represents an InnerTube session.
## API
* Session
* [.signIn(credentials?)](#signin) ⇒ `function`
* [.signOut()](#signout) ⇒ `function`
* [.key](#key) ⇒ `getter`
* [.api_version](#api_version) ⇒ `getter`
* [.client_version](#client_version) ⇒ `getter`
* [.client_name](#client_name) ⇒ `getter`
* [.context](#context) ⇒ `getter`
* [.player](#player) ⇒ `getter`
* [.lang](#lang) ⇒ `getter`
<a name="signin"></a>
### signIn(credentials?)
Signs in with given credentials.
**Returns:** `Promise<void>`
| Param | Type | Description |
| --- | --- | --- |
| credentials? | `Credentials` | OAuth credentials |
<a name="signout"></a>
### signOut()
Signs out of the current account.
**Returns:** `Promise<ActionsResponse>`
<a name="key"></a>
### key
InnerTube API key.
**Returns:** `string`
<a name="api_version"></a>
### key
InnerTube API version.
**Returns:** `string`
<a name="client_version"></a>
### client_version
InnerTube client version.
**Returns:** `string`
<a name="client_name"></a>
### client_name
InnerTube client name.
**Returns:** `string`
<a name="context"></a>
### context
InnerTube context.
**Returns:** `Context`
<a name="player"></a>
### player
Player script object.
**Returns:** `Player`
<a name="lang"></a>
### lang
Client language.
**Returns:** `string`

33
docs/API/studio.md Normal file
View File

@@ -0,0 +1,33 @@
# Studio
YouTube Studio class (WIP).
## API
* Studio
* [.setThumbnail(video_id, buffer)](#setthumbnail)
* [.upload(file, metadata)](#upload)
<a name="setthumbnail"></a>
### setThumbnail(video_id, buffer)
Uploads a custom thumbnail and sets it for a video.
**Returns:** `Promise.<ActionsResponse>`
| Param | Type | Description |
| --- | --- | --- |
| video_id | `string` | Video id |
| buffer | `Uint8Array` | Thumbnail buffer |
<a name="upload"></a>
### upload(file, metadata)
Uploads a video to YouTube.
**Returns:** `Promise.<ActionsResponse>`
| Param | Type | Description |
| --- | --- | --- |
| file | `BodyInit` | Video file |
| metadata | `VideoMetadata` | Video metadata |