public
static
final
class
MediaMetadata.Builder
extends Object
| java.lang.Object | |
| ↳ | android.media.MediaMetadata.Builder |
Use to build MediaMetadata objects. The system defined metadata keys must use the appropriate data type.
Public constructors | |
|---|---|
MediaMetadata.Builder()
Create an empty Builder. |
|
MediaMetadata.Builder(MediaMetadata source)
Create a Builder using a |
|
Public methods | |
|---|---|
MediaMetadata
|
build()
Creates a |
MediaMetadata.Builder
|
putBitmap(String key, Bitmap value)
Put a |
MediaMetadata.Builder
|
putLong(String key, long value)
Put a long value into the metadata. |
MediaMetadata.Builder
|
putRating(String key, Rating value)
Put a |
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. |
Inherited methods | |
|---|---|
 From
class
java.lang.Object
| |
MediaMetadata.Builder ()
Create an empty Builder. Any field that should be included in the
MediaMetadata must be added.
MediaMetadata.Builder (MediaMetadata source)
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.
MediaMetadata build ()
Creates a MediaMetadata instance with the specified fields.
| Returns | |
|---|---|
MediaMetadata |
The new MediaMetadata instance |
MediaMetadata.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:
Large bitmaps may be scaled down by the system. 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 | |
|---|---|
MediaMetadata.Builder |
The Builder to allow chaining |
MediaMetadata.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:
Developers
METADATA_KEY_DURATIONMETADATA_KEY_TRACK_NUMBERMETADATA_KEY_NUM_TRACKSMETADATA_KEY_DISC_NUMBERMETADATA_KEY_YEAR| Parameters | |
|---|---|
key |
String:
The key for referencing this value |
value |
long:
The long value to store |
| Returns | |
|---|---|
MediaMetadata.Builder |
The Builder to allow chaining |
MediaMetadata.Builder putRating (String key, Rating value)
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 |
String:
The key for referencing this value |
value |
Rating:
The Rating value to store |
| Returns | |
|---|---|
MediaMetadata.Builder |
The Builder to allow chaining |
MediaMetadata.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:
METADATA_KEY_TITLEMETADATA_KEY_ARTISTMETADATA_KEY_ALBUMMETADATA_KEY_AUTHORMETADATA_KEY_WRITERMETADATA_KEY_COMPOSERMETADATA_KEY_DATEMETADATA_KEY_GENREMETADATA_KEY_ALBUM_ARTISTMETADATA_KEY_ART_URIMETADATA_KEY_ALBUM_ART_URIMETADATA_KEY_DISPLAY_TITLEMETADATA_KEY_DISPLAY_SUBTITLEMETADATA_KEY_DISPLAY_DESCRIPTIONMETADATA_KEY_DISPLAY_ICON_URI
Uris for artwork should use the content:// style and support
EXTRA_SIZE for retrieving scaled artwork
through openTypedAssetFileDescriptor(Uri, String, Bundle).
| Parameters | |
|---|---|
key |
String:
The key for referencing this value |
value |
String:
The String value to store |
| Returns | |
|---|---|
MediaMetadata.Builder |
The Builder to allow chaining |
MediaMetadata.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:
METADATA_KEY_TITLEMETADATA_KEY_ARTISTMETADATA_KEY_ALBUMMETADATA_KEY_AUTHORMETADATA_KEY_WRITERMETADATA_KEY_COMPOSERMETADATA_KEY_DATEMETADATA_KEY_GENREMETADATA_KEY_ALBUM_ARTISTMETADATA_KEY_ART_URIMETADATA_KEY_ALBUM_ART_URIMETADATA_KEY_DISPLAY_TITLEMETADATA_KEY_DISPLAY_SUBTITLEMETADATA_KEY_DISPLAY_DESCRIPTIONMETADATA_KEY_DISPLAY_ICON_URI| Parameters | |
|---|---|
key |
String:
The key for referencing this value |
value |
CharSequence:
The CharSequence value to store |
| Returns | |
|---|---|
MediaMetadata.Builder |
The Builder to allow chaining |