Skip to content
Client
Server

Reference / @open-music-sdk/lib-playlists / tTrackDescription

Interface: tTrackDescription ​

Defined in: lib/lib-playlists/src/resolve.ts:19

What is known of a track from outside Apple's catalog. The names are the ones a song's attributes have, so a song's attributes are a description, and so is a track of a playlist that was read. A description with an isrc is looked up by it; one with a name and an artistName can be searched for; one with neither of those is matched by nothing. A field that is a string and of no use, such as an empty name or an ISRC with a comma in it, is taken as not given.

Properties ​

albumName? ​

ts
readonly optional albumName?: string;

Defined in: lib/lib-playlists/src/resolve.ts:30

Decides between several songs that match: the one on this album is taken.


artistName? ​

ts
readonly optional artistName?: string;

Defined in: lib/lib-playlists/src/resolve.ts:28

Who performs it, as a song's artistName attribute has it. Without it a name alone is searched for, and nothing the search finds is kept.


durationInMillis? ​

ts
readonly optional durationInMillis?: number;

Defined in: lib/lib-playlists/src/resolve.ts:32

Decides between several songs that match: the one nearest this length is taken.


isrc? ​

ts
readonly optional isrc?: string;

Defined in: lib/lib-playlists/src/resolve.ts:24

The recording's International Standard Recording Code, such as "USUM71703861". It may be written as it is printed, with hyphens or spaces and in small letters: GB-AYE-06-01498 is GBAYE0601498.


name? ​

ts
readonly optional name?: string;

Defined in: lib/lib-playlists/src/resolve.ts:26

The track's title, as a song's name attribute has it. Searched for together with artistName, and a song is kept only when both are the same.

MIT licensed. Not affiliated with, endorsed by, or sponsored by Apple Inc. Apple Music and MusicKit are trademarks of Apple Inc.