apple.mediaplayer.protocol

Interface MPPlayableContentDelegate

public interface MPPlayableContentDelegate

The MPPlayableContentDelegate is a protocol that allows for external media players to send playback commands to an application. For instance, the user could browse the application's media content (provided by the MPPlayableContentDataSource) and selects a content item to play. If the media player decides that it wants to play the item, it will ask the application's content delegate to initiate playback.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	MPPlayableContentDelegate.Block_playableContentManagerInitializePlaybackQueueWithCompletionHandler
static interface	MPPlayableContentDelegate.Block_playableContentManagerInitializePlaybackQueueWithContentItemsCompletionHandler
static interface	MPPlayableContentDelegate.Block_playableContentManagerInitiatePlaybackOfContentItemAtIndexPathCompletionHandler

Method Summary

Modifier and Type	Method and Description
default void	playableContentManagerDidUpdateContext(MPPlayableContentManager contentManager, MPPlayableContentManagerContext context) This method is called when the content server notifies the manager that the current context has changed.
default void	playableContentManagerInitializePlaybackQueueWithCompletionHandler(MPPlayableContentManager contentManager, MPPlayableContentDelegate.Block_playableContentManagerInitializePlaybackQueueWithCompletionHandler completionHandler) This method is called when a media player interface wants the now playing app to setup a playback queue for later playback.
default void	playableContentManagerInitializePlaybackQueueWithContentItemsCompletionHandler(MPPlayableContentManager contentManager, NSArray<?> contentItems, MPPlayableContentDelegate.Block_playableContentManagerInitializePlaybackQueueWithContentItemsCompletionHandler completionHandler) This method is called when a media player interface wants the now playing app to setup a playback queue for later playback.
default void	playableContentManagerInitiatePlaybackOfContentItemAtIndexPathCompletionHandler(MPPlayableContentManager contentManager, NSIndexPath indexPath, MPPlayableContentDelegate.Block_playableContentManagerInitiatePlaybackOfContentItemAtIndexPathCompletionHandler completionHandler) This method is called when a media player interface wants to play a requested content item.

Method Detail

playableContentManagerDidUpdateContext

default void playableContentManagerDidUpdateContext(MPPlayableContentManager contentManager,
                                                    MPPlayableContentManagerContext context)

This method is called when the content server notifies the manager that the current context has changed.

playableContentManagerInitializePlaybackQueueWithCompletionHandler

default void playableContentManagerInitializePlaybackQueueWithCompletionHandler(MPPlayableContentManager contentManager,
                                                                                MPPlayableContentDelegate.Block_playableContentManagerInitializePlaybackQueueWithCompletionHandler completionHandler)

This method is called when a media player interface wants the now playing app to setup a playback queue for later playback. The application should load content into its play queue but not start playback until a Play command is received or if the playable content manager requests to play something else. The app should call the provided completion handler once it is ready to play something.

playableContentManagerInitializePlaybackQueueWithContentItemsCompletionHandler

default void playableContentManagerInitializePlaybackQueueWithContentItemsCompletionHandler(MPPlayableContentManager contentManager,
                                                                                            NSArray<?> contentItems,
                                                                                            MPPlayableContentDelegate.Block_playableContentManagerInitializePlaybackQueueWithContentItemsCompletionHandler completionHandler)

This method is called when a media player interface wants the now playing app to setup a playback queue for later playback. The application should load content into its play queue based on the provided content items and prepare it for playback, but not start playback until a Play command is received or if the playable content manager requests to play something else. A nil contentItems array means that the app should prepare its queue with anything it deems appropriate. The app should call the provided completion handler once it is ready to play something.

playableContentManagerInitiatePlaybackOfContentItemAtIndexPathCompletionHandler

default void playableContentManagerInitiatePlaybackOfContentItemAtIndexPathCompletionHandler(MPPlayableContentManager contentManager,
                                                                                             NSIndexPath indexPath,
                                                                                             MPPlayableContentDelegate.Block_playableContentManagerInitiatePlaybackOfContentItemAtIndexPathCompletionHandler completionHandler)

This method is called when a media player interface wants to play a requested content item. The application should call the completion handler with an appropriate error if there was an error beginning playback for the item.