MusicKit · IOS API REFERENCE

Playlist

struct · iOS 15.0+ · SDK 27.1

struct Playlist

A music item that represents a playlist.

Members (21)

get · iOS 15.0+

curatorName

TypeScript

get curatorName(): (string) | null

Swift declaration

var curatorName: String? { get }

The display name for the playlist’s curator.

get · iOS 15.0+

description

TypeScript

get description(): string

Swift declaration

var description: String { get }

A textual representation of this instance. Calling this property directly is discouraged. Instead, convert an instance of any type to a string by using the `String(describing:)` initializer. This initializer works with any type, and uses the custom `description` property for types that conform to `CustomStringConvertible`: struct Point: CustomStringConvertible { let x: Int, y: Int var description: String { return "(\(x), \(y))" } } let p = Point(x: 21, y: 30) let s = String(describing: p) print(s) // Prints "(21, 30)" The conversion of `p` to a string in the assignment to `s` uses the `Point` type's `description` property.

get · iOS 15.0+

moreByCurator

TypeScript

get moreByCurator(): (MusicItemCollection<Playlist>) | null

Swift declaration

var moreByCurator: MusicItemCollection<Playlist>? { get }

A collection of additional playlists by the same curator.

get · iOS 16.0+

lastPlayedDate

TypeScript

get lastPlayedDate(): (globalThis.Date) | null

Swift declaration

var lastPlayedDate: Date? { get }

The date when the user last played the playlist on this device.

get · iOS 15.0+

playParameters

TypeScript

get playParameters(): (PlayParameters) | null

Swift declaration

var playParameters: PlayParameters? { get }

The parameters to use to play the tracks in the playlist.

get · iOS 15.0+

featuredArtists

TypeScript

get featuredArtists(): (MusicItemCollection<Artist>) | null

Swift declaration

var featuredArtists: MusicItemCollection<Artist>? { get }

A collection of featured artists for this playlist.

get · iOS 15.0+

debugDescription

TypeScript

get debugDescription(): string

Swift declaration

var debugDescription: String { get }

A textual representation of this instance, suitable for debugging. Calling this property directly is discouraged. Instead, convert an instance of any type to a string by using the `String(reflecting:)` initializer. This initializer works with any type, and uses the custom `debugDescription` property for types that conform to `CustomDebugStringConvertible`: struct Point: CustomDebugStringConvertible { let x: Int, y: Int var debugDescription: String { return "(\(x), \(y))" } } let p = Point(x: 21, y: 30) let s = String(reflecting: p) print(s) // Prints "(21, 30)" The conversion of `p` to a string in the assignment to `s` uses the `Point` type's `debugDescription` property.

get · iOS 15.0+

lastModifiedDate

TypeScript

get lastModifiedDate(): (globalThis.Date) | null

Swift declaration

var lastModifiedDate: Date? { get }

The playlist’s most recent modification date.

get · iOS 16.0+

libraryAddedDate

TypeScript

get libraryAddedDate(): (globalThis.Date) | null

Swift declaration

var libraryAddedDate: Date? { get }

The date when the user added the playlist to the library.

get · iOS 15.0+

shortDescription

TypeScript

get shortDescription(): (string) | null

Swift declaration

var shortDescription: String? { get }

An abbreviated description to show inline or when the playlist appears alongside other content.

get · iOS 15.0+

standardDescription

TypeScript

get standardDescription(): (string) | null

Swift declaration

var standardDescription: String? { get }

A description to show when the playlist is prominently displayed.

get · iOS 15.0+

id

TypeScript

get id(): MusicItemID

Swift declaration

let id: MusicItemID

The unique identifier for the playlist.

get · iOS 15.0+

url

TypeScript

get url(): (string) | null

Swift declaration

var url: URL? { get }

The URL for the playlist.

get · iOS 15.0+

kind

TypeScript

get kind(): (Playlist_Kind) | null

Swift declaration

var kind: Playlist.Kind? { get }

The kind of playlist.

get · iOS 15.0+

name

TypeScript

get name(): string

Swift declaration

var name: String { get }

The name of the playlist.

get · iOS 15.0+

tracks

TypeScript

get tracks(): (MusicItemCollection<Track>) | null

Swift declaration

var tracks: MusicItemCollection<Track>? { get }

The tracks in the playlist.

get · iOS 15.0+

artwork

TypeScript

get artwork(): (Artwork) | null

Swift declaration

var artwork: Artwork? { get }

The artwork for the playlist.

get · iOS 16.0+

curator

TypeScript

get curator(): (Curator) | null

Swift declaration

var curator: Curator? { get }

The playlist’s associated curator.

get · iOS 16.0+

entries

TypeScript

get entries(): (MusicItemCollection<Playlist_Entry>) | null

Swift declaration

var entries: MusicItemCollection<Playlist.Entry>? { get }

The entries in the playlist

get · iOS 15.0+

isChart

TypeScript

get isChart(): (boolean) | null

Swift declaration

var isChart: Bool? { get }

A Boolean value that indicates whether the playlist represents a popularity chart.

get · iOS 16.0+

radioShow

TypeScript

get radioShow(): (RadioShow) | null

Swift declaration

var radioShow: RadioShow? { get }

The playlist’s associated radio show.

Skipped declarations

No declarations were skipped in this snapshot.

All MusicKit types →