YouTube.js
Guide
Discord
GitHub
Guide
Discord
GitHub

youtubei.js / Clients / Music

Class: Music

Constructors

new Music()

new Music(session): Music

Parameters

• session: Session

Returns

Music

Defined in

src/core/clients/Music.ts:37

Methods

getAlbum()

getAlbum(album_id): Promise<Album>

Parameters

• album_id: string

Returns

Promise<Album>

Defined in

src/core/clients/Music.ts:160


getArtist()

getArtist(artist_id): Promise<Artist>

Parameters

• artist_id: string

Returns

Promise<Artist>

Defined in

src/core/clients/Music.ts:150


getExplore()

getExplore(): Promise<Explore>

Returns

Promise<Explore>

Defined in

src/core/clients/Music.ts:137


getHomeFeed()

getHomeFeed(): Promise<HomeFeed>

Returns

Promise<HomeFeed>

Defined in

src/core/clients/Music.ts:131


getInfo()

getInfo(target): Promise<TrackInfo>

Retrieves track info. Passing a list item of type MusicTwoRowItem automatically starts a radio.

Parameters

• target: string | NavigationEndpoint | MusicResponsiveListItem | MusicTwoRowItem

Video id or a list item.

Returns

Promise<TrackInfo>

Defined in

src/core/clients/Music.ts:46


getLibrary()

getLibrary(): Promise<Library>

Returns

Promise<Library>

Defined in

src/core/clients/Music.ts:144


getLyrics()

getLyrics(video_id): Promise<undefined | MusicDescriptionShelf>

Parameters

• video_id: string

Returns

Promise<undefined | MusicDescriptionShelf>

Defined in

src/core/clients/Music.ts:241


getPlaylist()

getPlaylist(playlist_id): Promise<Playlist>

Parameters

• playlist_id: string

Returns

Promise<Playlist>

Defined in

src/core/clients/Music.ts:170


getRecap()

getRecap(): Promise<Recap>

Returns

Promise<Recap>

Defined in

src/core/clients/Music.ts:267


getRelated()

getRelated(video_id): Promise<SectionList | Message>

Parameters

• video_id: string

Returns

Promise<SectionList | Message>

Defined in

src/core/clients/Music.ts:220


getSearchSuggestions()

getSearchSuggestions(input): Promise<ObservedArray<SearchSuggestionsSection>>

Parameters

• input: string

Returns

Promise<ObservedArray<SearchSuggestionsSection>>

Defined in

src/core/clients/Music.ts:273


getUpNext()

getUpNext(video_id, automix): Promise<PlaylistPanel>

Parameters

• video_id: string

• automix: boolean = true

Returns

Promise<PlaylistPanel>

Defined in

src/core/clients/Music.ts:180


search()

search(query, filters): Promise<Search>

Parameters

• query: string

• filters: MusicSearchFilters = {}

Returns

Promise<Search>

Defined in

src/core/clients/Music.ts:109

Edit this page
Last Updated:: 3/25/25, 8:08 PM
Contributors: EdamAme-x