- canAppendToPlaybackQueue() - Method in interface com.apple.android.music.playback.controller.MediaPlayerController
-
A Boolean value that indicates whether it's possible to append items to the playback queue.
- canEditPlaybackQueue() - Method in interface com.apple.android.music.playback.controller.MediaPlayerController
-
A Boolean value that indicates whether it's possible to move or remove items from the playback queue.
- canPrependToPlaybackQueue() - Method in interface com.apple.android.music.playback.controller.MediaPlayerController
-
A Boolean value that indicates whether it's possible to prepend items to the playback queue.
- canSeek() - Method in interface com.apple.android.music.playback.controller.MediaPlayerController
-
A Boolean that indicates whether it's possible to seek to a position in the current playback item.
- canSetRadioLikeState() - Method in interface com.apple.android.music.playback.controller.MediaPlayerController
-
Gets whether it is currently possible to set the radio like state for the currently playing item.
- canSetRepeatMode() - Method in interface com.apple.android.music.playback.controller.MediaPlayerController
-
A Boolean value that indicates whether it's possible to change the active repeat mode.
- canSetShuffleMode() - Method in interface com.apple.android.music.playback.controller.MediaPlayerController
-
A Boolean value that indicates whether it's possible to change the active shuffle mode.
- canSkipToNextItem() - Method in interface com.apple.android.music.playback.controller.MediaPlayerController
-
A Boolean value that indicates whether it's possible to skip to the next item in the playback queue.
- canSkipToPreviousItem() - Method in interface com.apple.android.music.playback.controller.MediaPlayerController
-
A Boolean value that indicates whether it's possible to skip to the previous item in the playback queue.
- canSkipToQueueItem() - Method in interface com.apple.android.music.playback.controller.MediaPlayerController
-
A Boolean value that indicates whether it's possible to the skip to an item in the queue item list.
- CatalogPlaybackQueueItemProvider - Class in com.apple.android.music.playback.queue
-
An object that populates the playback queue with items from the Apple Music Catalog.
- CatalogPlaybackQueueItemProvider() - Constructor for class com.apple.android.music.playback.queue.CatalogPlaybackQueueItemProvider
-
- CatalogPlaybackQueueItemProvider.Builder - Class in com.apple.android.music.playback.queue
-
A constructor that defines the builder for a catalog playback queue item provider.
- com.apple.android.music.playback.controller - package com.apple.android.music.playback.controller
-
- com.apple.android.music.playback.model - package com.apple.android.music.playback.model
-
- com.apple.android.music.playback.queue - package com.apple.android.music.playback.queue
-
- com.apple.android.sdk.authentication - package com.apple.android.sdk.authentication
-
- containers(int, String...) - Method in class com.apple.android.music.playback.queue.CatalogPlaybackQueueItemProvider.Builder
-
Creates a playback queue populated by item containers with the specified IDs, which will be in the order of their containers, followed by the order of the IDs, unless a shuffle mode is set.
- createAuthenticationManager(Context) - Static method in class com.apple.android.sdk.authentication.AuthenticationFactory
-
Returns an AuthenticationManager instance which can be used either to start the authentication flow or to extract the music user token from the authentication result.
- createIntentBuilder(String) - Method in interface com.apple.android.sdk.authentication.AuthenticationManager
-
Creates an AuthIntentBuilder instance.
- createLocalController(Context, TokenProvider) - Static method in class com.apple.android.music.playback.controller.MediaPlayerControllerFactory
-
Creates a local playback controller where event callbacks are posted to the application's main thread.
- createLocalController(Context, Handler, TokenProvider) - Static method in class com.apple.android.music.playback.controller.MediaPlayerControllerFactory
-
Creates a local playback controller where event callbacks are posted to the specified thread.
- CREATOR - Static variable in class com.apple.android.music.playback.queue.CatalogPlaybackQueueItemProvider
-
The creator of the playback queue.
- getAlbumArtistName() - Method in interface com.apple.android.music.playback.model.PlayerMediaItem
-
Gets the album artist name for this item.
- getAlbumDiscCount() - Method in interface com.apple.android.music.playback.model.PlayerMediaItem
-
Gets the total number of discs on the item's album.
- getAlbumDiscNumber() - Method in interface com.apple.android.music.playback.model.PlayerMediaItem
-
Gets the disc number for this item, if it's part of an album.
- getAlbumSubscriptionStoreId() - Method in interface com.apple.android.music.playback.model.PlayerMediaItem
-
Gets the subscription store ID for the item's album, which is null if this item does
not belong to an album.
- getAlbumTitle() - Method in interface com.apple.android.music.playback.model.PlayerMediaItem
-
Gets the item's album title.
- getAlbumTrackCount() - Method in interface com.apple.android.music.playback.model.PlayerMediaItem
-
Gets the total number of tracks on the item's album.
- getAlbumTrackNumber() - Method in interface com.apple.android.music.playback.model.PlayerMediaItem
-
Gets the track number for this item, if it's part of an album.
- getArtistName() - Method in interface com.apple.android.music.playback.model.PlayerMediaItem
-
Gets the artist name for this item.
- getArtistSubscriptionStoreId() - Method in interface com.apple.android.music.playback.model.PlayerMediaItem
-
Gets the subscription store ID for the artists of this album, which is null if not applicable.
- getArtworkUrl() - Method in interface com.apple.android.music.playback.model.PlayerMediaItem
-
Gets the artwork URL for this item, with the default dimensions.
- getArtworkUrl(int, int) - Method in interface com.apple.android.music.playback.model.PlayerMediaItem
-
Gets the artwork URL for this item, with the specified dimensions.
- getAssetUrl() - Method in interface com.apple.android.music.playback.model.PlayerMediaItem
-
Gets the asset url (if available) for this item.
- getAvailableTracks() - Method in interface com.apple.android.music.playback.controller.MediaPlayerController
-
Gets the set of currently available tracks in the player.
- getBufferedPosition() - Method in interface com.apple.android.music.playback.controller.MediaPlayerController
-
Gets the player's buffered position, in milliseconds.
- getCloudLibraryUniversalId() - Method in interface com.apple.android.music.playback.model.PlayerMediaItem
-
- getComposerName() - Method in interface com.apple.android.music.playback.model.PlayerMediaItem
-
Gets the name of the composer for this item.
- getContainerPersistentId() - Method in class com.apple.android.music.playback.queue.CatalogPlaybackQueueItemProvider
-
- getContainerStoreId() - Method in class com.apple.android.music.playback.queue.CatalogPlaybackQueueItemProvider
-
- getContainerType() - Method in class com.apple.android.music.playback.queue.CatalogPlaybackQueueItemProvider
-
- getCurrentContainerHashId() - Method in interface com.apple.android.music.playback.controller.MediaPlayerController
-
- getCurrentContainerIndex() - Method in interface com.apple.android.music.playback.controller.MediaPlayerController
-
Gets the index of the currently playing item in the current media container.
- getCurrentContainerPersistentId() - Method in interface com.apple.android.music.playback.controller.MediaPlayerController
-
Gets the persistent id of the currently playing media container, or null if there are no items loaded,
or the player is not playing from a container with a persistent id.
- getCurrentContainerStoreId() - Method in interface com.apple.android.music.playback.controller.MediaPlayerController
-
- getCurrentContainerType() - Method in interface com.apple.android.music.playback.controller.MediaPlayerController
-
Gets the type of the currently playing media container.
- getCurrentItem() - Method in interface com.apple.android.music.playback.controller.MediaPlayerController
-
Gets the current player queue item loaded into the player, which is null if no items have been loaded yet.
- getCurrentPosition() - Method in interface com.apple.android.music.playback.controller.MediaPlayerController
-
Gets the current playback position, in milliseconds.
- getCustomLyrics() - Method in interface com.apple.android.music.playback.model.PlayerMediaItem
-
Gets the custom, user-supplied lyrics for this item, or null if no custom lyrics exist.
- getDeveloperToken() - Method in interface com.apple.android.sdk.authentication.TokenProvider
-
- getDuration() - Method in interface com.apple.android.music.playback.controller.MediaPlayerController
-
Gets the duration, in milliseconds.
- getDuration() - Method in interface com.apple.android.music.playback.model.PlayerMediaItem
-
Gets the playback duration in milliseconds for this item.
- getError() - Method in class com.apple.android.sdk.authentication.TokenResult
-
Used to retrieve token generation errors if any.
- getErrorCode() - Method in enum com.apple.android.sdk.authentication.TokenError
-
- getErrorFromValue(int) - Static method in enum com.apple.android.sdk.authentication.TokenError
-
- getExplicitContentRating() - Method in interface com.apple.android.music.playback.model.PlayerMediaItem
-
Gets the explicit content rating value for this item.
- getExtraParams() - Method in exception com.apple.android.music.playback.model.MediaPlayerException
-
- getGenreName() - Method in interface com.apple.android.music.playback.model.PlayerMediaItem
-
Gets the genre name for this item.
- getItem() - Method in interface com.apple.android.music.playback.model.PlayerQueueItem
-
Gets the associated media item for this queue item, which contains metadata and other information about the media.
- getItemAtIndex(int) - Method in class com.apple.android.music.playback.queue.CatalogPlaybackQueueItemProvider
-
- getItemCount() - Method in class com.apple.android.music.playback.queue.CatalogPlaybackQueueItemProvider
-
- getMusicUserToken() - Method in class com.apple.android.sdk.authentication.TokenResult
-
Used to retrieve the music user token.
- getPersistentId() - Method in interface com.apple.android.music.playback.model.PlayerMediaItem
-
Gets the persistent (device local) id for this item, or 0 if not applicable.
- getPlaybackEndpointParams() - Method in interface com.apple.android.music.playback.model.PlayerMediaItem
-
Gets the playback endpoint parameters for this item.
- getPlaybackEndpointType() - Method in interface com.apple.android.music.playback.model.PlayerMediaItem
-
Gets the playback endpoint type for this item.
- getPlaybackQueueId() - Method in interface com.apple.android.music.playback.model.PlayerQueueItem
-
Gets the queue ID for this instance, which is a unique identifier for this item in the playback queue.
- getPlaybackQueueIndex() - Method in interface com.apple.android.music.playback.controller.MediaPlayerController
-
Gets the index in the playback queue of the currently playing item.
- getPlaybackQueueItemCount() - Method in interface com.apple.android.music.playback.controller.MediaPlayerController
-
Gets the total number of items in the playback queue.
- getPlaybackRate() - Method in interface com.apple.android.music.playback.controller.MediaPlayerController
-
Gets the current playback rate, as a multiple of 1.0 to denote the normal playback rate, 0 if playback is paused or stopped, or a negative value means that playback is playing in reverse.
- getPlaybackState() - Method in interface com.apple.android.music.playback.controller.MediaPlayerController
-
Gets the playback state.
- getPlaybackStoreId() - Method in interface com.apple.android.music.playback.model.PlayerMediaItem
-
Gets the store id to be used for playback purposes.
- getQueueItems() - Method in interface com.apple.android.music.playback.controller.MediaPlayerController
-
Gets a bounded list of the queued items following the currently playing item in the playback queue, which will update as playback progresses, or new items are added to/removed from the queue.
- getRadioLikeState() - Method in interface com.apple.android.music.playback.model.PlayerMediaItem
-
Gets the like state for this item, if it is being played in a radio context.
- getReleaseDate() - Method in interface com.apple.android.music.playback.model.PlayerMediaItem
-
Gets the release date for this item.
- getRepeatMode() - Method in interface com.apple.android.music.playback.controller.MediaPlayerController
-
Gets the repeat mode.
- getShuffleMode() - Method in interface com.apple.android.music.playback.controller.MediaPlayerController
-
Gets the shuffle mode.
- getSubscriptionStoreId() - Method in interface com.apple.android.music.playback.model.PlayerMediaItem
-
Gets the ID for this item in the subscription store, which is null if not applicable.
- getTitle() - Method in interface com.apple.android.music.playback.model.PlayerMediaItem
-
Gets the title for this item.
- getType() - Method in exception com.apple.android.music.playback.model.MediaPlayerException
-
Gets the type of the media player exception.
- getType() - Method in interface com.apple.android.music.playback.model.PlayerMediaItem
-
Gets the type of media for this item.
- getUrl() - Method in interface com.apple.android.music.playback.model.PlayerMediaItem
-
Gets the URL for this item.
- getUserToken() - Method in interface com.apple.android.sdk.authentication.TokenProvider
-
- getVideoHeight() - Method in interface com.apple.android.music.playback.controller.MediaPlayerController
-
Gets the height, in pixels, of the currently playing video, or 0 if no video is currently playing.
- getVideoPixelAspectRatio() - Method in interface com.apple.android.music.playback.controller.MediaPlayerController
-
Gets the pixel aspect ratio of the currently playing video, or 0 if no video is currently playing.
- getVideoWidth() - Method in interface com.apple.android.music.playback.controller.MediaPlayerController
-
Gets the width, in pixels, of the currently playing video, or 0 if no video is currently playing.
- seekToPosition(long) - Method in interface com.apple.android.music.playback.controller.MediaPlayerController
-
Seeks to the specified position, in milliseconds.
- setContextId(String) - Method in class com.apple.android.sdk.authentication.AuthIntentBuilder
-
Set the id of an album/playlist/song to give more context to the upsell that will display after deeplinking to Apple Music.
- setCustomParams(HashMap<String, String>) - Method in class com.apple.android.sdk.authentication.AuthIntentBuilder
-
Set dictionary with affiliate/campaign parameters if any to be passed to Apple Music.
- setHideStartScreen(boolean) - Method in class com.apple.android.sdk.authentication.AuthIntentBuilder
-
Set hideStartScreen to true to hide the authentication-flow-starting-activity and deeplink directly to Apple Music.
- setItemPositionProvider(PlayerMediaItemPositionProvider) - Method in interface com.apple.android.music.playback.controller.MediaPlayerController
-
Sets the item position provider, which allows for overriding of the default start position of
each media item in the playback queue.
- setParams(String, String) - Method in exception com.apple.android.music.playback.model.MediaPlayerException
-
- setRadioLikeState(int) - Method in interface com.apple.android.music.playback.controller.MediaPlayerController
-
Sets the radio like state for the currently playing item, if that operation is currently supported.
- setRepeatMode(int) - Method in interface com.apple.android.music.playback.controller.MediaPlayerController
-
Sets the current repeat mode.
- setShuffleMode(int) - Method in interface com.apple.android.music.playback.controller.MediaPlayerController
-
Sets the current shuffle mode.
- setStartScreenMessage(String) - Method in class com.apple.android.sdk.authentication.AuthIntentBuilder
-
Sets the message to display in authentication-flow-starting-activity.
- setTimedTextOutputHandler(TimedTextOutput, Handler) - Method in interface com.apple.android.music.playback.controller.MediaPlayerController
-
Sets an output handler for timed text data (subtitles and closed captions).
- setTimedTextTrackSelection(MediaPlayerTrackInfo) - Method in interface com.apple.android.music.playback.controller.MediaPlayerController
-
Sets the track selection for timed text output.
- setVideoOutputSurface(Surface) - Method in interface com.apple.android.music.playback.controller.MediaPlayerController
-
Sets the surface to which video output should be rendered to.
- shouldBookmarkPlayPosition() - Method in interface com.apple.android.music.playback.model.PlayerMediaItem
-
Gets whether this item should bookmark its play position.
- SHUFFLE_MODE_INVALID - Static variable in annotation type com.apple.android.music.playback.model.PlaybackShuffleMode
-
- SHUFFLE_MODE_OFF - Static variable in annotation type com.apple.android.music.playback.model.PlaybackShuffleMode
-
- SHUFFLE_MODE_SONGS - Static variable in annotation type com.apple.android.music.playback.model.PlaybackShuffleMode
-
- shuffleMode(int) - Method in class com.apple.android.music.playback.queue.CatalogPlaybackQueueItemProvider.Builder
-
Sets the desired playback shuffle mode for the playback queue.
- skipToNextItem() - Method in interface com.apple.android.music.playback.controller.MediaPlayerController
-
Skips to the next item in the playback queue if valid.
- skipToPreviousItem() - Method in interface com.apple.android.music.playback.controller.MediaPlayerController
-
Skips to the previous item in the playback queue if valid.
- skipToQueueItemWithId(long) - Method in interface com.apple.android.music.playback.controller.MediaPlayerController
-
Skips to the item specified by the given playback queue ID if valid.
- SONG - Static variable in annotation type com.apple.android.music.playback.model.MediaItemType
-
- startItemIndex(int) - Method in class com.apple.android.music.playback.queue.CatalogPlaybackQueueItemProvider.Builder
-
Starts playback from the specified index, rather than from the start of the playback queue.
- stop() - Method in interface com.apple.android.music.playback.controller.MediaPlayerController
-
Stops playback.
- STOPPED - Static variable in annotation type com.apple.android.music.playback.model.PlaybackState
-