keySet() {
return mBundle.keySet();
}
/**
* Gets the bundle backing the metadata object. This is available to support
* backwards compatibility. Apps should not modify the bundle directly.
*
* @return The Bundle backing this metadata.
*/
public Bundle getBundle() {
return mBundle;
}
/**
* Creates an instance from a framework {@link android.media.MediaMetadata}
* object.
*
* This method is only supported on
* {@link android.os.Build.VERSION_CODES#LOLLIPOP} and later.
*
*
* @param metadataObj A {@link android.media.MediaMetadata} object, or null
* if none.
* @return An equivalent {@link MediaMetadataCompat} object, or null if
* none.
*/
public static MediaMetadataCompat fromMediaMetadata(Object metadataObj) {
if (metadataObj != null && Build.VERSION.SDK_INT >= 21) {
Parcel p = Parcel.obtain();
MediaMetadataCompatApi21.writeToParcel(metadataObj, p, 0);
p.setDataPosition(0);
MediaMetadataCompat metadata = MediaMetadataCompat.CREATOR.createFromParcel(p);
p.recycle();
metadata.mMetadataObj = metadataObj;
return metadata;
} else {
return null;
}
}
/**
* Gets the underlying framework {@link android.media.MediaMetadata} object.
*
* This method is only supported on
* {@link android.os.Build.VERSION_CODES#LOLLIPOP} and later.
*
*
* @return An equivalent {@link android.media.MediaMetadata} object, or null
* if none.
*/
public Object getMediaMetadata() {
if (mMetadataObj == null && Build.VERSION.SDK_INT >= 21) {
Parcel p = Parcel.obtain();
writeToParcel(p, 0);
p.setDataPosition(0);
mMetadataObj = MediaMetadataCompatApi21.createFromParcel(p);
p.recycle();
}
return mMetadataObj;
}
public static final Parcelable.Creator CREATOR =
new Parcelable.Creator() {
@Override
public MediaMetadataCompat createFromParcel(Parcel in) {
return new MediaMetadataCompat(in);
}
@Override
public MediaMetadataCompat[] newArray(int size) {
return new MediaMetadataCompat[size];
}
};
/**
* Use to build MediaMetadata objects. The system defined metadata keys must
* use the appropriate data type.
*/
public static final class Builder {
private final Bundle mBundle;
/**
* Create an empty Builder. Any field that should be included in the
* {@link MediaMetadataCompat} must be added.
*/
public Builder() {
mBundle = new Bundle();
}
/**
* Create a Builder using a {@link 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.
*
* @param source
*/
public Builder(MediaMetadataCompat source) {
mBundle = new Bundle(source.mBundle);
}
/**
* Create a Builder using a {@link MediaMetadataCompat} instance to set
* initial values, but replace bitmaps with a scaled down copy if they
* are larger than maxBitmapSize.
*
* @param source The original metadata to copy.
* @param maxBitmapSize The maximum height/width for bitmaps contained
* in the metadata.
* @hide
*/
@RestrictTo(LIBRARY_GROUP)
public Builder(MediaMetadataCompat source, int maxBitmapSize) {
this(source);
for (String key : mBundle.keySet()) {
Object value = mBundle.get(key);
if (value instanceof Bitmap) {
Bitmap bmp = (Bitmap) value;
if (bmp.getHeight() > maxBitmapSize || bmp.getWidth() > maxBitmapSize) {
putBitmap(key, scaleBitmap(bmp, maxBitmapSize));
}
}
}
}
/**
* 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:
*
* - {@link #METADATA_KEY_TITLE}
* - {@link #METADATA_KEY_ARTIST}
* - {@link #METADATA_KEY_ALBUM}
* - {@link #METADATA_KEY_AUTHOR}
* - {@link #METADATA_KEY_WRITER}
* - {@link #METADATA_KEY_COMPOSER}
* - {@link #METADATA_KEY_DATE}
* - {@link #METADATA_KEY_GENRE}
* - {@link #METADATA_KEY_ALBUM_ARTIST}
* - {@link #METADATA_KEY_ART_URI}
* - {@link #METADATA_KEY_ALBUM_ART_URI}
* - {@link #METADATA_KEY_DISPLAY_TITLE}
* - {@link #METADATA_KEY_DISPLAY_SUBTITLE}
* - {@link #METADATA_KEY_DISPLAY_DESCRIPTION}
* - {@link #METADATA_KEY_DISPLAY_ICON_URI}
*
*
* @param key The key for referencing this value
* @param value The CharSequence value to store
* @return The Builder to allow chaining
*/
public Builder putText(@TextKey String key, CharSequence value) {
if (METADATA_KEYS_TYPE.containsKey(key)) {
if (METADATA_KEYS_TYPE.get(key) != METADATA_TYPE_TEXT) {
throw new IllegalArgumentException("The " + key
+ " key cannot be used to put a CharSequence");
}
}
mBundle.putCharSequence(key, value);
return this;
}
/**
* 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:
*
* - {@link #METADATA_KEY_TITLE}
* - {@link #METADATA_KEY_ARTIST}
* - {@link #METADATA_KEY_ALBUM}
* - {@link #METADATA_KEY_AUTHOR}
* - {@link #METADATA_KEY_WRITER}
* - {@link #METADATA_KEY_COMPOSER}
* - {@link #METADATA_KEY_DATE}
* - {@link #METADATA_KEY_GENRE}
* - {@link #METADATA_KEY_ALBUM_ARTIST}
* - {@link #METADATA_KEY_ART_URI}
* - {@link #METADATA_KEY_ALBUM_ART_URI}
* - {@link #METADATA_KEY_DISPLAY_TITLE}
* - {@link #METADATA_KEY_DISPLAY_SUBTITLE}
* - {@link #METADATA_KEY_DISPLAY_DESCRIPTION}
* - {@link #METADATA_KEY_DISPLAY_ICON_URI}
*
*
* @param key The key for referencing this value
* @param value The String value to store
* @return The Builder to allow chaining
*/
public Builder putString(@TextKey String key, String value) {
if (METADATA_KEYS_TYPE.containsKey(key)) {
if (METADATA_KEYS_TYPE.get(key) != METADATA_TYPE_TEXT) {
throw new IllegalArgumentException("The " + key
+ " key cannot be used to put a String");
}
}
mBundle.putCharSequence(key, value);
return this;
}
/**
* 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:
*
* - {@link #METADATA_KEY_DURATION}
* - {@link #METADATA_KEY_TRACK_NUMBER}
* - {@link #METADATA_KEY_NUM_TRACKS}
* - {@link #METADATA_KEY_DISC_NUMBER}
* - {@link #METADATA_KEY_YEAR}
* - {@link #METADATA_KEY_BT_FOLDER_TYPE}
* - {@link #METADATA_KEY_ADVERTISEMENT}
* - {@link #METADATA_KEY_DOWNLOAD_STATUS}
*
*
* @param key The key for referencing this value
* @param value The String value to store
* @return The Builder to allow chaining
*/
public Builder putLong(@LongKey String key, long value) {
if (METADATA_KEYS_TYPE.containsKey(key)) {
if (METADATA_KEYS_TYPE.get(key) != METADATA_TYPE_LONG) {
throw new IllegalArgumentException("The " + key
+ " key cannot be used to put a long");
}
}
mBundle.putLong(key, value);
return this;
}
/**
* Put a {@link 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:
*
* - {@link #METADATA_KEY_RATING}
* - {@link #METADATA_KEY_USER_RATING}
*
*
* @param key The key for referencing this value
* @param value The String value to store
* @return The Builder to allow chaining
*/
public Builder putRating(@RatingKey String key, RatingCompat value) {
if (METADATA_KEYS_TYPE.containsKey(key)) {
if (METADATA_KEYS_TYPE.get(key) != METADATA_TYPE_RATING) {
throw new IllegalArgumentException("The " + key
+ " key cannot be used to put a Rating");
}
}
if (Build.VERSION.SDK_INT >= 19) {
// On platform version 19 or higher, use Rating instead of RatingCompat so mBundle
// can be unmarshalled.
mBundle.putParcelable(key, (Parcelable) value.getRating());
} else {
mBundle.putParcelable(key, value);
}
return this;
}
/**
* Put a {@link 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:
*
* - {@link #METADATA_KEY_ART}
* - {@link #METADATA_KEY_ALBUM_ART}
* - {@link #METADATA_KEY_DISPLAY_ICON}
*
* Large bitmaps may be scaled down when
* {@link android.support.v4.media.session.MediaSessionCompat#setMetadata} is called.
* To pass full resolution images {@link Uri Uris} should be used with
* {@link #putString}.
*
* @param key The key for referencing this value
* @param value The Bitmap to store
* @return The Builder to allow chaining
*/
public Builder putBitmap(@BitmapKey String key, Bitmap value) {
if (METADATA_KEYS_TYPE.containsKey(key)) {
if (METADATA_KEYS_TYPE.get(key) != METADATA_TYPE_BITMAP) {
throw new IllegalArgumentException("The " + key
+ " key cannot be used to put a Bitmap");
}
}
mBundle.putParcelable(key, value);
return this;
}
/**
* Creates a {@link MediaMetadataCompat} instance with the specified fields.
*
* @return The new MediaMetadata instance
*/
public MediaMetadataCompat build() {
return new MediaMetadataCompat(mBundle);
}
private Bitmap scaleBitmap(Bitmap bmp, int maxSize) {
float maxSizeF = maxSize;
float widthScale = maxSizeF / bmp.getWidth();
float heightScale = maxSizeF / bmp.getHeight();
float scale = Math.min(widthScale, heightScale);
int height = (int) (bmp.getHeight() * scale);
int width = (int) (bmp.getWidth() * scale);
return Bitmap.createScaledBitmap(bmp, width, height, true);
}
}
}