MediaMetadata.Builder
public
static
final
class
MediaMetadata.Builder
extends Object
| java.lang.Object | |
| ↳ | androidx.media2.common.MediaMetadata.Builder |
Use to build MediaMetadatax 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 |
|
Public methods | |
|---|---|
MediaMetadata
|
build()
Creates a |
MediaMetadata.Builder
|
putBitmap(String key, Bitmap value)
Put a |
MediaMetadata.Builder
|
putFloat(String key, float value)
Put a float value 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 |
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. |
MediaMetadata.Builder
|
setExtras(Bundle extras)
Set a bundle of extras. |
Inherited methods | |
|---|---|
Public constructors
MediaMetadata.Builder
public MediaMetadata.Builder ()
Create an empty Builder. Any field that should be included in the
MediaMetadata must be added.
MediaMetadata.Builder
public 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.
Public methods
build
public MediaMetadata build ()
Creates a MediaMetadata instance with the specified fields.
| Returns | |
|---|---|
MediaMetadata |
The new MediaMetadatax instance |
putBitmap
public 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:
MediaMetadata.METADATA_KEY_ARTMediaMetadata.METADATA_KEY_ALBUM_ARTMediaMetadata.METADATA_KEY_DISPLAY_ICON
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 |
putFloat
public MediaMetadata.Builder putFloat (String key, float value)
Put a float value into the metadata. Custom keys may be used.
| Parameters | |
|---|---|
key |
String: The key for referencing this value |
value |
float: The float value to store |
| Returns | |
|---|---|
MediaMetadata.Builder |
The Builder to allow chaining |
putLong
public 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:
MediaMetadata.METADATA_KEY_DURATIONMediaMetadata.METADATA_KEY_TRACK_NUMBERMediaMetadata.METADATA_KEY_NUM_TRACKSMediaMetadata.METADATA_KEY_DISC_NUMBERMediaMetadata.METADATA_KEY_YEARMediaMetadata.METADATA_KEY_BROWSABLEMediaMetadata.METADATA_KEY_PLAYABLEMediaMetadata.METADATA_KEY_ADVERTISEMENTMediaMetadata.METADATA_KEY_DOWNLOAD_STATUS
| Parameters | |
|---|---|
key |
String: The key for referencing this value |
value |
long: The String value to store |
| Returns | |
|---|---|
MediaMetadata.Builder |
The Builder to allow chaining |
putRating
public 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 String value to store |
| Returns | |
|---|---|
MediaMetadata.Builder |
The Builder to allow chaining |
putString
public 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:
MediaMetadata.METADATA_KEY_TITLEMediaMetadata.METADATA_KEY_ARTISTMediaMetadata.METADATA_KEY_ALBUMMediaMetadata.METADATA_KEY_AUTHORMediaMetadata.METADATA_KEY_WRITERMediaMetadata.METADATA_KEY_COMPOSERMediaMetadata.METADATA_KEY_COMPILATIONMediaMetadata.METADATA_KEY_DATEMediaMetadata.METADATA_KEY_GENREMediaMetadata.METADATA_KEY_ALBUM_ARTISTMediaMetadata.METADATA_KEY_ART_URIMediaMetadata.METADATA_KEY_ALBUM_ART_URIMediaMetadata.METADATA_KEY_DISPLAY_TITLEMediaMetadata.METADATA_KEY_DISPLAY_SUBTITLEMediaMetadata.METADATA_KEY_DISPLAY_DESCRIPTIONMediaMetadata.METADATA_KEY_DISPLAY_ICON_URIMediaMetadata.METADATA_KEY_MEDIA_IDMediaMetadata.METADATA_KEY_MEDIA_URI
| Parameters | |
|---|---|
key |
String: The key for referencing this value |
value |
String: The String value to store |
| Returns | |
|---|---|
MediaMetadata.Builder |
The Builder to allow chaining |
putText
public 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:
MediaMetadata.METADATA_KEY_TITLEMediaMetadata.METADATA_KEY_ARTISTMediaMetadata.METADATA_KEY_ALBUMMediaMetadata.METADATA_KEY_AUTHORMediaMetadata.METADATA_KEY_WRITERMediaMetadata.METADATA_KEY_COMPOSERMediaMetadata.METADATA_KEY_COMPILATIONMediaMetadata.METADATA_KEY_DATEMediaMetadata.METADATA_KEY_GENREMediaMetadata.METADATA_KEY_ALBUM_ARTISTMediaMetadata.METADATA_KEY_ART_URIMediaMetadata.METADATA_KEY_ALBUM_ART_URIMediaMetadata.METADATA_KEY_DISPLAY_TITLEMediaMetadata.METADATA_KEY_DISPLAY_SUBTITLEMediaMetadata.METADATA_KEY_DISPLAY_DESCRIPTIONMediaMetadata.METADATA_KEY_DISPLAY_ICON_URIMediaMetadata.METADATA_KEY_MEDIA_IDMediaMetadata.METADATA_KEY_MEDIA_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 |
setExtras
public MediaMetadata.Builder setExtras (Bundle extras)
Set a bundle of extras.
| Parameters | |
|---|---|
extras |
Bundle: The extras to include with this description or null. |
| Returns | |
|---|---|
MediaMetadata.Builder |
The Builder to allow chaining |