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

Interface: tMusicVideoAttributes

Defined in: music-video.ts:27

The attributes for a music video resource.

Properties

albumName?

optional albumName?: string;

Defined in: music-video.ts:29

The name of the album the music video appears on.

---

artistName

artistName: string;

Defined in: music-video.ts:31

The artist’s name.

---

artistUrl?

optional artistUrl?: string;

Defined in: music-video.ts:33

The URL of the artist for this content.

---

artwork

artwork: tArtwork;

Defined in: music-video.ts:35

The artwork for the music video’s associated album.

---

contentRating?

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

Defined in: music-video.ts:37

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

---

durationInMillis?

optional durationInMillis?: number;

Defined in: music-video.ts:39

The duration of the music video 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: music-video.ts:41

The editorial notes for the music video.

---

genreNames

genreNames: string[];

Defined in: music-video.ts:43

The music video’s associated genres.

---

has4K

has4K: boolean;

Defined in: music-video.ts:45

Whether the music video has 4K content.

---

hasHDR

hasHDR: boolean;

Defined in: music-video.ts:47

Whether the music video has HDR10-encoded content.

---

inFavorites?

optional inFavorites?: boolean;

Defined in: music-video.ts:49

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

---

isrc?

optional isrc?: string;

Defined in: music-video.ts:51

The International Standard Recording Code (ISRC) for the music video.

---

name

name: string;

Defined in: music-video.ts:53

The localized name of the music video.

---

playParams?

optional playParams?: tPlayParameters;

Defined in: music-video.ts:55

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

---

previews

previews: tPreview[];

Defined in: music-video.ts:57

The preview assets for the music video.

---

releaseDate?

optional releaseDate?: string;

Defined in: music-video.ts:59

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

---

trackNumber?

optional trackNumber?: number;

Defined in: music-video.ts:61

The number of the music video in the album’s track list, when associated with an album.

---

url

url: string;

Defined in: music-video.ts:63

The URL for sharing the music video in Apple Music.

---

videoSubType?

optional videoSubType?: "preview";

Defined in: music-video.ts:65

The video subtype associated with the content.

---

workId?

optional workId?: string;

Defined in: music-video.ts:67

(Classical music only) A unique identifier for the associated work.

---

workName?

optional workName?: string;

Defined in: music-video.ts:69

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