new Music(session): Music

Defined in: src/core/clients/Music.ts:37

Parameters

session

Session

Returns

Music

Methods

getAlbum()

getAlbum(album_id): Promise<Album>

Defined in: src/core/clients/Music.ts:186

Parameters

album_id

string

Returns

Promise<Album>

getArtist()

getArtist(artist_id): Promise<Artist>

Defined in: src/core/clients/Music.ts:176

Parameters

artist_id

string

Returns

Promise<Artist>

getExplore()

getExplore(): Promise<Explore>

Defined in: src/core/clients/Music.ts:163

Returns

Promise<Explore>

getHomeFeed()

getHomeFeed(): Promise<HomeFeed>

Defined in: src/core/clients/Music.ts:157

Returns

Promise<HomeFeed>

getInfo()

getInfo(target, options?): Promise<TrackInfo>

Defined in: src/core/clients/Music.ts:47

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

Parameters

target

Video id or a list item.

string | NavigationEndpoint | MusicResponsiveListItem | MusicTwoRowItem

options?

Omit<GetVideoInfoOptions, "client">

Options for fetching video info.

Returns

Promise<TrackInfo>

getLibrary()

getLibrary(): Promise<Library>

Defined in: src/core/clients/Music.ts:170

Returns

Promise<Library>

getLyrics()

getLyrics(video_id): Promise<MusicDescriptionShelf | undefined>

Defined in: src/core/clients/Music.ts:267

Parameters

video_id

string

Returns

Promise<MusicDescriptionShelf | undefined>

getPlaylist()

getPlaylist(playlist_id): Promise<Playlist>

Defined in: src/core/clients/Music.ts:196

Parameters

playlist_id

string

Returns

Promise<Playlist>

getRecap()

getRecap(): Promise<Recap>

Defined in: src/core/clients/Music.ts:293

Returns

Promise<Recap>

getRelated()

getRelated(video_id): Promise<SectionList | Message>

Defined in: src/core/clients/Music.ts:246

Parameters

video_id

string

Returns

Promise<SectionList | Message>

getSearchSuggestions()

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

Defined in: src/core/clients/Music.ts:299

Parameters

input

string

Returns

Promise<ObservedArray<SearchSuggestionsSection>>

getUpNext()

getUpNext(video_id, automix): Promise<PlaylistPanel>

Defined in: src/core/clients/Music.ts:206

Parameters

video_id

string

automix

boolean = true

Returns

Promise<PlaylistPanel>

search()

search(query, filters): Promise<Search>

Defined in: src/core/clients/Music.ts:135

Parameters

query

string

filters

MusicSearchFilters = {}

Returns

Promise<Search>