public static final class MediaMetadataCompat.Builder extends Object
Constructor and Description |
---|
Builder()
Create an empty Builder.
|
Builder(MediaMetadataCompat source)
Create a Builder using a
MediaMetadataCompat instance to set the
initial values. |
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. |
Modifier and Type | Method and Description |
---|---|
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.
|
public Builder()
MediaMetadataCompat
must be added.public Builder(MediaMetadataCompat source)
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.source
- public Builder(MediaMetadataCompat source, int maxBitmapSize)
MediaMetadataCompat
instance to set
initial values, but replace bitmaps with a scaled down copy if they
are larger than maxBitmapSize.
This also deep-copies the bitmaps for MediaMetadataCompat.METADATA_KEY_ART
and
MediaMetadataCompat.METADATA_KEY_ALBUM_ART
on
android.os.Build.VERSION_CODES#ICE_CREAM_SANDWITCH
and later
to prevent bitmaps from being recycled by RCC.
source
- The original metadata to copy.maxBitmapSize
- The maximum height/width for bitmaps contained
in the metadata.public MediaMetadataCompat.Builder putText(String key, CharSequence value)
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
key
- The key for referencing this valuevalue
- The CharSequence value to storepublic MediaMetadataCompat.Builder putString(String key, String value)
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
key
- The key for referencing this valuevalue
- The String value to storepublic MediaMetadataCompat.Builder putLong(String key, long value)
key
- The key for referencing this valuevalue
- The String value to storepublic MediaMetadataCompat.Builder putRating(String key, RatingCompat value)
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:
key
- The key for referencing this valuevalue
- The String value to storepublic MediaMetadataCompat.Builder putBitmap(String key, Bitmap value)
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
MediaSessionCompat.setMetadata(android.support.v4.media.MediaMetadataCompat)
is called.
To pass full resolution images Uris
should be used with
putString(java.lang.String, java.lang.String)
.key
- The key for referencing this valuevalue
- The Bitmap to storepublic MediaMetadataCompat build()
MediaMetadataCompat
instance with the specified fields.