SpotifyApiSpotify LogoJS

TrackManager src/managers/Track.ts#L18

A manager to perform actions which belongs to the spotify track web api.


Properties:

client

Methods:

get getAudioAnalysis getAudioFeatures getMultiple getMultipleAudioFeatures search

constructor(client) src/managers/Track.ts#L18

No documentation found.

NameTypeDescription
clientClientThe spotify api client.

.client

Type:

Client

No documentation found.

.get(id, market, force) src/managers/Track.ts#L50

Get an track's information.

const track = await client.tracks.get('id');

Returns:

Promise<"null" | Track>

Parameters:

NameTypeDescription
idstringThe spotify track id.
marketstringOnly tracks that are available in that market will be returned.
forcebooleanWhen true, will directly fetch else will search for the cache first!

.getAudioAnalysis(id) src/managers/Track.ts#L99

Get the audio analysis of the track. Returned type [AudioAnalysis] is not a camelcase object and not documented.

const audioAnalysis = await client.tracks.getAudioAnalysis('id');

Returns:

Promise<"null" | AudioAnalysis>

Parameters:

NameTypeDescription
idstringThe spotify playlist id.

.getAudioFeatures(id) src/managers/Track.ts#L75

Get the audio features of the track. Returned type [AudioFeatures] is not a camelcased object.

const audioFeatures = await client.tracks.getAudioFeatures('id');

Returns:

Promise<"null" | AudioFeatures>

Parameters:

NameTypeDescription
idstringThe spotify track id.

.getMultiple(ids, market) src/managers/Track.ts#L63

Get the information of multiple spotify tracks in one fetch.

const tracks = await client.tracks.getMultiple(['id1', 'id2']);

Returns:

Promise<Track[]>

Parameters:

NameTypeDescription
idsstring[]An array of spotify ids.
marketstringOnly tracks that are available in that market will be returned.

.getMultipleAudioFeatures(ids) src/managers/Track.ts#L86

Get audio features of multiple tracks. Returned type [AudioFeatures[]] is not a camelcased object.

const audioFeatures = await client.tracks.getMultipleAudioFeatures('id1', 'is2');

Returns:

Promise<AudioFeatures[]>

Parameters:

NameTypeDescription
idsstring[]The array of spotify ids.

.search(query, options) src/managers/Track.ts#L27

Search for spotify tracks with query.

const results = await client.tracks.search('some search');

Returns:

Promise<Track[]>

Parameters:

NameTypeDescription
querystringThe query to search.
optionsSearchOptionsSome search options to make the search more efficient.