MediaMetadataCompat.Builder
public final class MediaMetadataCompat.Builder
Use to build MediaMetadata objects. The system defined metadata keys must use the appropriate data type.
Summary
Public constructors |
|---|
Builder()Create an empty Builder. |
Builder(MediaMetadataCompat source)Create a Builder using a |
Public methods |
|
|---|---|
MediaMetadataCompat |
build()Creates a |
MediaMetadataCompat.Builder |
Put a |
MediaMetadataCompat.Builder |
Put a long value into the metadata. |
MediaMetadataCompat.Builder |
putRating(String key, RatingCompat value)Put a |
MediaMetadataCompat.Builder |
Put a String value into the metadata. |
MediaMetadataCompat.Builder |
putText(String key, CharSequence value)Put a CharSequence value into the metadata. |
Public constructors
Builder
public Builder()
Create an empty Builder. Any field that should be included in the MediaMetadataCompat must be added.
Builder
public Builder(MediaMetadataCompat source)
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 | |
|---|---|
MediaMetadataCompat source |
Public methods
build
public MediaMetadataCompat build()
Creates a MediaMetadataCompat instance with the specified fields.
| Returns | |
|---|---|
MediaMetadataCompat |
The new MediaMetadata instance |
putBitmap
public MediaMetadataCompat.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:
setMetadata is called. To pass full resolution images Uris should be used with putString.
| Returns | |
|---|---|
MediaMetadataCompat.Builder |
The Builder to allow chaining |
putLong
public MediaMetadataCompat.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:
METADATA_KEY_DURATIONMETADATA_KEY_TRACK_NUMBERMETADATA_KEY_NUM_TRACKSMETADATA_KEY_DISC_NUMBERMETADATA_KEY_YEARMETADATA_KEY_BT_FOLDER_TYPEMETADATA_KEY_ADVERTISEMENTMETADATA_KEY_DOWNLOAD_STATUS
| Parameters | |
|---|---|
String key |
The key for referencing this value |
long value |
The String value to store |
| Returns | |
|---|---|
MediaMetadataCompat.Builder |
The Builder to allow chaining |
putRating
public MediaMetadataCompat.Builder putRating(String key, RatingCompat value)
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:
| Parameters | |
|---|---|
String key |
The key for referencing this value |
RatingCompat value |
The String value to store |
| Returns | |
|---|---|
MediaMetadataCompat.Builder |
The Builder to allow chaining |
putString
public MediaMetadataCompat.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
| Returns | |
|---|---|
MediaMetadataCompat.Builder |
The Builder to allow chaining |
putText
public MediaMetadataCompat.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 | |
|---|---|
String key |
The key for referencing this value |
CharSequence value |
The CharSequence value to store |
| Returns | |
|---|---|
MediaMetadataCompat.Builder |
The Builder to allow chaining |