MediaSessionConnector: Document how to provide metadata asynchronously

Issue: #6047
PiperOrigin-RevId: 255992898
This commit is contained in:
bachinger 2019-07-01 19:13:03 +01:00 committed by Oliver Woodman
parent 71e0f2e81c
commit c4c7f4bafa

View File

@ -377,6 +377,13 @@ public final class MediaSessionConnector {
/** /**
* Gets the {@link MediaMetadataCompat} to be published to the session. * Gets the {@link MediaMetadataCompat} to be published to the session.
* *
* <p>An app may need to load metadata resources like artwork bitmaps asynchronously. In such a
* case the app should return a {@link MediaMetadataCompat} object that does not contain these
* resources as a placeholder. The app should start an asynchronous operation to download the
* bitmap and put it into a cache. Finally, the app should call {@link
* #invalidateMediaSessionMetadata()}. This causes this callback to be called again and the app
* can now return a {@link MediaMetadataCompat} object with all the resources included.
*
* @param player The player connected to the media session. * @param player The player connected to the media session.
* @return The {@link MediaMetadataCompat} to be published to the session. * @return The {@link MediaMetadataCompat} to be published to the session.
*/ */