Reference / @open-music-sdk/types / tSongAttributes

Interface: tSongAttributes

Defined in: song.ts:26

The attributes for a song resource.

Properties

albumName

albumName: string;

Defined in: song.ts:28

The name of the album the song appears on.

---

artistName

artistName: string;

Defined in: song.ts:30

The artist’s name.

---

artistUrl?

optional artistUrl?: string;

Defined in: song.ts:32

The URL of the artist for the content.

---

artwork

artwork: tArtwork;

Defined in: song.ts:34

The album artwork.

---

attribution?

optional attribution?: string;

Defined in: song.ts:36

(Classical music only) The name of the artist or composer to attribute the song with.

---

audioVariants?

optional audioVariants?: (
  | "dolby-atmos"
  | "dolby-audio"
  | "hi-res-lossless"
  | "lossless"
  | "lossy-stereo")[];

Defined in: song.ts:38

Indicates the specific audio variant for a song.

---

composerName?

optional composerName?: string;

Defined in: song.ts:40

The song’s composer.

---

contentRating?

optional contentRating?: "clean" | "explicit";

Defined in: song.ts:42

The Recording Industry Association of America (RIAA) rating of the content. No value means no rating.

---

discNumber?

optional discNumber?: number;

Defined in: song.ts:44

The disc number of the album the song appears on.

---

durationInMillis?

optional durationInMillis?: number;

Defined in: song.ts:46

The duration of the song in milliseconds. Left out for some of an album's tracks against the live API on 18 October 2026.

---

editorialNotes?

optional editorialNotes?: tEditorialNotes;

Defined in: song.ts:48

The notes about the song that appear in the Apple Music catalog.

---

genreNames

genreNames: string[];

Defined in: song.ts:50

The genre names the song is associated with.

---

hasLyrics

hasLyrics: boolean;

Defined in: song.ts:52

Indicates whether the song has lyrics available in the Apple Music catalog. If true, the song has lyrics available; otherwise, it doesn’t.

---

inFavorites?

optional inFavorites?: boolean;

Defined in: song.ts:54

Whether the catalog resource ID is in the person’s favorites.

---

isAppleDigitalMaster

isAppleDigitalMaster: boolean;

Defined in: song.ts:56

Indicates whether the response delivered the song as an .

---

isrc?

optional isrc?: string;

Defined in: song.ts:58

The International Standard Recording Code (ISRC) for the song.

---

movementCount?

optional movementCount?: number;

Defined in: song.ts:60

(Classical music only) The movement count of the song.

---

movementName?

optional movementName?: string;

Defined in: song.ts:62

(Classical music only) The movement name of the song.

---

movementNumber?

optional movementNumber?: number;

Defined in: song.ts:64

(Classical music only) The movement number of the song.

---

name

name: string;

Defined in: song.ts:66

The localized name of the song.

---

playParams?

optional playParams?: tPlayParameters;

Defined in: song.ts:68

When present, this attribute indicates that the song is available to play with an Apple Music subscription. The value map may be used to initiate playback. Previews of the song audio may be available with or without an Apple Music subscription.

---

previews

previews: tPreview[];

Defined in: song.ts:70

The preview assets for the song.

---

releaseDate?

optional releaseDate?: string;

Defined in: song.ts:72

The release date of the song, when known, in YYYY-MM-DD or YYYY format. Prerelease songs may have an expected release date in the future.

---

trackNumber?

optional trackNumber?: number;

Defined in: song.ts:74

The number of the song in the album’s track list.

---

url

url: string;

Defined in: song.ts:76

The URL for sharing the song in Apple Music.

---

workName?

optional workName?: string;

Defined in: song.ts:78

(Classical music only) The name of the associated work.