Builder
class Builder
| kotlin.Any | |
| ↳ | android.media.MediaMetadata.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(source: MediaMetadata!)Create a Builder using a |
|
| Public methods | |
|---|---|
| MediaMetadata! |
build()Creates a |
| MediaMetadata.Builder! |
Put a |
| MediaMetadata.Builder! |
Put a long value into the metadata. |
| MediaMetadata.Builder! |
Put a |
| MediaMetadata.Builder! |
Put a String value into the metadata. |
| MediaMetadata.Builder! |
putText(key: String!, value: CharSequence!)Put a CharSequence value into the metadata. |
| MediaMetadata.Builder |
setBitmapDimensionLimit(bitmapDimensionLimit: Int)Sets the maximum width/height (in pixels) for the bitmaps in the metadata. |
Public constructors
Builder
Builder()
Create an empty Builder. Any field that should be included in the MediaMetadata must be added.
Builder
Builder(source: MediaMetadata!)
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 | |
|---|---|
source |
MediaMetadata!: |
Public methods
build
fun build(): MediaMetadata!
Creates a MediaMetadata instance with the specified fields.
| Return | |
|---|---|
MediaMetadata! |
The new MediaMetadata instance |
putBitmap
fun putBitmap(
key: String!,
value: Bitmap!
): MediaMetadata.Builder!
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 with Builder#setBitmapDimensionLimit(int) when MediaSession#setMetadata is called. To pass full resolution images Uris should be used with putString.
| Parameters | |
|---|---|
key |
String!: The key for referencing this value Value is android.media.MediaMetadata#METADATA_KEY_ART, android.media.MediaMetadata#METADATA_KEY_ALBUM_ART, or android.media.MediaMetadata#METADATA_KEY_DISPLAY_ICON |
value |
Bitmap!: The Bitmap to store |
| Return | |
|---|---|
MediaMetadata.Builder! |
The Builder to allow chaining |
putLong
fun putLong(
key: String!,
value: Long
): MediaMetadata.Builder!
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_YEAR
| Parameters | |
|---|---|
key |
String!: The key for referencing this value Value is android.media.MediaMetadata#METADATA_KEY_DURATION, android.media.MediaMetadata#METADATA_KEY_YEAR, android.media.MediaMetadata#METADATA_KEY_TRACK_NUMBER, android.media.MediaMetadata#METADATA_KEY_NUM_TRACKS, android.media.MediaMetadata#METADATA_KEY_DISC_NUMBER, or android.media.MediaMetadata#METADATA_KEY_BT_FOLDER_TYPE |
value |
Long: The long value to store |
| Return | |
|---|---|
MediaMetadata.Builder! |
The Builder to allow chaining |
putRating
fun putRating(
key: String!,
value: Rating!
): MediaMetadata.Builder!
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 is android.media.MediaMetadata#METADATA_KEY_USER_RATING, or android.media.MediaMetadata#METADATA_KEY_RATING |
value |
Rating!: The Rating value to store |
| Return | |
|---|---|
MediaMetadata.Builder! |
The Builder to allow chaining |
putString
fun putString(
key: String!,
value: String!
): MediaMetadata.Builder!
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 ContentResolver#EXTRA_SIZE for retrieving scaled artwork through ContentResolver#openTypedAssetFileDescriptor(Uri,.
| Return | |
|---|---|
MediaMetadata.Builder! |
The Builder to allow chaining |
putText
fun putText(
key: String!,
value: CharSequence!
): MediaMetadata.Builder!
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
| Return | |
|---|---|
MediaMetadata.Builder! |
The Builder to allow chaining |
setBitmapDimensionLimit
fun setBitmapDimensionLimit(bitmapDimensionLimit: Int): MediaMetadata.Builder
Sets the maximum width/height (in pixels) for the bitmaps in the metadata. Bitmaps will be replaced with scaled down copies if their width (or height) is larger than bitmapDimensionLimit.
In order to unset the limit, pass Integer#MAX_VALUE as bitmapDimensionLimit.
| Parameters | |
|---|---|
bitmapDimensionLimit |
Int: The maximum width/height (in pixels) for bitmaps contained in the metadata. Non-positive values are ignored. Pass Integer#MAX_VALUE to unset the limit. Value is 1 or greater |
| Return | |
|---|---|
MediaMetadata.Builder |
This value cannot be null. |