added in version 22.1.0

Summary: Ctors | Methods | Inherited Methods

MediaMetadataCompat.Builder

Kotlin |Java

public static final class MediaMetadataCompat.Builder
extends Object

java.lang.Object
↳	android.support.v4.media.MediaMetadataCompat.Builder

---

Use to build MediaMetadata objects. The system defined metadata keys must use the appropriate data type.

Summary

Public constructors
MediaMetadataCompat.Builder() Create an empty Builder.
MediaMetadataCompat.Builder(MediaMetadataCompat source) Create a Builder using a MediaMetadataCompat instance to set the initial values.

Public methods
MediaMetadataCompat	build() Creates a MediaMetadataCompat instance with the specified fields.
MediaMetadataCompat.Builder	putBitmap(String key, Bitmap value) Put a Bitmap into the metadata.
MediaMetadataCompat.Builder	putLong(String key, long value) Put a long value into the metadata.
MediaMetadataCompat.Builder	putRating(String key, RatingCompat value) Put a RatingCompat into the metadata.
MediaMetadataCompat.Builder	putString(String key, String value) Put a String value into the metadata.
MediaMetadataCompat.Builder	putText(String key, CharSequence value) Put a CharSequence value into the metadata.

Inherited methods
From class java.lang.Object Object clone() boolean equals(Object arg0) void finalize() final Class<?> getClass() int hashCode() final void notify() final void notifyAll() String toString() final void wait(long arg0, int arg1) final void wait(long arg0) final void wait()

Public constructors

MediaMetadataCompat.Builder

added in version 22.1.0

public MediaMetadataCompat.Builder ()

Create an empty Builder. Any field that should be included in the MediaMetadataCompat must be added.

MediaMetadataCompat.Builder

added in version 22.1.0

public MediaMetadataCompat.Builder (MediaMetadataCompat source)

Create a Builder using a MediaMetadataCompat instance to set the initial values. All fields in the source metadata will be included in the new metadata. Fields can be overwritten by adding the same key.

Public methods

build

added in version 22.1.0

public MediaMetadataCompat build ()

Creates a MediaMetadataCompat instance with the specified fields.

Returns
MediaMetadataCompat	The new MediaMetadata instance

putBitmap

added in version 22.1.0

public MediaMetadataCompat.Builder putBitmap (String key, 
                Bitmap value)

Put a Bitmap into the metadata. Custom keys may be used, but if the METADATA_KEYs defined in this class are used they may only be one of the following:

• MediaMetadataCompat.METADATA_KEY_ART
• MediaMetadataCompat.METADATA_KEY_ALBUM_ART
• MediaMetadataCompat.METADATA_KEY_DISPLAY_ICON

Large bitmaps may be scaled down when MediaSessionCompat.setMetadata(MediaMetadataCompat) is called. To pass full resolution images Uris should be used with putString(String, String).

Parameters
key	String: The key for referencing this value
value	Bitmap: The Bitmap to store

Returns
MediaMetadataCompat.Builder	The Builder to allow chaining

putLong

added in version 22.1.0

public MediaMetadataCompat.Builder putLong (String key, 
                long value)

Put a long value into the metadata. Custom keys may be used, but if the METADATA_KEYs defined in this class are used they may only be one of the following:

• MediaMetadataCompat.METADATA_KEY_DURATION
• MediaMetadataCompat.METADATA_KEY_TRACK_NUMBER
• MediaMetadataCompat.METADATA_KEY_NUM_TRACKS
• MediaMetadataCompat.METADATA_KEY_DISC_NUMBER
• MediaMetadataCompat.METADATA_KEY_YEAR
• MediaMetadataCompat.METADATA_KEY_BT_FOLDER_TYPE
• MediaMetadataCompat.METADATA_KEY_ADVERTISEMENT
• MediaMetadataCompat.METADATA_KEY_DOWNLOAD_STATUS

Parameters
key	String: The key for referencing this value
value	long: The String value to store

Returns
MediaMetadataCompat.Builder	The Builder to allow chaining

putRating

added in version 22.1.0

public MediaMetadataCompat.Builder putRating (String key, 
                RatingCompat value)

Put a RatingCompat into the metadata. Custom keys may be used, but if the METADATA_KEYs defined in this class are used they may only be one of the following:

• MediaMetadataCompat.METADATA_KEY_RATING
• MediaMetadataCompat.METADATA_KEY_USER_RATING

Parameters
key	String: The key for referencing this value
value	RatingCompat: The String value to store

Returns
MediaMetadataCompat.Builder	The Builder to allow chaining

putString

added in version 22.1.0

public MediaMetadataCompat.Builder putString (String key, 
                String value)

Put a String value into the metadata. Custom keys may be used, but if the METADATA_KEYs defined in this class are used they may only be one of the following:

• MediaMetadataCompat.METADATA_KEY_TITLE
• MediaMetadataCompat.METADATA_KEY_ARTIST
• MediaMetadataCompat.METADATA_KEY_ALBUM
• MediaMetadataCompat.METADATA_KEY_AUTHOR
• MediaMetadataCompat.METADATA_KEY_WRITER
• MediaMetadataCompat.METADATA_KEY_COMPOSER
• MediaMetadataCompat.METADATA_KEY_DATE
• MediaMetadataCompat.METADATA_KEY_GENRE
• MediaMetadataCompat.METADATA_KEY_ALBUM_ARTIST
• MediaMetadataCompat.METADATA_KEY_ART_URI
• MediaMetadataCompat.METADATA_KEY_ALBUM_ART_URI
• MediaMetadataCompat.METADATA_KEY_DISPLAY_TITLE
• MediaMetadataCompat.METADATA_KEY_DISPLAY_SUBTITLE
• MediaMetadataCompat.METADATA_KEY_DISPLAY_DESCRIPTION
• MediaMetadataCompat.METADATA_KEY_DISPLAY_ICON_URI

Parameters
key	String: The key for referencing this value
value	String: The String value to store

Returns
MediaMetadataCompat.Builder	The Builder to allow chaining

putText

added in version 22.1.0

public MediaMetadataCompat.Builder putText (String key, 
                CharSequence value)

Put a CharSequence value into the metadata. Custom keys may be used, but if the METADATA_KEYs defined in this class are used they may only be one of the following:

• MediaMetadataCompat.METADATA_KEY_TITLE
• MediaMetadataCompat.METADATA_KEY_ARTIST
• MediaMetadataCompat.METADATA_KEY_ALBUM
• MediaMetadataCompat.METADATA_KEY_AUTHOR
• MediaMetadataCompat.METADATA_KEY_WRITER
• MediaMetadataCompat.METADATA_KEY_COMPOSER
• MediaMetadataCompat.METADATA_KEY_DATE
• MediaMetadataCompat.METADATA_KEY_GENRE
• MediaMetadataCompat.METADATA_KEY_ALBUM_ARTIST
• MediaMetadataCompat.METADATA_KEY_ART_URI
• MediaMetadataCompat.METADATA_KEY_ALBUM_ART_URI
• MediaMetadataCompat.METADATA_KEY_DISPLAY_TITLE
• MediaMetadataCompat.METADATA_KEY_DISPLAY_SUBTITLE
• MediaMetadataCompat.METADATA_KEY_DISPLAY_DESCRIPTION
• MediaMetadataCompat.METADATA_KEY_DISPLAY_ICON_URI

Parameters
key	String: The key for referencing this value
value	CharSequence: The CharSequence value to store

Returns
MediaMetadataCompat.Builder	The Builder to allow chaining

• Classes

  • MediaBrowserCompat
  • MediaBrowserCompat.ConnectionCallback
  • MediaBrowserCompat.CustomActionCallback
  • MediaBrowserCompat.ItemCallback
  • MediaBrowserCompat.MediaItem
  • MediaBrowserCompat.SearchCallback
  • MediaBrowserCompat.SubscriptionCallback
  • MediaDescriptionCompat
  • MediaDescriptionCompat.Builder
  • MediaMetadataCompat
  • MediaMetadataCompat.Builder
  • RatingCompat