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

Interface: tAlbumAttributes

Defined in: album.ts:29

The attributes for an album resource.

Properties

artistName

artistName: string;

Defined in: album.ts:31

The name of the primary artist associated with the album.

---

artistUrl?

optional artistUrl?: string;

Defined in: album.ts:33

The URL of the artist for this content.

---

artwork

artwork: tArtwork;

Defined in: album.ts:35

The artwork for the album.

---

audioVariants?

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

Defined in: album.ts:37

Indicates the specific audio variant for the album.

---

contentRating?

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

Defined in: album.ts:39

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

---

copyright?

optional copyright?: string;

Defined in: album.ts:41

The copyright text.

---

editorialNotes?

optional editorialNotes?: tEditorialNotes;

Defined in: album.ts:43

The notes about the album that appear in the iTunes Store.

---

genreNames

genreNames: string[];

Defined in: album.ts:45

The names of the genres associated with the album.

---

inFavorites?

optional inFavorites?: boolean;

Defined in: album.ts:47

Whether the album is among the listener's favorites.

---

isCompilation

isCompilation: boolean;

Defined in: album.ts:49

Indicates whether the album is marked as a compilation. If true, the album is a compilation; otherwise, it’s not.

---

isComplete

isComplete: boolean;

Defined in: album.ts:51

Indicates whether the album is complete. If true, the album is complete; otherwise, it’s not. An album is complete if it contains all its tracks and songs.

---

isMasteredForItunes

isMasteredForItunes: boolean;

Defined in: album.ts:53

Indicates whether the response delivered the album as an .

---

isSingle

isSingle: boolean;

Defined in: album.ts:55

Indicates whether the album contains a single song.

---

name

name: string;

Defined in: album.ts:57

The localized name of the album.

---

playParams?

optional playParams?: tPlayParameters;

Defined in: album.ts:59

When present, this attribute indicates that one or more tracks on the album are available to play with an Apple Music subscription. The value map may be used to initiate playback of available tracks on the album.

---

recordLabel?

optional recordLabel?: string;

Defined in: album.ts:61

The name of the record label for the album.

---

releaseDate?

optional releaseDate?: string;

Defined in: album.ts:63

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

---

trackCount

trackCount: number;

Defined in: album.ts:65

The number of tracks for the album.

---

upc?

optional upc?: string;

Defined in: album.ts:67

The Universal Product Code for the album.

---

url

url: string;

Defined in: album.ts:69

The URL for sharing the album in Apple Music.