One Logo Pool Ball
Media · IOS API REFERENCE

MusicKit

Integrate your app with Apple Music.

219 types

674 callable entries

97 skipped

87% entry coverage

Generated from iOS SDK 27.1. Availability is shown on each declaration; permissions and entitlements still apply.

Types

Album

struct · iOS 15.0+

Album.FilterType

typealias · iOS 15.0+

Album.ID

typealias · iOS 15.0+

Album.LibraryFilter

typealias · iOS 16.0+

Album.LibrarySortProperties

typealias · iOS 16.0+

AlbumFilter

protocol · iOS 15.0+

AnyMusicProperty

class · iOS 15.0+

ApplicationMusicPlayer

class · iOS 15.0+

ApplicationMusicPlayer.Queue

class · iOS 15.0+

ApplicationMusicPlayer.Queue.Entries

struct · iOS 15.0+

ApplicationMusicPlayer.Queue.Entries.ArrayLiteralElement

typealias · iOS 15.0+

ApplicationMusicPlayer.Queue.Entries.Element

typealias · iOS 15.0+

ApplicationMusicPlayer.Queue.Entries.Index

typealias · iOS 15.0+

ApplicationMusicPlayer.Queue.Entries.Indices

typealias · iOS 15.0+

ApplicationMusicPlayer.Queue.Entries.Iterator

typealias · iOS 15.0+

ApplicationMusicPlayer.Queue.Entries.SubSequence

typealias · iOS 15.0+

Artist

struct · iOS 15.0+

Artist.FilterType

typealias · iOS 15.0+

Artist.ID

typealias · iOS 15.0+

Artist.LibraryFilter

typealias · iOS 16.0+

Artist.LibrarySortProperties

typealias · iOS 16.0+

ArtistFilter

protocol · iOS 15.0+

Artwork

struct · iOS 15.0+

AudioVariant

enum · iOS 16.0+

AudioVariant.AllCases

typealias · iOS 16.0+

ContentRating

enum · iOS 15.0+

Curator

struct · iOS 15.4+

Curator.FilterType

typealias · iOS 15.4+

Curator.ID

typealias · iOS 15.4+

Curator.Kind

enum · iOS 15.4+

CuratorFilter

protocol · iOS 15.4+

DefaultMusicTokenProvider

class · iOS 15.0+

EditorialNotes

struct · iOS 15.0+

FilterableMusicItem

protocol · iOS 15.0+

Genre

struct · iOS 15.0+

Genre.FilterType

typealias · iOS 15.0+

Genre.ID

typealias · iOS 15.0+

Genre.LibraryFilter

typealias · iOS 16.0+

Genre.LibrarySortProperties

typealias · iOS 16.0+

GenreFilter

protocol · iOS 15.0+

LibraryAlbumFilter

protocol · iOS 16.0+

LibraryAlbumSortProperties

protocol · iOS 16.0+

LibraryArtistFilter

protocol · iOS 16.0+

LibraryArtistSortProperties

protocol · iOS 16.0+

LibraryGenreFilter

protocol · iOS 16.0+

LibraryGenreSortProperties

protocol · iOS 16.0+

LibraryMusicVideoFilter

protocol · iOS 16.0+

LibraryMusicVideoSortProperties

protocol · iOS 16.0+

LibraryPlaylistEntryFilter

protocol · iOS 16.0+

LibraryPlaylistEntrySortProperties

protocol · iOS 16.0+

LibraryPlaylistFilter

protocol · iOS 16.0+

LibraryPlaylistSortProperties

protocol · iOS 16.0+

LibrarySongFilter

protocol · iOS 16.0+

LibrarySongSortProperties

protocol · iOS 16.0+

LibraryTrackFilter

protocol · iOS 16.0+

LibraryTrackSortProperties

protocol · iOS 16.0+

MusicAttributeProperty

class · iOS 15.0+

MusicAuthorization

struct · iOS 15.0+

MusicAuthorization.Status

enum · iOS 15.0+

MusicAuthorization.Status.RawValue

typealias · iOS 15.0+

MusicCatalogChart

struct · iOS 16.0+

MusicCatalogChart.ID

typealias · iOS 16.0+

MusicCatalogChartKind

enum · iOS 16.0+

MusicCatalogChartKind.AllCases

typealias · iOS 16.0+

MusicCatalogChartRequestable

protocol · iOS 16.0+

MusicCatalogChartsRequest

struct · iOS 16.0+

MusicCatalogChartsResponse

struct · iOS 16.0+

MusicCatalogResourceRequest

struct · iOS 15.0+

MusicCatalogResourceRequestOption

struct · iOS 26.4+

MusicCatalogResourceResponse

struct · iOS 15.0+

MusicCatalogSearchable

protocol · iOS 15.0+

MusicCatalogSearchRequest

struct · iOS 15.0+

MusicCatalogSearchResponse

struct · iOS 15.0+

MusicCatalogSearchResponse.TopResult

enum · iOS 16.0+

MusicCatalogSearchResponse.TopResult.ID

typealias · iOS 16.0+

MusicCatalogSearchSuggestionsRequest

struct · iOS 16.0+

MusicCatalogSearchSuggestionsResponse

struct · iOS 16.0+

MusicCatalogSearchSuggestionsResponse.Suggestion

struct · iOS 16.0+

MusicCatalogSearchSuggestionsResponse.Suggestion.ID

typealias · iOS 16.0+

MusicCatalogSearchSuggestionsResponse.TopResult

typealias · iOS 16.0+

MusicCatalogTopLevelResourceRequesting

protocol · iOS 16.0+

MusicDataRequest

struct · iOS 15.0+

MusicDataRequest.Error

struct · iOS 15.0+

MusicDataRequest.Error.Source

enum · iOS 15.0+

MusicDataResponse

struct · iOS 15.0+

MusicDeveloperTokenProvider

protocol · iOS 15.0+

MusicExtendedAttributeProperty

class · iOS 15.0+

MusicItem

protocol · iOS 15.0+

MusicItemCollection

struct · iOS 15.0+

MusicItemCollection.ArrayLiteralElement

typealias · iOS 15.0+

MusicItemCollection.Element

typealias · iOS 15.0+

MusicItemCollection.Index

typealias · iOS 15.0+

MusicItemCollection.Indices

typealias · iOS 15.0+

MusicItemCollection.Iterator

typealias · iOS 15.0+

MusicItemCollection.SubSequence

typealias · iOS 15.0+

MusicItemID

struct · iOS 15.0+

MusicItemID.ExtendedGraphemeClusterLiteralType

typealias · iOS 15.0+

MusicItemID.RawValue

typealias · iOS 15.0+

MusicItemID.StringLiteralType

typealias · iOS 15.0+

MusicItemID.UnicodeScalarLiteralType

typealias · iOS 15.0+

MusicLibrary

class · iOS 16.0+

MusicLibrary.Error

enum · iOS 16.1+

MusicLibrary.Error.RawValue

typealias · iOS 16.1+

MusicLibraryAddable

protocol · iOS 16.0+

MusicLibraryRequest

struct · iOS 16.0+

MusicLibraryRequestable

protocol · iOS 16.0+

MusicLibraryRequestFilterValueEquatable

protocol · iOS 16.0+

MusicLibraryRequestFilterValueMembershipComparable

protocol · iOS 16.0+

MusicLibraryResponse

struct · iOS 16.0+

MusicLibrarySearchable

protocol · iOS 16.0+

MusicLibrarySearchRequest

struct · iOS 16.0+

MusicLibrarySearchResponse

struct · iOS 16.0+

MusicLibrarySearchResponse.TopResult

enum · iOS 16.0+

MusicLibrarySearchResponse.TopResult.ID

typealias · iOS 16.0+

MusicLibrarySection

struct · iOS 16.0+

MusicLibrarySection.ID

typealias · iOS 16.0+

MusicLibrarySectionedRequest

struct · iOS 16.0+

MusicLibrarySectionedResponse

struct · iOS 16.0+

MusicLibrarySectionRequestable

protocol · iOS 16.0+

MusicPersonalRecommendation

struct · iOS 16.0+

MusicPersonalRecommendation.ID

typealias · iOS 16.0+

MusicPersonalRecommendation.Item

enum · iOS 16.0+

MusicPersonalRecommendation.Item.ID

typealias · iOS 16.0+

MusicPersonalRecommendationItem

protocol · iOS 16.0+

MusicPersonalRecommendationsRequest

struct · iOS 16.0+

MusicPersonalRecommendationsResponse

struct · iOS 16.0+

MusicPlayer

class · iOS 15.0+

MusicPlayer.PlaybackStatus

enum · iOS 15.0+

MusicPlayer.Queue

class · iOS 15.0+

MusicPlayer.Queue.ArrayLiteralElement

typealias · iOS 15.0+

MusicPlayer.Queue.Entry

struct · iOS 15.0+

MusicPlayer.Queue.Entry.ID

typealias · iOS 15.0+

MusicPlayer.Queue.Entry.Item

enum · iOS 15.0+

MusicPlayer.Queue.Entry.Item.ID

typealias · iOS 15.0+

MusicPlayer.Queue.EntryInsertionPosition

enum · iOS 15.0+

MusicPlayer.Queue.ObjectWillChangePublisher

typealias · iOS 15.0+

MusicPlayer.RepeatMode

enum · iOS 15.0+

MusicPlayer.ShuffleMode

enum · iOS 15.0+

MusicPlayer.State

class · iOS 15.0+

MusicPlayer.State.ObjectWillChangePublisher

typealias · iOS 15.0+

MusicPlayer.Transition

enum · iOS 18.0+

MusicPlayer.Transition.CrossfadeOptions

struct · iOS 18.0+

MusicPlaylistAddable

protocol · iOS 16.0+

MusicPropertyContainer

protocol · iOS 15.0+

MusicPropertySource

enum · iOS 16.0+

MusicPropertySource.AllCases

typealias · iOS 16.0+

MusicRecentlyPlayedContainerRequest

typealias · iOS 16.0+

MusicRecentlyPlayedContainerResponse

typealias · iOS 16.0+

MusicRecentlyPlayedRequest

struct · iOS 16.0+

MusicRecentlyPlayedRequestable

protocol · iOS 16.0+

MusicRecentlyPlayedResponse

struct · iOS 16.0+

MusicRelationshipProperty

class · iOS 15.0+

MusicSubscription

struct · iOS 15.0+

MusicSubscription.Error

enum · iOS 15.0+

MusicSubscription.Error.RawValue

typealias · iOS 15.0+

MusicSubscription.Updates

struct · iOS 15.0+

MusicSubscription.Updates.AsyncIterator

typealias · iOS 15.0+

MusicSubscription.Updates.Element

typealias · iOS 15.0+

MusicSubscription.Updates.Iterator

struct · iOS 15.0+

MusicSubscription.Updates.Iterator.Element

typealias · iOS 15.0+

MusicTokenProvider

typealias · iOS 15.0+

MusicTokenRequestError

enum · iOS 15.0+

MusicTokenRequestError.RawValue

typealias · iOS 15.0+

MusicTokenRequestOptions

struct · iOS 15.0+

MusicTokenRequestOptions.ArrayLiteralElement

typealias · iOS 15.0+

MusicTokenRequestOptions.Element

typealias · iOS 15.0+

MusicTokenRequestOptions.RawValue

typealias · iOS 15.0+

MusicUserTokenProvider

class · iOS 15.0+

MusicVideo

struct · iOS 15.0+

MusicVideo.FilterType

typealias · iOS 15.0+

MusicVideo.ID

typealias · iOS 15.0+

MusicVideo.LibraryFilter

typealias · iOS 16.0+

MusicVideo.LibrarySortProperties

typealias · iOS 16.0+

MusicVideoFilter

protocol · iOS 15.0+

PartialMusicAsyncProperty

class · iOS 15.0+

PartialMusicProperty

class · iOS 15.0+

PlayableMusicItem

protocol · iOS 15.0+

Playlist

struct · iOS 15.0+

Playlist.Entry

struct · iOS 16.0+

Playlist.Entry.ID

typealias · iOS 16.0+

Playlist.Entry.Item

enum · iOS 16.0+

Playlist.Entry.Item.ID

typealias · iOS 16.0+

Playlist.Entry.LibraryFilter

typealias · iOS 16.0+

Playlist.Entry.LibrarySortProperties

typealias · iOS 16.0+

Playlist.FilterType

typealias · iOS 15.0+

Playlist.ID

typealias · iOS 15.0+

Playlist.Kind

enum · iOS 15.0+

Playlist.LibraryFilter

typealias · iOS 16.0+

Playlist.LibrarySortProperties

typealias · iOS 16.0+

PlaylistFilter

protocol · iOS 15.0+

PlayParameters

struct · iOS 15.0+

PreviewAsset

struct · iOS 15.0+

RadioShow

struct · iOS 15.4+

RadioShow.FilterType

typealias · iOS 15.4+

RadioShow.ID

typealias · iOS 15.4+

RadioShowFilter

protocol · iOS 15.4+

RecentlyPlayedMusicItem

enum · iOS 16.0+

RecentlyPlayedMusicItem.ID

typealias · iOS 16.0+

RecordLabel

struct · iOS 15.0+

RecordLabel.FilterType

typealias · iOS 15.0+

RecordLabel.ID

typealias · iOS 15.0+

RecordLabelFilter

protocol · iOS 15.0+

Song

struct · iOS 15.0+

Song.FilterType

typealias · iOS 15.0+

Song.ID

typealias · iOS 15.0+

Song.LibraryFilter

typealias · iOS 16.0+

Song.LibrarySortProperties

typealias · iOS 16.0+

SongFilter

protocol · iOS 15.0+

Station

struct · iOS 15.0+

Station.FilterType

typealias · iOS 15.0+

Station.ID

typealias · iOS 15.0+

StationFilter

protocol · iOS 15.0+

SystemMusicPlayer

class · iOS 15.0+

TitledSection

struct · iOS 16.0+

TitledSection.ID

typealias · iOS 16.0+

Track

enum · iOS 15.0+

Track.ID

typealias · iOS 15.0+

Track.LibraryFilter

typealias · iOS 16.0+

Track.LibrarySortProperties

typealias · iOS 16.0+

Functions and constants

get · iOS 15.0+

moreInGenre

TypeScript
static get moreInGenre(): MusicRelationshipProperty<MusicVideo, MusicVideo>
Swift declaration
static let moreInGenre: MusicRelationshipProperty<MusicVideo, MusicVideo>

A identifier of the association property that returns a collection of music videos in the same genre as this music video.

get · iOS 15.0+

moreByArtist

TypeScript
static get moreByArtist(): MusicRelationshipProperty<MusicVideo, MusicVideo>
Swift declaration
static let moreByArtist: MusicRelationshipProperty<MusicVideo, MusicVideo>

An identifier of the association property that returns a collection of additional music videos by the artist.

get · iOS 15.0+

songs

TypeScript
static get songs(): MusicRelationshipProperty<MusicVideo, Song>
Swift declaration
static let songs: MusicRelationshipProperty<MusicVideo, Song>

An identifier of the relationship property that returns the associated songs for the music video.

get · iOS 15.0+

albums

TypeScript
static get albums(): MusicRelationshipProperty<MusicVideo, Album>
Swift declaration
static let albums: MusicRelationshipProperty<MusicVideo, Album>

An identifier of the relationship property that returns the associated albums for the music video.

get · iOS 15.0+

genres

TypeScript
static get genres(): MusicRelationshipProperty<MusicVideo, Genre>
Swift declaration
static let genres: MusicRelationshipProperty<MusicVideo, Genre>

An identifier of the relationship property that returns the associated genres for the music video.

get · iOS 15.0+

artists

TypeScript
static get artists(): MusicRelationshipProperty<MusicVideo, Artist>
Swift declaration
static let artists: MusicRelationshipProperty<MusicVideo, Artist>

An identifier of the relationship property that returns the associated artists for the music video.

get · iOS 15.0+

artistURL

TypeScript
static get artistURL(): MusicExtendedAttributeProperty<MusicVideo, string>
Swift declaration
static var artistURL: MusicExtendedAttributeProperty<MusicVideo, URL> { get }

An identifier for the extended attribute property that returns the artist’s URL.

get · iOS 15.0+

topReleases

TypeScript
static get topReleases(): MusicRelationshipProperty<RecordLabel, Album>
Swift declaration
static var topReleases: MusicRelationshipProperty<RecordLabel, Album> { get }

An identifier for the association property that returns a collection of top releases for the record label.

get · iOS 15.0+

latestReleases

TypeScript
static get latestReleases(): MusicRelationshipProperty<RecordLabel, Album>
Swift declaration
static var latestReleases: MusicRelationshipProperty<RecordLabel, Album> { get }

An identifier for the association property that returns a collection of the most recent releases for the record label.

get · iOS 15.0+

musicVideos

TypeScript
static get musicVideos(): MusicRelationshipProperty<Song, MusicVideo>
Swift declaration
static let musicVideos: MusicRelationshipProperty<Song, MusicVideo>

An identifier for the relationship property that returns the song’s associated music videos.

get · iOS 16.0+

audioVariants

TypeScript
static get audioVariants(): MusicExtendedAttributeProperty<Song, Array<AudioVariant>>
Swift declaration
static let audioVariants: MusicExtendedAttributeProperty<Song, [AudioVariant]>

An identifier for the extended attribute property that returns the audio variants for the song.

get · iOS 15.0+

albums

TypeScript
static get albums21855(): MusicRelationshipProperty<Song, Album>
Swift declaration
static let albums: MusicRelationshipProperty<Song, Album>

An identifier for the relationship property that returns the associated albums for the song.

get · iOS 15.0+

genres

TypeScript
static get genres24911(): MusicRelationshipProperty<Song, Genre>
Swift declaration
static let genres: MusicRelationshipProperty<Song, Genre>

An identifier for the relationship property that returns the associated genres for the song.

get · iOS 15.0+

artists

TypeScript
static get artists81815(): MusicRelationshipProperty<Song, Artist>
Swift declaration
static let artists: MusicRelationshipProperty<Song, Artist>

An identifier for the relationship property that returns the associated artists for the song.

get · iOS 15.0+

station

TypeScript
static get station(): MusicRelationshipProperty<Song, Station>
Swift declaration
static let station: MusicRelationshipProperty<Song, Station>

An identifier for the relationship property that returns the associated station for the song.

get · iOS 15.0+

artistURL

TypeScript
static get artistURL46360(): MusicExtendedAttributeProperty<Song, string>
Swift declaration
static var artistURL: MusicExtendedAttributeProperty<Song, URL> { get }

An identifier for the extended attribute property that returns the artist’s URL.

get · iOS 15.0+

composers

TypeScript
static get composers(): MusicRelationshipProperty<Song, Artist>
Swift declaration
static let composers: MusicRelationshipProperty<Song, Artist>

An identifier for the relationship property that returns the song’s composers.

get · iOS 15.0+

recordLabels

TypeScript
static get recordLabels(): MusicRelationshipProperty<Album, RecordLabel>
Swift declaration
static let recordLabels: MusicRelationshipProperty<Album, RecordLabel>

An identifier for the relationship property that returns the record labels for the album.

get · iOS 16.0+

audioVariants

TypeScript
static get audioVariants78766(): MusicExtendedAttributeProperty<Album, Array<AudioVariant>>
Swift declaration
static let audioVariants: MusicExtendedAttributeProperty<Album, [AudioVariant]>

An identifier for the extended attribute property that returns the audio variants for the album.

get · iOS 15.0+

otherVersions

TypeScript
static get otherVersions(): MusicRelationshipProperty<Album, Album>
Swift declaration
static let otherVersions: MusicRelationshipProperty<Album, Album>

An identifier for the association property that returns a collection of other versions of the album.

get · iOS 15.0+

relatedAlbums

TypeScript
static get relatedAlbums(): MusicRelationshipProperty<Album, Album>
Swift declaration
static let relatedAlbums: MusicRelationshipProperty<Album, Album>

An identifier for the association property that returns a collection of related albums.

get · iOS 15.0+

relatedVideos

TypeScript
static get relatedVideos(): MusicRelationshipProperty<Album, MusicVideo>
Swift declaration
static let relatedVideos: MusicRelationshipProperty<Album, MusicVideo>

An identifier for the association property that returns a collection of related music videos for the album.

get · iOS 15.0+

genres

TypeScript
static get genres44382(): MusicRelationshipProperty<Album, Genre>
Swift declaration
static let genres: MusicRelationshipProperty<Album, Genre>

An identifier for the relationship property that returns the genres for the album.

get · iOS 15.0+

tracks

TypeScript
static get tracks(): MusicRelationshipProperty<Album, Track>
Swift declaration
static let tracks: MusicRelationshipProperty<Album, Track>

An identifier for the relationship property that returns the tracks on the album.

get · iOS 15.0+

artists

TypeScript
static get artists87718(): MusicRelationshipProperty<Album, Artist>
Swift declaration
static let artists: MusicRelationshipProperty<Album, Artist>

An identifier for the relationship property that returns the associated artists for the album.

get · iOS 15.0+

appearsOn

TypeScript
static get appearsOn(): MusicRelationshipProperty<Album, Playlist>
Swift declaration
static let appearsOn: MusicRelationshipProperty<Album, Playlist>

An identifier for the association property that returns a collection of playlists that include tracks from the album.

get · iOS 15.0+

artistURL

TypeScript
static get artistURL54785(): MusicExtendedAttributeProperty<Album, string>
Swift declaration
static var artistURL: MusicExtendedAttributeProperty<Album, URL> { get }

An identifier for the extended attribute property that returns the artist’s URL.

get · iOS 15.0+

topMusicVideos

TypeScript
static get topMusicVideos(): MusicRelationshipProperty<Artist, MusicVideo>
Swift declaration
static let topMusicVideos: MusicRelationshipProperty<Artist, MusicVideo>

An identifier for the association property that returns a collection of the artist’s top music videos.

get · iOS 15.0+

fullAlbums

TypeScript
static get fullAlbums(): MusicRelationshipProperty<Artist, Album>
Swift declaration
static let fullAlbums: MusicRelationshipProperty<Artist, Album>

An identifier for the association property that returns a collection of the artist’s full-release albums.

get · iOS 15.0+

liveAlbums

TypeScript
static get liveAlbums(): MusicRelationshipProperty<Artist, Album>
Swift declaration
static let liveAlbums: MusicRelationshipProperty<Artist, Album>

An identifier for the association property that returns a collection of the artist’s live albums.

get · iOS 15.0+

musicVideos

TypeScript
static get musicVideos97853(): MusicRelationshipProperty<Artist, MusicVideo>
Swift declaration
static let musicVideos: MusicRelationshipProperty<Artist, MusicVideo>

An identifier for the relationship property that returns the associated music videos for the artist.

get · iOS 15.0+

latestRelease

TypeScript
static get latestRelease(): MusicRelationshipProperty<Artist, Album>
Swift declaration
static let latestRelease: MusicRelationshipProperty<Artist, Album>

An identifier for the association property that returns the artist’s most recent album.

get · iOS 15.0+

featuredAlbums

TypeScript
static get featuredAlbums(): MusicRelationshipProperty<Artist, Album>
Swift declaration
static let featuredAlbums: MusicRelationshipProperty<Artist, Album>

An identifier for the association property that returns a collection of featured albums for the artist.

get · iOS 15.0+

similarArtists

TypeScript
static get similarArtists(): MusicRelationshipProperty<Artist, Artist>
Swift declaration
static let similarArtists: MusicRelationshipProperty<Artist, Artist>

An identifier for the association property that returns a collection of artists similar to this artist.

get · iOS 15.0+

appearsOnAlbums

TypeScript
static get appearsOnAlbums(): MusicRelationshipProperty<Artist, Album>
Swift declaration
static let appearsOnAlbums: MusicRelationshipProperty<Artist, Album>

An identifier for the association property that returns a collection of albums from other artists that this artist appears on.

get · iOS 15.0+

compilationAlbums

TypeScript
static get compilationAlbums(): MusicRelationshipProperty<Artist, Album>
Swift declaration
static let compilationAlbums: MusicRelationshipProperty<Artist, Album>

An identifier for the association property that returns a collection of compilation albums that include tracks by the artist.

get · iOS 15.0+

featuredPlaylists

TypeScript
static get featuredPlaylists(): MusicRelationshipProperty<Artist, Playlist>
Swift declaration
static let featuredPlaylists: MusicRelationshipProperty<Artist, Playlist>

An identifier for the association property that returns a collection of the artist’s playlists.

get · iOS 15.0+

albums

TypeScript
static get albums25743(): MusicRelationshipProperty<Artist, Album>
Swift declaration
static let albums: MusicRelationshipProperty<Artist, Album>

An identifier for the relationship property that returns the associated albums for the artist.

get · iOS 15.0+

genres

TypeScript
static get genres2815(): MusicRelationshipProperty<Artist, Genre>
Swift declaration
static let genres: MusicRelationshipProperty<Artist, Genre>

An identifier for the relationship property that returns the associated genres for the artist.

get · iOS 15.0+

singles

TypeScript
static get singles(): MusicRelationshipProperty<Artist, Album>
Swift declaration
static let singles: MusicRelationshipProperty<Artist, Album>

An identifier of the association property that returns a collection of the artist’s albums in the _singles_ category.

get · iOS 15.0+

station

TypeScript
static get station25427(): MusicRelationshipProperty<Artist, Station>
Swift declaration
static let station: MusicRelationshipProperty<Artist, Station>

An identifier for the relationship property that returns the associated station for the artist.

get · iOS 15.0+

topSongs

TypeScript
static get topSongs(): MusicRelationshipProperty<Artist, Song>
Swift declaration
static let topSongs: MusicRelationshipProperty<Artist, Song>

An identifier for the association property that returns a collection of the artist’s top songs.

get · iOS 15.0+

playlists

TypeScript
static get playlists(): MusicRelationshipProperty<Artist, Playlist>
Swift declaration
static let playlists: MusicRelationshipProperty<Artist, Playlist>

An identifier for the relationship property that returns the associated playlists for the artist.

get · iOS 15.4+

playlists

TypeScript
static get playlists77177(): MusicRelationshipProperty<Curator, Playlist>
Swift declaration
static let playlists: MusicRelationshipProperty<Curator, Playlist>

An identifier for the relationship property that returns the associated playlists for the curator.

get · iOS 15.0+

moreByCurator

TypeScript
static get moreByCurator(): MusicRelationshipProperty<Playlist, Playlist>
Swift declaration
static let moreByCurator: MusicRelationshipProperty<Playlist, Playlist>

An identifier for the association property that returns a collection of additional playlists by the same curator.

get · iOS 15.0+

featuredArtists

TypeScript
static get featuredArtists(): MusicRelationshipProperty<Playlist, Artist>
Swift declaration
static let featuredArtists: MusicRelationshipProperty<Playlist, Artist>

An identifier for the association property that returns a collection of featured artists for this playlist.

get · iOS 15.0+

tracks

TypeScript
static get tracks46457(): MusicRelationshipProperty<Playlist, Track>
Swift declaration
static let tracks: MusicRelationshipProperty<Playlist, Track>

An identifier for the relationship property that returns the tracks in the playlist.

get · iOS 16.0+

curator

TypeScript
static get curator(): MusicRelationshipProperty<Playlist, Curator>
Swift declaration
static let curator: MusicRelationshipProperty<Playlist, Curator>

An identifier for the extended attribute property that returns the playlist’s associated curator.

get · iOS 16.0+

entries

TypeScript
static get entries(): MusicRelationshipProperty<Playlist, Playlist_Entry>
Swift declaration
static let entries: MusicRelationshipProperty<Playlist, Playlist.Entry>

An identifier for the relationship property that returns the entries in the playlist.

get · iOS 16.0+

radioShow

TypeScript
static get radioShow(): MusicRelationshipProperty<Playlist, RadioShow>
Swift declaration
static let radioShow: MusicRelationshipProperty<Playlist, RadioShow>

An identifier for the extended attribute property that returns the playlist’s associated radio show.

get · iOS 15.4+

playlists

TypeScript
static get playlists53095(): MusicRelationshipProperty<RadioShow, Playlist>
Swift declaration
static let playlists: MusicRelationshipProperty<RadioShow, Playlist>

An identifier for the relationship property that returns the associated playlists for the radio show.

get · iOS 16.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 16.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 16.0+

id

TypeScript
get id(): string
Swift declaration
let id: String

The unique identifier for the catalog chart.

get · iOS 16.0+

kind

TypeScript
get kind(): MusicCatalogChartKind
Swift declaration
let kind: MusicCatalogChartKind

The kind of catalog chart.

get · iOS 16.0+

items

TypeScript
get items(): MusicItemCollection<SDKHandle>
Swift declaration
let items: MusicItemCollection<MusicItemType>

The items for the catalog chart.

get · iOS 16.0+

title

TypeScript
get title(): string
Swift declaration
let title: String

The title for the catalog chart.

get · iOS 15.0+

startIndex

TypeScript
get startIndex(): SDKHandle
Swift declaration
var startIndex: MusicItemCollection<MusicItemType>.Index { get }

The position of the first element in a nonempty collection. If the collection is empty, `startIndex` is equal to `endIndex`.

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+

hasNextBatch

TypeScript
get hasNextBatch(): boolean
Swift declaration
var hasNextBatch: Bool { get }

A Boolean value that indicates whether the collection has information that allows it to fetch a subsequent batch of items.

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.

method · iOS 15.0+

index

TypeScript
indexAfter(i: SDKHandle): SDKHandle
Swift declaration
func index(after i: MusicItemCollection<MusicItemType>.Index) -> MusicItemCollection<MusicItemType>.Index

Returns the position immediately after the given index. The successor of an index must be well defined. For an index `i` into a collection `c`, calling `c.index(after: i)` returns the same index every time. - Parameter i: A valid index of the collection. `i` must be less than `endIndex`. - Returns: The index value immediately after `i`.

method · iOS 15.0+

index

TypeScript
indexBefore(i: SDKHandle): SDKHandle
Swift declaration
func index(before i: MusicItemCollection<MusicItemType>.Index) -> MusicItemCollection<MusicItemType>.Index

Returns the position immediately before the given index. - Parameter i: A valid index of the collection. `i` must be greater than `startIndex`. - Returns: The index value immediately before `i`.

method · iOS 15.0+

index

TypeScript
indexOffsetByLimitedBy(i: SDKHandle, distance: number, limit: SDKHandle): (SDKHandle) | null
Swift declaration
func index(_ i: MusicItemCollection<MusicItemType>.Index, offsetBy distance: Int, limitedBy limit: MusicItemCollection<MusicItemType>.Index) -> MusicItemCollection<MusicItemType>.Index?

Returns an index that is the specified distance from the given index, unless that distance is beyond a given limiting index. The following example obtains an index advanced four positions from a string's starting index and then prints the character at that position. The operation doesn't require going beyond the limiting `s.endIndex` value, so it succeeds. let s = "Swift" if let i = s.index(s.startIndex, offsetBy: 4, limitedBy: s.endIndex) { print(s[i]) } // Prints "t" The next example attempts to retrieve an index six positions from `s.startIndex` but fails, because that distance is beyond the index passed as `limit`. let j = s.index(s.startIndex, offsetBy: 6, limitedBy: s.endIndex) print(j) // Prints "nil" The value passed as `distance` must not offset `i` beyond the bounds of the collection, unless the index passed as `limit` prevents offsetting beyond those bounds. - Parameters: - i: A valid index of the collection. - distance: The distance to offset `i`. `distance` must not be negative unless the collection conforms to the `BidirectionalCollection` protocol. - limit: A valid index of the collection to use as a limit. If `distance > 0`, a limit that is less than `i` has no effect. Likewise, if `distance < 0`, a limit that is greater than `i` has no effect. - Returns: An index offset by `distance` from the index `i`, unless that index would be beyond `limit` in the direction of movement. In that case, the method returns `nil`. - Complexity: O(1)

method · iOS 15.0+

index

TypeScript
indexOffsetBy(i: SDKHandle, distance: number): SDKHandle
Swift declaration
func index(_ i: MusicItemCollection<MusicItemType>.Index, offsetBy distance: Int) -> MusicItemCollection<MusicItemType>.Index

Returns an index that is the specified distance from the given index. The following example obtains an index advanced four positions from a string's starting index and then prints the character at that position. let s = "Swift" let i = s.index(s.startIndex, offsetBy: 4) print(s[i]) // Prints "t" The value passed as `distance` must not offset `i` beyond the bounds of the collection. - Parameters: - i: A valid index of the collection. - distance: The distance to offset `i`. `distance` must not be negative unless the collection conforms to the `BidirectionalCollection` protocol. - Returns: An index offset by `distance` from the index `i`. If `distance` is positive, this is the same value as the result of `distance` calls to `index(after:)`. If `distance` is negative, this is the same value as the result of `abs(distance)` calls to `index(before:)`. - Complexity: O(1)

get · iOS 15.0+

title

TypeScript
get title(): (string) | null
Swift declaration
var title: String? { get }

An optional title for the collection. Collections that represent an association from a music item often contain a title.

get · iOS 15.0+

indices

TypeScript
get indices(): SDKHandle
Swift declaration
var indices: MusicItemCollection<MusicItemType>.Indices { get }

The indices that are valid for subscripting the collection, in ascending order. A collection's `indices` property can hold a strong reference to the collection itself, causing the collection to be nonuniquely referenced. If you mutate the collection while iterating over its indices, a strong reference can result in an unexpected copy of the collection. To avoid the unexpected copy, use the `index(after:)` method starting with `startIndex` to produce indices instead. var c = MyFancyCollection([10, 20, 30, 40, 50]) var i = c.startIndex while i != c.endIndex { c[i] /= 5 i = c.index(after: i) } // c == MyFancyCollection([2, 4, 6, 8, 10])

method · iOS 15.0+

distance

TypeScript
distance(start: SDKHandle, end: SDKHandle): number
Swift declaration
func distance(from start: MusicItemCollection<MusicItemType>.Index, to end: MusicItemCollection<MusicItemType>.Index) -> Int

Returns the distance between two indices. Unless the collection conforms to the `BidirectionalCollection` protocol, `start` must be less than or equal to `end`. - Parameters: - start: A valid index of the collection. - end: Another valid index of the collection. If `end` is equal to `start`, the result is zero. - Returns: The distance between `start` and `end`. The result can be negative only if the collection conforms to the `BidirectionalCollection` protocol. - Complexity: O(1)

get · iOS 15.0+

endIndex

TypeScript
get endIndex(): SDKHandle
Swift declaration
var endIndex: MusicItemCollection<MusicItemType>.Index { get }

The collection's "past the end" position---that is, the position one greater than the last valid subscript argument. When you need a range that includes the last element of a collection, use the half-open range operator (`..<`) with `endIndex`. The `..<` operator creates a range that doesn't include the upper bound, so it's always safe to use with `endIndex`. For example: let numbers = [10, 20, 30, 40, 50] if let index = numbers.firstIndex(of: 30) { print(numbers[index ..< numbers.endIndex]) } // Prints "[30, 40, 50]" If the collection is empty, `endIndex` is equal to `startIndex`.

method · iOS 15.0+

formIndex

TypeScript
formIndexAfter(i: SDKHandle): { $ret: null; $out: { "i": SDKHandle } }
Swift declaration
func formIndex(after i: inout MusicItemCollection<MusicItemType>.Index)

Replaces the given index with its successor. - Parameter i: A valid index of the collection. `i` must be less than `endIndex`.

Omit the output parameters from the call. The result contains $ret and $out, with i inside $out.

method · iOS 15.0+

formIndex

TypeScript
formIndexBefore(i: SDKHandle): { $ret: null; $out: { "i": SDKHandle } }
Swift declaration
func formIndex(before i: inout MusicItemCollection<MusicItemType>.Index)

Replaces the given index with its predecessor. - Parameter i: A valid index of the collection. `i` must be greater than `startIndex`.

Omit the output parameters from the call. The result contains $ret and $out, with i inside $out.

method · iOS 15.0+

nextBatch

TypeScript
nextBatch(limit?: (number) | null): Promise<(MusicItemCollection<SDKHandle>) | null>
Swift declaration
func nextBatch(limit: Int? = nil) async throws -> MusicItemCollection<MusicItemType>?

Fetches the next batch of items asynchronously. This method returns the next batch of items as another collection of music items of the same type.

subscript · iOS 15.0+

subscript

TypeScript
subscript(bounds: SDKHandle): SDKHandle
Swift declaration
subscript(bounds: Range<MusicItemCollection<MusicItemType>.Index>) -> MusicItemCollection<MusicItemType>.SubSequence { get }

Accesses a contiguous subrange of the collection's elements. The accessed slice uses the same indices for the same elements as the original collection uses. Always use the slice's `startIndex` property instead of assuming that its indices start at a particular value. This example demonstrates getting a slice of an array of strings, finding the index of one of the strings in the slice, and then using that index in the original array. let streets = ["Adams", "Bryant", "Channing", "Douglas", "Evarts"] let streetsSlice = streets[2 ..< streets.endIndex] print(streetsSlice) // Prints "["Channing", "Douglas", "Evarts"]" let index = streetsSlice.firstIndex(of: "Evarts") // 4 print(streets[index!]) // Prints "Evarts" - Parameter bounds: A range of the collection's indices. The bounds of the range must be valid indices of the collection. - Complexity: O(1)

subscript · iOS 15.0+

subscript

TypeScript
subscript53869(position: SDKHandle): SDKHandle
Swift declaration
subscript(position: MusicItemCollection<MusicItemType>.Index) -> MusicItemCollection<MusicItemType>.Element { get }

Accesses the element at the specified position. The following example accesses an element of an array through its subscript to print its value: var streets = ["Adams", "Bryant", "Channing", "Douglas", "Evarts"] print(streets[1]) // Prints "Bryant" You can subscript a collection with any valid index other than the collection's end index. The end index refers to the position one past the last element of a collection, so it doesn't correspond with an element. - Parameter position: The position of the element to access. `position` must be a valid index of the collection that is not equal to the `endIndex` property. - Complexity: O(1)

get · iOS 16.0+

includeOnlyDownloadedContent

TypeScript
get includeOnlyDownloadedContent(): boolean
Swift declaration
var includeOnlyDownloadedContent: Bool

A Boolean value that indicates whether the library response should only include items downloaded on the user’s device.

set · iOS 16.0+

includeOnlyDownloadedContent

TypeScript
set includeOnlyDownloadedContent(value: boolean)
Swift declaration
var includeOnlyDownloadedContent: Bool

A Boolean value that indicates whether the library response should only include items downloaded on the user’s device.

get · iOS 16.0+

limit

TypeScript
get limit(): number
Swift declaration
var limit: Int

A limit for the number of items to return in the library response. A limit of 0 length means no limit.

set · iOS 16.0+

limit

TypeScript
set limit(value: number)
Swift declaration
var limit: Int

A limit for the number of items to return in the library response. A limit of 0 length means no limit.

method · iOS 16.0+

filter

TypeScript
filter(text: string): void
Swift declaration
mutating func filter(text: String)

Filters items by a specific string.

get · iOS 16.0+

offset

TypeScript
get offset(): number
Swift declaration
var offset: Int

An offset for the request.

set · iOS 16.0+

offset

TypeScript
set offset(value: number)
Swift declaration
var offset: Int

An offset for the request.

method · iOS 16.0+

response

TypeScript
response(): Promise<MusicLibraryResponse<SDKHandle>>
Swift declaration
func response() async throws -> MusicLibraryResponse<MusicItemType>

Fetches items from the user’s music library.

get · iOS 16.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 16.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 16.0+

id

TypeScript
get id(): MusicItemID
Swift declaration
var id: MusicItemID { get }

The stable identity of the entity associated with this instance.

get · iOS 16.0+

items

TypeScript
get items(): MusicItemCollection<SDKHandle>
Swift declaration
let items: MusicItemCollection<MusicItemType>

A collection of items that correspond to the children of the section.

get · iOS 16.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 16.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 16.0+

items

TypeScript
get items(): MusicItemCollection<SDKHandle>
Swift declaration
let items: MusicItemCollection<MusicItemType>

A collection of items that match the filters on the originating library request.

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+

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 16.0+

limit

TypeScript
get limit(): (number) | null
Swift declaration
var limit: Int?

A limit for the number of items to return in the response that contains items the user has recently played.

set · iOS 16.0+

limit

TypeScript
set limit(value: (number) | null)
Swift declaration
var limit: Int?

A limit for the number of items to return in the response that contains items the user has recently played.

get · iOS 16.0+

offset

TypeScript
get offset(): (number) | null
Swift declaration
var offset: Int?

An offset for the request.

set · iOS 16.0+

offset

TypeScript
set offset(value: (number) | null)
Swift declaration
var offset: Int?

An offset for the request.

method · iOS 16.0+

response

TypeScript
response(): Promise<MusicRecentlyPlayedResponse<SDKHandle>>
Swift declaration
func response() async throws -> MusicRecentlyPlayedResponse<MusicItemType>

Fetches items the user has recently played.

get · iOS 15.0+

properties

TypeScript
get properties(): Array<PartialMusicAsyncProperty<SDKHandle>>
Swift declaration
var properties: [PartialMusicAsyncProperty<MusicItemType>]

A list of properties which the resource request will fetch for each music item in the response.

set · iOS 15.0+

properties

TypeScript
set properties(value: Array<PartialMusicAsyncProperty<SDKHandle>>)
Swift declaration
var properties: [PartialMusicAsyncProperty<MusicItemType>]

A list of properties which the resource request will fetch for each music item in the response.

get · iOS 15.0+

limit

TypeScript
get limit(): (number) | null
Swift declaration
var limit: Int?

A limit for the number of items to return in the catalog resource response.

set · iOS 15.0+

limit

TypeScript
set limit(value: (number) | null)
Swift declaration
var limit: Int?

A limit for the number of items to return in the catalog resource response.

get · iOS 26.4+

options

TypeScript
get options(): Array<MusicCatalogResourceRequestOption>
Swift declaration
var options: [MusicCatalogResourceRequestOption]

Additional options to use for this request.

set · iOS 26.4+

options

TypeScript
set options(value: Array<MusicCatalogResourceRequestOption>)
Swift declaration
var options: [MusicCatalogResourceRequestOption]

Additional options to use for this request.

method · iOS 15.0+

response

TypeScript
response(): Promise<MusicCatalogResourceResponse<SDKHandle>>
Swift declaration
func response() async throws -> MusicCatalogResourceResponse<MusicItemType>

Fetches items from the Apple Music catalog that match a specific filter.

get · iOS 16.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 16.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 16.0+

items

TypeScript
get items(): MusicItemCollection<SDKHandle>
Swift declaration
let items: MusicItemCollection<MusicItemType>

A collection of items the user has recently played.

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+

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+

items

TypeScript
get items(): MusicItemCollection<SDKHandle>
Swift declaration
let items: MusicItemCollection<MusicItemType>

A collection of items matching the filter used in the originating ``MusicCatalogResourceRequest``.

method · iOS 16.0+

filterItems

TypeScript
filterItems(text: string): void
Swift declaration
mutating func filterItems(text: String)

Filters items by a specific string.

get · iOS 16.0+

includeOnlyDownloadedContent

TypeScript
get includeOnlyDownloadedContent(): boolean
Swift declaration
var includeOnlyDownloadedContent: Bool

A Boolean value that indicates whether the library response should only include items downloaded on the user’s device.

set · iOS 16.0+

includeOnlyDownloadedContent

TypeScript
set includeOnlyDownloadedContent(value: boolean)
Swift declaration
var includeOnlyDownloadedContent: Bool

A Boolean value that indicates whether the library response should only include items downloaded on the user’s device.

get · iOS 16.0+

limit

TypeScript
get limit(): number
Swift declaration
var limit: Int

A limit for the number of items to return in the library response. A limit of 0 length means no limit.

set · iOS 16.0+

limit

TypeScript
set limit(value: number)
Swift declaration
var limit: Int

A limit for the number of items to return in the library response. A limit of 0 length means no limit.

get · iOS 16.0+

offset

TypeScript
get offset(): number
Swift declaration
var offset: Int

An offset for the request.

set · iOS 16.0+

offset

TypeScript
set offset(value: number)
Swift declaration
var offset: Int

An offset for the request.

method · iOS 16.0+

response

TypeScript
response(): Promise<MusicLibrarySectionedResponse<SDKHandle, SDKHandle>>
Swift declaration
func response() async throws -> MusicLibrarySectionedResponse<SectionType, MusicItemType>

Fetches items grouped by sections from the user’s music library.

get · iOS 16.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 16.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 16.0+

sections

TypeScript
get sections(): Array<MusicLibrarySection<SDKHandle, SDKHandle>>
Swift declaration
let sections: [MusicLibrarySection<SectionType, MusicItemType>]

An array of sections that match the filters on the originating library request.

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.

Skipped declarations

97 declarations were excluded from these bindings. Each reason comes from the generator or the iOS SDK compiler.

MusicLibraryRequest.init()

The containing type needs Swift generic type arguments. (no canonical witness for MusicItemType)

MusicLibraryRequest.filter(matching:contains:)

This declaration needs Swift generic type arguments. (no canonical witness for MusicItemType.LibraryFilter)

MusicLibraryRequest.filter(matching:contains:)

This declaration needs Swift generic type arguments. (no canonical witness for MusicItemType.LibraryFilter)

MusicLibraryRequest.filter(matching:contains:)

This declaration needs Swift generic type arguments. (no canonical witness for MusicItemType.LibraryFilter)

MusicLibraryRequest.filter(matching:equalTo:)

This declaration needs Swift generic type arguments. (no canonical witness for MusicItemType.LibraryFilter)

MusicLibraryRequest.filter(matching:equalTo:)

This declaration needs Swift generic type arguments. (no canonical witness for MusicItemType.LibraryFilter)

MusicLibraryRequest.filter(matching:memberOf:)

This declaration needs Swift generic type arguments. (no canonical witness for MusicItemType.LibraryFilter)

MusicLibraryRequest.filter(matching:memberOf:)

This declaration needs Swift generic type arguments. (no canonical witness for MusicItemType.LibraryFilter)

MusicLibraryRequest.sort(by:ascending:)

This declaration needs Swift generic type arguments. (no canonical witness for MusicItemType.LibrarySortProperties)

MusicLibrarySection.subscript(dynamicMember:)

This declaration needs Swift generic type arguments. (no canonical witness for SectionType)

MusicLibrarySectionedRequest.init()

The containing type needs Swift generic type arguments. (no canonical witness for SectionType, MusicItemType)

MusicLibrarySectionedRequest.filterItems(matching:contains:)

This declaration needs Swift generic type arguments. (no canonical witness for MusicItemType.LibraryFilter)

MusicLibrarySectionedRequest.filterItems(matching:contains:)

This declaration needs Swift generic type arguments. (no canonical witness for MusicItemType.LibraryFilter)

MusicLibrarySectionedRequest.filterItems(matching:contains:)

This declaration needs Swift generic type arguments. (no canonical witness for MusicItemType.LibraryFilter)

MusicLibrarySectionedRequest.filterItems(matching:equalTo:)

This declaration needs Swift generic type arguments. (no canonical witness for MusicItemType.LibraryFilter)

MusicLibrarySectionedRequest.filterItems(matching:equalTo:)

This declaration needs Swift generic type arguments. (no canonical witness for MusicItemType.LibraryFilter)

MusicLibrarySectionedRequest.filterItems(matching:memberOf:)

This declaration needs Swift generic type arguments. (no canonical witness for MusicItemType.LibraryFilter)

MusicLibrarySectionedRequest.filterItems(matching:memberOf:)

This declaration needs Swift generic type arguments. (no canonical witness for MusicItemType.LibraryFilter)

MusicLibrarySectionedRequest.sortItems(by:ascending:)

This declaration needs Swift generic type arguments. (no canonical witness for MusicItemType.LibrarySortProperties)

MusicLibrarySectionedRequest.filterSections(matching:contains:)

This declaration needs Swift generic type arguments. (no canonical witness for SectionType.LibraryFilter)

MusicLibrarySectionedRequest.filterSections(matching:contains:)

This declaration needs Swift generic type arguments. (no canonical witness for SectionType.LibraryFilter)

MusicLibrarySectionedRequest.filterSections(matching:equalTo:)

This declaration needs Swift generic type arguments. (no canonical witness for SectionType.LibraryFilter)

MusicLibrarySectionedRequest.filterSections(matching:equalTo:)

This declaration needs Swift generic type arguments. (no canonical witness for SectionType.LibraryFilter)

MusicLibrarySectionedRequest.filterSections(matching:memberOf:)

This declaration needs Swift generic type arguments. (no canonical witness for SectionType.LibraryFilter)

MusicLibrarySectionedRequest.filterSections(matching:memberOf:)

This declaration needs Swift generic type arguments. (no canonical witness for SectionType.LibraryFilter)

MusicLibrarySectionedRequest.filterSections(text:)

The containing type needs Swift generic type arguments. (no canonical witness for SectionType, MusicItemType)

MusicLibrarySectionedRequest.sortSections(by:ascending:)

This declaration needs Swift generic type arguments. (no canonical witness for SectionType.LibrarySortProperties)

MusicLibrarySearchRequest.init(term:types:)

Passing a Swift type itself is not supported.

MusicLibrarySearchRequest.types

Passing a Swift type itself is not supported.

MusicLibrary.add(_:)

This declaration needs Swift generic type arguments. (no canonical witness for MusicItemType)