capacitor-plugin-musickit v0.0.81

capacitor-plugin-musickit

Requires iOS 16 or higher

Install

npm install capacitor-plugin-musickit
npx cap sync

API

• addListener('playbackStateDidChange', ...)
• addListener('nowPlayingItemDidChange', ...)
• addListener('authorizationStatusDidChange', ...)
• addRating(...)
• api(...)
• authorize()
• configure(...)
• deleteRating(...)
• echo(...)
• getCatalogAlbums(...)
• getCatalogArtists(...)
• getCurrentIndex()
• getCurrentPlaybackDuration()
• getCurrentPlaybackTime()
• getCurrentSong()
• getLibraryAlbums(...)
• getLibraryArtists(...)
• getLibraryPlaylists(...)
• getLibrarySongs(...)
• getQueueSongs()
• getRatings(...)
• getRepeatMode()
• getShuffleMode()
• hasMusicSubscription()
• isAuthorized()
• nextPlay()
• pause()
• play(...)
• previousPlay()
• seekToTime(...)
• setQueue(...)
• setRepeatMode(...)
• setShuffleMode(...)
• setSong(...)
• stop()
• unauthorize()
• Interfaces
• Type Aliases

addListener('playbackStateDidChange', ...)

addListener(eventName: "playbackStateDidChange", listenerFunc: PlaybackStateDidChangeListener) => Promise<PluginListenerHandle> & PluginListenerHandle

Returns: Promise<PluginListenerHandle> & PluginListenerHandle

addListener('nowPlayingItemDidChange', ...)

addListener(eventName: "nowPlayingItemDidChange", listenerFunc: NowPlayingItemDidChangeListener) => Promise<PluginListenerHandle> & PluginListenerHandle

Returns: Promise<PluginListenerHandle> & PluginListenerHandle

addListener('authorizationStatusDidChange', ...)

addListener(eventName: "authorizationStatusDidChange", listenerFunc: AuthorizationStatusDidChangeListener) => Promise<PluginListenerHandle> & PluginListenerHandle

Returns: Promise<PluginListenerHandle> & PluginListenerHandle

addRating(...)

addRating(options: AddRatingOptions) => Promise<void>

api(...)

api<T>(options: ApiOptions) => Promise<ApiResult<T>>

Returns: Promise<ApiResult<T>>

authorize()

authorize() => Promise<void>

configure(...)

configure(options: ConfigureOptions) => Promise<void>

deleteRating(...)

deleteRating(options: DeleteRatingOptions) => Promise<void>

echo(...)

echo(options: EchoOptions) => Promise<EchoResult>

Returns: Promise<EchoResult>

getCatalogAlbums(...)

getCatalogAlbums(options: GetCatalogAlbumsOptions) => Promise<GetCatalogAlbumsResult>

Returns: Promise<GetCatalogAlbumsResult>

getCatalogArtists(...)

getCatalogArtists(options: GetCatalogArtistsOptions) => Promise<GetCatalogArtistsResult>

Returns: Promise<GetCatalogArtistsResult>

getCurrentIndex()

getCurrentIndex() => Promise<GetCurrentIndexResult>

Returns: Promise<GetCurrentIndexResult>

getCurrentPlaybackDuration()

getCurrentPlaybackDuration() => Promise<GetCurrentPlaybackTimeResult>

Returns: Promise<GetCurrentPlaybackTimeResult>

getCurrentPlaybackTime()

getCurrentPlaybackTime() => Promise<GetCurrentPlaybackTimeResult>

Returns: Promise<GetCurrentPlaybackTimeResult>

getCurrentSong()

getCurrentSong() => Promise<GetCurrentSongResult>

Returns: Promise<GetCurrentSongResult>

getLibraryAlbums(...)

getLibraryAlbums(options: GetLibraryAlbumsOptions) => Promise<GetLibraryAlbumsResult>

Returns: Promise<GetLibraryAlbumsResult>

getLibraryArtists(...)

getLibraryArtists(options: GetLibraryArtistsOptions) => Promise<GetLibraryArtistsResult>

Returns: Promise<GetLibraryArtistsResult>

getLibraryPlaylists(...)

getLibraryPlaylists(options: GetLibraryPlaylistsOptions) => Promise<GetLibraryPlaylistsResult>

Returns: Promise<GetLibraryPlaylistsResult>

getLibrarySongs(...)

getLibrarySongs(options: GetLibrarySongsOptions) => Promise<GetLibrarySongsResult>

Returns: Promise<GetLibrarySongsResult>

getQueueSongs()

getQueueSongs() => Promise<GetQueueSongsResult>

Returns: Promise<GetQueueSongsResult>

getRatings(...)

getRatings(options: GetRatingsOptions) => Promise<RatingsResult>

Returns: Promise<RatingsResult>

getRepeatMode()

getRepeatMode() => Promise<GetRepeatModeResult>

Returns: Promise<GetRepeatModeResult>

getShuffleMode()

getShuffleMode() => Promise<GetShuffleModeResult>

Returns: Promise<GetShuffleModeResult>

hasMusicSubscription()

hasMusicSubscription() => Promise<ActionResult>

Returns: Promise<ActionResult>

isAuthorized()

isAuthorized() => Promise<ActionResult>

Returns: Promise<ActionResult>

nextPlay()

nextPlay() => Promise<void>

pause()

pause() => Promise<void>

play(...)

play(options: PlayOptions) => Promise<void>

previousPlay()

previousPlay() => Promise<void>

seekToTime(...)

seekToTime(options: SeekToTimeOptions) => Promise<void>

setQueue(...)

setQueue(options: SetQueueOptions) => Promise<void>

setRepeatMode(...)

setRepeatMode(options: SetRepeatModeOptions) => Promise<void>

setShuffleMode(...)

setShuffleMode(options: SetShuffleModeOptions) => Promise<void>

setSong(...)

setSong(options: SetSongOptions) => Promise<SetSongResult>

Returns: Promise<SetSongResult>

stop()

stop() => Promise<void>

unauthorize()

unauthorize() => Promise<void>

Interfaces

PluginListenerHandle

ConfigureOptions

EchoResult

EchoOptions

GetMultiDataOptions

GetCurrentIndexResult

GetCurrentPlaybackTimeResult

GetCurrentSongResult

GetQueueSongsResult

GetRepeatModeResult

GetShuffleModeResult

ActionResult

PlayOptions

SeekToTimeOptions

SetQueueOptions

SetRepeatModeOptions

SetShuffleModeOptions

SetSongResult

SetSongOptions

Type Aliases

PlaybackStateDidChangeListener

(data: PlaybackStateDidChangeResult): void

PlaybackStateDidChangeResult

{ state: PlaybackState; }

PlaybackState

keyof typeof MusicKit.PlaybackStates

NowPlayingItemDidChangeListener

(data: NowPlayingItemDidChangeResult): void

NowPlayingItemDidChangeResult

{ index: number; item: MusicKit.MediaItem; }

AuthorizationStatusDidChangeListener

(data: AuthorizationStatusDidChangeResult): void

AuthorizationStatusDidChangeResult

{ status: AuthorizationStatus; }

AuthorizationStatus

"unavailable" | "notDetermined" | "denied" | "restricted" | "authorized"

AddRatingOptions

{ id: string; type: MusicKit.AppleMusicAPI.RatingType; value: MusicKit.Rating; }

ApiResult

MusicKit.Relationship<T> | MusicKit.SearchRelationship

ApiOptions

{ options?: MusicKit.AppleMusicAPI.Options; params?: MusicKit.AppleMusicAPI.Params; url: string; }

DeleteRatingOptions

{ id: string; type: MusicKit.AppleMusicAPI.RatingType; }

GetCatalogAlbumsResult

MusicKit.Relationship<MusicKit.Albums>

GetCatalogAlbumsOptions

{ artistId?: string; libraryId?: string; musicVideoId?: string; songId?: string; } & GetMultiDataOptions

GetCatalogArtistsResult

MusicKit.Relationship<MusicKit.Artists>

GetCatalogArtistsOptions

{ albumId?: string; libraryId?: string; musicVideoId?: string; songId?: string; songIdForComposers?: string; } & GetMultiDataOptions

GetLibraryAlbumsResult

MusicKit.Relationship<MusicKit.LibraryAlbums>

GetLibraryAlbumsOptions

{ artistId?: string; catalogId?: string; musicVideoId?: string; songId?: string; } & GetMultiDataOptions

GetLibraryArtistsResult

MusicKit.Relationship<MusicKit.LibraryArtists>

GetLibraryArtistsOptions

{ albumId?: string; musicVideoId?: string; songId?: string; } & GetMultiDataOptions

GetLibraryPlaylistsResult

MusicKit.Relationship<MusicKit.LibraryPlaylists>

GetLibraryPlaylistsOptions

{ catalogId?: string; } & GetMultiDataOptions

GetLibrarySongsResult

MusicKit.Relationship<MusicKit.LibrarySongs>

GetLibrarySongsOptions

{ albumId?: string; catalogId?: string; playlistId?: string; } & GetMultiDataOptions

RatingsResult

MusicKit.Relationship<MusicKit.Ratings>

GetRatingsOptions

{ ids: string[]; type: MusicKit.AppleMusicAPI.RatingType; }

RepeatMode

"none" | "one" | "all"

ShuffleMode

"off" | "songs"