Android APIs
public static final class

MediaMetadata.Builder

extends Object
java.lang.Object
   ↳ android.media.MediaMetadata.Builder

Class Overview

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

Summary

Public Constructors
MediaMetadata.Builder()
Create an empty Builder.
MediaMetadata.Builder(MediaMetadata source)
Create a Builder using a MediaMetadata instance to set the initial values.
Public Methods
MediaMetadata build()
Creates a MediaMetadata instance with the specified fields.
MediaMetadata.Builder putBitmap(String key, Bitmap value)
Put a Bitmap into the metadata.
MediaMetadata.Builder putLong(String key, long value)
Put a long value into the metadata.
MediaMetadata.Builder putRating(String key, Rating value)
Put a Rating into the metadata.
MediaMetadata.Builder putString(String key, String value)
Put a String value into the metadata.
MediaMetadata.Builder putText(String key, CharSequence value)
Put a CharSequence value into the metadata.
[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

public MediaMetadata.Builder ()

Added in API level 21

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

public MediaMetadata.Builder (MediaMetadata source)

Added in API level 21

Create a Builder using a MediaMetadata 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

public MediaMetadata build ()

Added in API level 21

Creates a MediaMetadata instance with the specified fields.

Returns
  • The new MediaMetadata instance

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

Added in API level 21

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:

Large bitmaps may be scaled down by the system. To pass full resolution images Uris should be used with putString(String, String).

Parameters
key The key for referencing this value
value The Bitmap to store
Returns
  • The Builder to allow chaining

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

Added in API level 21

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:

Parameters
key The key for referencing this value
value The long value to store
Returns
  • The Builder to allow chaining

public MediaMetadata.Builder putRating (String key, Rating value)

Added in API level 21

Put a Rating 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:

Parameters
key The key for referencing this value
value The Rating value to store
Returns
  • The Builder to allow chaining

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

Added in API level 21

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:

Uris for artwork should use the content:// style and support EXTRA_SIZE for retrieving scaled artwork through openTypedAssetFileDescriptor(Uri, String, Bundle).

Parameters
key The key for referencing this value
value The String value to store
Returns
  • The Builder to allow chaining

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

Added in API level 21

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:

Parameters
key The key for referencing this value
value The CharSequence value to store
Returns
  • The Builder to allow chaining