MediaMetadata.Builder
public final class MediaMetadata.Builder
Use to build MediaMetadatax objects. The system defined metadata keys must use the appropriate data type.
Summary
Public constructors |
|---|
Builder()Create an empty Builder. |
Builder(@NonNull MediaMetadata source)Create a Builder using a |
Public methods |
|
|---|---|
@NonNull MediaMetadata |
build()Creates a |
@NonNull MediaMetadata.Builder |
Put a |
@NonNull MediaMetadata.Builder |
Put a float value into the metadata. |
@NonNull MediaMetadata.Builder |
Put a long value into the metadata. |
@NonNull MediaMetadata.Builder |
Put a |
@NonNull MediaMetadata.Builder |
Put a String value into the metadata. |
@NonNull MediaMetadata.Builder |
putText(@NonNull String key, @Nullable CharSequence value)Put a CharSequence value into the metadata. |
@NonNull MediaMetadata.Builder |
Set a bundle of extras. |
Public constructors
public Builder()
Create an empty Builder. Any field that should be included in the MediaMetadata must be added.
public Builder(@NonNull 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.
| Parameters | |
|---|---|
@NonNull MediaMetadata source |
Public methods
public @NonNull MediaMetadata build()
Creates a MediaMetadata instance with the specified fields.
| Returns | |
|---|---|
@NonNull MediaMetadata |
The new MediaMetadatax instance |
public @NonNull MediaMetadata.Builder putBitmap(@NonNull String key, @Nullable 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:
Uris should be used with putString.
| Parameters | |
|---|---|
@NonNull String key |
The key for referencing this value |
@Nullable Bitmap value |
The Bitmap to store |
| Returns | |
|---|---|
@NonNull MediaMetadata.Builder |
The Builder to allow chaining |
public @NonNull MediaMetadata.Builder putFloat(@NonNull String key, float value)
Put a float value into the metadata. Custom keys may be used.
| Parameters | |
|---|---|
@NonNull String key |
The key for referencing this value |
float value |
The float value to store |
| Returns | |
|---|---|
@NonNull MediaMetadata.Builder |
The Builder to allow chaining |
public @NonNull MediaMetadata.Builder putLong(@NonNull 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_BROWSABLEMETADATA_KEY_PLAYABLEMETADATA_KEY_ADVERTISEMENTMETADATA_KEY_DOWNLOAD_STATUS
| Parameters | |
|---|---|
@NonNull String key |
The key for referencing this value |
long value |
The String value to store |
| Returns | |
|---|---|
@NonNull MediaMetadata.Builder |
The Builder to allow chaining |
public @NonNull MediaMetadata.Builder putRating(@NonNull String key, @Nullable 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 | |
|---|---|
@NonNull String key |
The key for referencing this value |
@Nullable Rating value |
The String value to store |
| Returns | |
|---|---|
@NonNull MediaMetadata.Builder |
The Builder to allow chaining |
public @NonNull MediaMetadata.Builder putString(@NonNull String key, @Nullable 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_COMPILATIONMETADATA_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_URIMETADATA_KEY_MEDIA_IDMETADATA_KEY_MEDIA_URI
| Parameters | |
|---|---|
@NonNull String key |
The key for referencing this value |
@Nullable String value |
The String value to store |
| Returns | |
|---|---|
@NonNull MediaMetadata.Builder |
The Builder to allow chaining |
public @NonNull MediaMetadata.Builder putText(@NonNull String key, @Nullable 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_COMPILATIONMETADATA_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_URIMETADATA_KEY_MEDIA_IDMETADATA_KEY_MEDIA_URI
| Parameters | |
|---|---|
@NonNull String key |
The key for referencing this value |
@Nullable CharSequence value |
The CharSequence value to store |
| Returns | |
|---|---|
@NonNull MediaMetadata.Builder |
The Builder to allow chaining |