Overview

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

Summary

Constructors
public	Builder() Create an empty Builder.
public	Builder(MediaMetadataCompat source) Create a Builder using a MediaMetadataCompat instance to set the initial values.
public	Builder(MediaMetadataCompat source, int maxBitmapSize) Create a Builder using a MediaMetadataCompat instance to set initial values, but replace bitmaps with a scaled down copy if they are larger than maxBitmapSize.

Methods
public MediaMetadataCompat	build() Creates a MediaMetadataCompat instance with the specified fields.
public MediaMetadataCompat.Builder	putBitmap(java.lang.String key, Bitmap value) Put a Bitmap into the metadata.
public MediaMetadataCompat.Builder	putLong(java.lang.String key, long value) Put a long value into the metadata.
public MediaMetadataCompat.Builder	putRating(java.lang.String key, RatingCompat value) Put a RatingCompat into the metadata.
public MediaMetadataCompat.Builder	putString(java.lang.String key, java.lang.String value) Put a String value into the metadata.
public MediaMetadataCompat.Builder	putText(java.lang.String key, java.lang.CharSequence value) Put a CharSequence value into the metadata.
from java.lang.Object	clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructors

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

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.

Parameters:

source:

Create a Builder using a MediaMetadataCompat instance to set initial values, but replace bitmaps with a scaled down copy if they are larger than maxBitmapSize.

Parameters:

source: The original metadata to copy.
maxBitmapSize: The maximum height/width for bitmaps contained in the metadata.

Methods

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: The key for referencing this value
value: The CharSequence value to store

Returns:

The Builder to allow chaining

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: The key for referencing this value
value: The String value to store

Returns:

The Builder to allow chaining

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: The key for referencing this value
value: The String value to store

Returns:

The Builder to allow chaining

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: The key for referencing this value
value: The String value to store

Returns:

The Builder to allow chaining

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 should be used with MediaMetadataCompat.Builder.putString(String, String).

Parameters:

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

Returns:

The Builder to allow chaining

Creates a MediaMetadataCompat instance with the specified fields.

Returns:

The new MediaMetadata instance