apple.mediaplayer.protocol

Interface MPPlayableContentDataSource

public interface MPPlayableContentDataSource

MPPlayableContentDataSource is a protocol that application objects conform to if they want to support external media players, such as vehicle head units. Data sources are responsible for providing metadata about your media to these systems in a meaningful way, so that features like user interfaces and play queues can be setup automatically.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	MPPlayableContentDataSource.Block_beginLoadingChildItemsAtIndexPathCompletionHandler
static interface	MPPlayableContentDataSource.Block_contentItemForIdentifierCompletionHandler

Method Summary

Modifier and Type	Method and Description
default void	beginLoadingChildItemsAtIndexPathCompletionHandler(NSIndexPath indexPath, MPPlayableContentDataSource.Block_beginLoadingChildItemsAtIndexPathCompletionHandler completionHandler) Tells the data source to begin loading content items that are children of the item specified by indexPath.
default boolean	childItemsDisplayPlaybackProgressAtIndexPath(NSIndexPath indexPath) Tells MediaPlayer whether the content provided by the data source supports playback progress as a property of its metadata.
MPContentItem	contentItemAtIndexPath(NSIndexPath indexPath) Returns the content item at the specified index path.
default void	contentItemForIdentifierCompletionHandler(java.lang.String identifier, MPPlayableContentDataSource.Block_contentItemForIdentifierCompletionHandler completionHandler) Provides a content item for the provided identifier.
long	numberOfChildItemsAtIndexPath(NSIndexPath indexPath) Returns the number of child nodes at the specified index path.

Method Detail

beginLoadingChildItemsAtIndexPathCompletionHandler

default void beginLoadingChildItemsAtIndexPathCompletionHandler(NSIndexPath indexPath,
                                                                MPPlayableContentDataSource.Block_beginLoadingChildItemsAtIndexPathCompletionHandler completionHandler)

Tells the data source to begin loading content items that are children of the item specified by indexPath. This is provided so that applications can begin asynchronous batched loading of content before MediaPlayer begins asking for content items to display. Client applications should always call the completion handler after loading has finished, if this method is implemented.

childItemsDisplayPlaybackProgressAtIndexPath

default boolean childItemsDisplayPlaybackProgressAtIndexPath(NSIndexPath indexPath)

Tells MediaPlayer whether the content provided by the data source supports playback progress as a property of its metadata. If this method is not implemented, MediaPlayer will assume that progress is not supported for any content items.

contentItemAtIndexPath

MPContentItem contentItemAtIndexPath(NSIndexPath indexPath)

Returns the content item at the specified index path. If the content item is mutated after returning, its updated contents will be sent to MediaPlayer.

contentItemForIdentifierCompletionHandler

default void contentItemForIdentifierCompletionHandler(java.lang.String identifier,
                                                       MPPlayableContentDataSource.Block_contentItemForIdentifierCompletionHandler completionHandler)

Provides a content item for the provided identifier. Provide nil if there is no content item corresponding to the identifier. Provide an error if there is an error that will not allow content items to be retrieved. Client applications should always call the completion handler after loading has finished, if this method is implemented.

numberOfChildItemsAtIndexPath

long numberOfChildItemsAtIndexPath(NSIndexPath indexPath)

Returns the number of child nodes at the specified index path. In a virtual filesystem, this would be the number of files in a specific folder. An empty index path represents the root node.