Files
YouTube.js/docs/api/namespaces/Clients/classes/Music.md
Luan 25d0876b91 refactor(Player)!: Use AST-based JS extraction with side-effect safe code emission (#1052)
* chore(deps): Add `meriyah`

* feat(utils): Implement AST-based JS extractors

* chore(utils): Remove old ast walker code

* fix(Player): Migrate js extraction logic

* chore(JsExtractor): Fix typo in tsdoc

* perf(JsAnalyzer): Simplify main AST analysis logic

* fix(JsAnalyzer): Change `break` to `return` in AST matching logic

* chore: Update docs

* chore: Don't export `PlayerInitializationOptions`

* chore(evaluate): Update error message to include doc link

* perf: Use a `for-loop` to find iife
2025-10-12 09:08:51 -03:00

6.3 KiB

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:186


getArtist()

getArtist(artist_id): Promise<Artist>

Parameters

artist_id: string

Returns

Promise<Artist>

Defined in

src/core/clients/Music.ts:176


getExplore()

getExplore(): Promise<Explore>

Returns

Promise<Explore>

Defined in

src/core/clients/Music.ts:163


getHomeFeed()

getHomeFeed(): Promise<HomeFeed>

Returns

Promise<HomeFeed>

Defined in

src/core/clients/Music.ts:157


getInfo()

getInfo(target, options?): 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.

options?: Omit<GetVideoInfoOptions, "client">

Options for fetching video info.

Returns

Promise<TrackInfo>

Defined in

src/core/clients/Music.ts:47


getLibrary()

getLibrary(): Promise<Library>

Returns

Promise<Library>

Defined in

src/core/clients/Music.ts:170


getLyrics()

getLyrics(video_id): Promise<undefined | MusicDescriptionShelf>

Parameters

video_id: string

Returns

Promise<undefined | MusicDescriptionShelf>

Defined in

src/core/clients/Music.ts:267


getPlaylist()

getPlaylist(playlist_id): Promise<Playlist>

Parameters

playlist_id: string

Returns

Promise<Playlist>

Defined in

src/core/clients/Music.ts:196


getRecap()

getRecap(): Promise<Recap>

Returns

Promise<Recap>

Defined in

src/core/clients/Music.ts:293


getRelated()

getRelated(video_id): Promise<SectionList | Message>

Parameters

video_id: string

Returns

Promise<SectionList | Message>

Defined in

src/core/clients/Music.ts:246


getSearchSuggestions()

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

Parameters

input: string

Returns

Promise<ObservedArray<SearchSuggestionsSection>>

Defined in

src/core/clients/Music.ts:299


getUpNext()

getUpNext(video_id, automix): Promise<PlaylistPanel>

Parameters

video_id: string

automix: boolean = true

Returns

Promise<PlaylistPanel>

Defined in

src/core/clients/Music.ts:206


search(query, filters): Promise<Search>

Parameters

query: string

filters: MusicSearchFilters = {}

Returns

Promise<Search>

Defined in

src/core/clients/Music.ts:135