Reference / @open-music-sdk/client-catalog / getLiveRadioStations

Function: getLiveRadioStations()

function getLiveRadioStations(client, options?): Promise<tStationsResponse>;

Defined in: clients/client-catalog/src/discover.ts:205

The live radio stations of Apple Music, such as Apple Music 1.

Parameters

client

tAppleMusicClient

The client to ask with.

options?

tLiveRadioStationsOptions

The storefront to ask in, and what to send beside the stations.

Returns

Promise<tStationsResponse>

What Apple answered: the live stations under data.

Throws

TypeError if client is no client or an argument is not what it should be, before Apple is asked.

Throws

AppleMusicError if Apple, the network, or a token provider fails, if the client has no storefront to ask in, or a schema finds issues; _tag says which.

Throws

The reason options.signal aborted with, when it does.

Throws

Whatever a token provider, store, schema, hook or rate limiter throws, as client.request passes it on.