mirror of
https://github.com/LuanRT/YouTube.js.git
synced 2026-06-26 08:08:54 +00:00
chore: Use latest version of typedoc-plugin-markdown
This commit is contained in:
Luan
@@ -1,116 +0,0 @@
|
||||
[youtubei.js](../../../README.md) / [Clients](../README.md) / Kids
|
||||
|
||||
# Class: Kids
|
||||
|
||||
## Constructors
|
||||
|
||||
### new Kids()
|
||||
|
||||
> **new Kids**(`session`): [`Kids`](Kids.md)
|
||||
|
||||
#### Parameters
|
||||
|
||||
• **session**: [`Session`](../../../classes/Session.md)
|
||||
|
||||
#### Returns
|
||||
|
||||
[`Kids`](Kids.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/core/clients/Kids.ts:12](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/clients/Kids.ts#L12)
|
||||
|
||||
## Methods
|
||||
|
||||
### blockChannel()
|
||||
|
||||
> **blockChannel**(`channel_id`): `Promise`\<[`ApiResponse`](../../../interfaces/ApiResponse.md)[]\>
|
||||
|
||||
Retrieves the list of supervised accounts that the signed-in user has
|
||||
access to, and blocks the given channel for each of them.
|
||||
|
||||
#### Parameters
|
||||
|
||||
• **channel\_id**: `string`
|
||||
|
||||
The channel id to block.
|
||||
|
||||
#### Returns
|
||||
|
||||
`Promise`\<[`ApiResponse`](../../../interfaces/ApiResponse.md)[]\>
|
||||
|
||||
A list of API responses.
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/core/clients/Kids.ts:79](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/clients/Kids.ts#L79)
|
||||
|
||||
***
|
||||
|
||||
### getChannel()
|
||||
|
||||
> **getChannel**(`channel_id`): `Promise`\<[`Channel`](../../YTKids/classes/Channel.md)\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
• **channel\_id**: `string`
|
||||
|
||||
#### Returns
|
||||
|
||||
`Promise`\<[`Channel`](../../YTKids/classes/Channel.md)\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/core/clients/Kids.ts:61](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/clients/Kids.ts#L61)
|
||||
|
||||
***
|
||||
|
||||
### getHomeFeed()
|
||||
|
||||
> **getHomeFeed**(): `Promise`\<[`HomeFeed`](../../YTKids/classes/HomeFeed.md)\>
|
||||
|
||||
#### Returns
|
||||
|
||||
`Promise`\<[`HomeFeed`](../../YTKids/classes/HomeFeed.md)\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/core/clients/Kids.ts:67](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/clients/Kids.ts#L67)
|
||||
|
||||
***
|
||||
|
||||
### getInfo()
|
||||
|
||||
> **getInfo**(`video_id`, `options`?): `Promise`\<[`VideoInfo`](../../YTKids/classes/VideoInfo.md)\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
• **video\_id**: `string`
|
||||
|
||||
• **options?**: `Omit`\<[`GetVideoInfoOptions`](../../Types/interfaces/GetVideoInfoOptions.md), `"client"`\>
|
||||
|
||||
#### Returns
|
||||
|
||||
`Promise`\<[`VideoInfo`](../../YTKids/classes/VideoInfo.md)\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/core/clients/Kids.ts:22](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/clients/Kids.ts#L22)
|
||||
|
||||
***
|
||||
|
||||
### search()
|
||||
|
||||
> **search**(`query`): `Promise`\<[`Search`](../../YTKids/classes/Search.md)\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
• **query**: `string`
|
||||
|
||||
#### Returns
|
||||
|
||||
`Promise`\<[`Search`](../../YTKids/classes/Search.md)\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/core/clients/Kids.ts:16](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/clients/Kids.ts#L16)
|
||||
@@ -1,251 +0,0 @@
|
||||
[youtubei.js](../../../README.md) / [Clients](../README.md) / Music
|
||||
|
||||
# Class: Music
|
||||
|
||||
## Constructors
|
||||
|
||||
### new Music()
|
||||
|
||||
> **new Music**(`session`): [`Music`](Music.md)
|
||||
|
||||
#### Parameters
|
||||
|
||||
• **session**: [`Session`](../../../classes/Session.md)
|
||||
|
||||
#### Returns
|
||||
|
||||
[`Music`](Music.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/core/clients/Music.ts:37](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/clients/Music.ts#L37)
|
||||
|
||||
## Methods
|
||||
|
||||
### getAlbum()
|
||||
|
||||
> **getAlbum**(`album_id`): `Promise`\<[`Album`](../../YTMusic/classes/Album.md)\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
• **album\_id**: `string`
|
||||
|
||||
#### Returns
|
||||
|
||||
`Promise`\<[`Album`](../../YTMusic/classes/Album.md)\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/core/clients/Music.ts:186](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/clients/Music.ts#L186)
|
||||
|
||||
***
|
||||
|
||||
### getArtist()
|
||||
|
||||
> **getArtist**(`artist_id`): `Promise`\<[`Artist`](../../YTMusic/classes/Artist.md)\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
• **artist\_id**: `string`
|
||||
|
||||
#### Returns
|
||||
|
||||
`Promise`\<[`Artist`](../../YTMusic/classes/Artist.md)\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/core/clients/Music.ts:176](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/clients/Music.ts#L176)
|
||||
|
||||
***
|
||||
|
||||
### getExplore()
|
||||
|
||||
> **getExplore**(): `Promise`\<[`Explore`](../../YTMusic/classes/Explore.md)\>
|
||||
|
||||
#### Returns
|
||||
|
||||
`Promise`\<[`Explore`](../../YTMusic/classes/Explore.md)\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/core/clients/Music.ts:163](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/clients/Music.ts#L163)
|
||||
|
||||
***
|
||||
|
||||
### getHomeFeed()
|
||||
|
||||
> **getHomeFeed**(): `Promise`\<[`HomeFeed`](../../YTMusic/classes/HomeFeed.md)\>
|
||||
|
||||
#### Returns
|
||||
|
||||
`Promise`\<[`HomeFeed`](../../YTMusic/classes/HomeFeed.md)\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/core/clients/Music.ts:157](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/clients/Music.ts#L157)
|
||||
|
||||
***
|
||||
|
||||
### getInfo()
|
||||
|
||||
> **getInfo**(`target`, `options`?): `Promise`\<[`TrackInfo`](../../YTMusic/classes/TrackInfo.md)\>
|
||||
|
||||
Retrieves track info. Passing a list item of type MusicTwoRowItem automatically starts a radio.
|
||||
|
||||
#### Parameters
|
||||
|
||||
• **target**: `string` \| [`NavigationEndpoint`](../../YTNodes/classes/NavigationEndpoint.md) \| [`MusicResponsiveListItem`](../../YTNodes/classes/MusicResponsiveListItem.md) \| [`MusicTwoRowItem`](../../YTNodes/classes/MusicTwoRowItem.md)
|
||||
|
||||
Video id or a list item.
|
||||
|
||||
• **options?**: `Omit`\<[`GetVideoInfoOptions`](../../Types/interfaces/GetVideoInfoOptions.md), `"client"`\>
|
||||
|
||||
Options for fetching video info.
|
||||
|
||||
#### Returns
|
||||
|
||||
`Promise`\<[`TrackInfo`](../../YTMusic/classes/TrackInfo.md)\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/core/clients/Music.ts:47](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/clients/Music.ts#L47)
|
||||
|
||||
***
|
||||
|
||||
### getLibrary()
|
||||
|
||||
> **getLibrary**(): `Promise`\<[`Library`](../../YTMusic/classes/Library.md)\>
|
||||
|
||||
#### Returns
|
||||
|
||||
`Promise`\<[`Library`](../../YTMusic/classes/Library.md)\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/core/clients/Music.ts:170](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/clients/Music.ts#L170)
|
||||
|
||||
***
|
||||
|
||||
### getLyrics()
|
||||
|
||||
> **getLyrics**(`video_id`): `Promise`\<`undefined` \| [`MusicDescriptionShelf`](../../YTNodes/classes/MusicDescriptionShelf.md)\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
• **video\_id**: `string`
|
||||
|
||||
#### Returns
|
||||
|
||||
`Promise`\<`undefined` \| [`MusicDescriptionShelf`](../../YTNodes/classes/MusicDescriptionShelf.md)\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/core/clients/Music.ts:267](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/clients/Music.ts#L267)
|
||||
|
||||
***
|
||||
|
||||
### getPlaylist()
|
||||
|
||||
> **getPlaylist**(`playlist_id`): `Promise`\<[`Playlist`](../../YTMusic/classes/Playlist.md)\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
• **playlist\_id**: `string`
|
||||
|
||||
#### Returns
|
||||
|
||||
`Promise`\<[`Playlist`](../../YTMusic/classes/Playlist.md)\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/core/clients/Music.ts:196](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/clients/Music.ts#L196)
|
||||
|
||||
***
|
||||
|
||||
### getRecap()
|
||||
|
||||
> **getRecap**(): `Promise`\<[`Recap`](../../YTMusic/classes/Recap.md)\>
|
||||
|
||||
#### Returns
|
||||
|
||||
`Promise`\<[`Recap`](../../YTMusic/classes/Recap.md)\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/core/clients/Music.ts:293](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/clients/Music.ts#L293)
|
||||
|
||||
***
|
||||
|
||||
### getRelated()
|
||||
|
||||
> **getRelated**(`video_id`): `Promise`\<[`SectionList`](../../YTNodes/classes/SectionList.md) \| [`Message`](../../YTNodes/classes/Message.md)\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
• **video\_id**: `string`
|
||||
|
||||
#### Returns
|
||||
|
||||
`Promise`\<[`SectionList`](../../YTNodes/classes/SectionList.md) \| [`Message`](../../YTNodes/classes/Message.md)\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/core/clients/Music.ts:246](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/clients/Music.ts#L246)
|
||||
|
||||
***
|
||||
|
||||
### getSearchSuggestions()
|
||||
|
||||
> **getSearchSuggestions**(`input`): `Promise`\<[`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`SearchSuggestionsSection`](../../YTNodes/classes/SearchSuggestionsSection.md)\>\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
• **input**: `string`
|
||||
|
||||
#### Returns
|
||||
|
||||
`Promise`\<[`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`SearchSuggestionsSection`](../../YTNodes/classes/SearchSuggestionsSection.md)\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/core/clients/Music.ts:299](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/clients/Music.ts#L299)
|
||||
|
||||
***
|
||||
|
||||
### getUpNext()
|
||||
|
||||
> **getUpNext**(`video_id`, `automix`): `Promise`\<[`PlaylistPanel`](../../YTNodes/classes/PlaylistPanel.md)\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
• **video\_id**: `string`
|
||||
|
||||
• **automix**: `boolean` = `true`
|
||||
|
||||
#### Returns
|
||||
|
||||
`Promise`\<[`PlaylistPanel`](../../YTNodes/classes/PlaylistPanel.md)\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/core/clients/Music.ts:206](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/clients/Music.ts#L206)
|
||||
|
||||
***
|
||||
|
||||
### search()
|
||||
|
||||
> **search**(`query`, `filters`): `Promise`\<[`Search`](../../YTMusic/classes/Search.md)\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
• **query**: `string`
|
||||
|
||||
• **filters**: [`MusicSearchFilters`](../../Types/type-aliases/MusicSearchFilters.md) = `{}`
|
||||
|
||||
#### Returns
|
||||
|
||||
`Promise`\<[`Search`](../../YTMusic/classes/Search.md)\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/core/clients/Music.ts:135](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/clients/Music.ts#L135)
|
||||
@@ -1,89 +0,0 @@
|
||||
[youtubei.js](../../../README.md) / [Clients](../README.md) / Studio
|
||||
|
||||
# Class: Studio
|
||||
|
||||
## Constructors
|
||||
|
||||
### new Studio()
|
||||
|
||||
> **new Studio**(`session`): [`Studio`](Studio.md)
|
||||
|
||||
#### Parameters
|
||||
|
||||
• **session**: [`Session`](../../../classes/Session.md)
|
||||
|
||||
#### Returns
|
||||
|
||||
[`Studio`](Studio.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/core/clients/Studio.ts:25](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/clients/Studio.ts#L25)
|
||||
|
||||
## Methods
|
||||
|
||||
### updateVideoMetadata()
|
||||
|
||||
> **updateVideoMetadata**(`video_id`, `metadata`): `Promise`\<[`ApiResponse`](../../../interfaces/ApiResponse.md)\>
|
||||
|
||||
Updates the metadata of a video.
|
||||
|
||||
#### Parameters
|
||||
|
||||
• **video\_id**: `string`
|
||||
|
||||
• **metadata**: `Partial`\<`object`\>
|
||||
|
||||
#### Returns
|
||||
|
||||
`Promise`\<[`ApiResponse`](../../../interfaces/ApiResponse.md)\>
|
||||
|
||||
#### Example
|
||||
|
||||
```ts
|
||||
const videoId = 'abcdefg';
|
||||
const thumbnail = fs.readFileSync('./my_awesome_thumbnail.jpg');
|
||||
|
||||
const response = await yt.studio.updateVideoMetadata(videoId, {
|
||||
tags: [ 'astronomy', 'NASA', 'APOD' ],
|
||||
title: 'Artemis Mission',
|
||||
description: 'A nicely written description...',
|
||||
category: 27,
|
||||
license: 'creative_commons',
|
||||
thumbnail,
|
||||
// ...
|
||||
});
|
||||
```
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/core/clients/Studio.ts:47](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/clients/Studio.ts#L47)
|
||||
|
||||
***
|
||||
|
||||
### upload()
|
||||
|
||||
> **upload**(`file`, `metadata`): `Promise`\<[`ApiResponse`](../../../interfaces/ApiResponse.md)\>
|
||||
|
||||
Uploads a video to YouTube.
|
||||
|
||||
#### Parameters
|
||||
|
||||
• **file**: `BodyInit`
|
||||
|
||||
• **metadata**: `Partial`\<`object`\> = `{}`
|
||||
|
||||
#### Returns
|
||||
|
||||
`Promise`\<[`ApiResponse`](../../../interfaces/ApiResponse.md)\>
|
||||
|
||||
#### Example
|
||||
|
||||
```ts
|
||||
const file = fs.readFileSync('./my_awesome_video.mp4');
|
||||
const response = await yt.studio.upload(file.buffer, { title: 'Wow!' });
|
||||
```
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/core/clients/Studio.ts:150](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/clients/Studio.ts#L150)
|
||||
Reference in New Issue
Block a user