# MediaMetadataCompat.Builder

added in[version 22.1.0](https://developer.android.com/topic/libraries/support-library/revisions)  
belongs to Maven artifact com.android.support:support-media-compat:28.0.0-alpha1  
Summary:[Ctors](https://developer.android.com/reference/android/support/v4-media/MediaDescriptionCompat.Builder#pubctors)\|[Methods](https://developer.android.com/reference/android/support/v4-media/MediaDescriptionCompat.Builder#pubmethods)\|[Inherited Methods](https://developer.android.com/reference/android/support/v4-media/MediaDescriptionCompat.Builder#inhmethods)\|[\[Expand All\]](https://developer.android.com/reference/android/support/v4-media/MediaDescriptionCompat.Builder#)  

# MediaMetadataCompat.Builder

| This package is part of the Android[support library](https://developer.android.com/topic/libraries/support-library)which is no longer maintained. The support library has been superseded by[AndroidX](https://developer.android.com/jetpack/androidx)which is part of[Jetpack](https://developer.android.com/jetpack). We recommend using the AndroidX libraries in all new projects. You should also consider[migrating](https://developer.android.com/jetpack/androidx/migrate)existing projects to AndroidX. To find the AndroidX class that maps to this deprecated class, see the AndroidX support library[class mappings](https://developer.android.com/jetpack/androidx/migrate/class-mappings).

`
public
static
final

class
MediaMetadataCompat.Builder
`  
`

extends Object


``


`

|---|------------------------------------------------------|
| java.lang.Object                                        ||
| ↳ | android.support.v4.media.MediaMetadataCompat.Builder |

<br />

*** ** * ** ***

Use to build MediaMetadata objects. The system defined metadata keys must use the appropriate data type.

## Summary

|                                                                                                                                                                                                                                           ### Public constructors                                                                                                                                                                                                                                           ||
|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|
| ` `[MediaMetadataCompat.Builder](https://developer.android.com/reference/android/support/v4/media/MediaMetadataCompat.Builder#MediaMetadataCompat.Builder())`() ` Create an empty Builder.                                                                                                                                                                                                                                                                                                               |
| ` `[MediaMetadataCompat.Builder](https://developer.android.com/reference/android/support/v4/media/MediaMetadataCompat.Builder#MediaMetadataCompat.Builder(android.support.v4.media.MediaMetadataCompat))`(`[MediaMetadataCompat](https://developer.android.com/reference/android/support/v4/media/MediaMetadataCompat)` source) ` Create a Builder using a[MediaMetadataCompat](https://developer.android.com/reference/android/support/v4/media/MediaMetadataCompat)instance to set the initial values. |

|                                                                                                                                                                                                                                                                     ### Public methods                                                                                                                                                                                                                                                                     ||
|--------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| ` `[MediaMetadataCompat](https://developer.android.com/reference/android/support/v4/media/MediaMetadataCompat)                 | ` `[build](https://developer.android.com/reference/android/support/v4/media/MediaMetadataCompat.Builder#build())`() ` Creates a[MediaMetadataCompat](https://developer.android.com/reference/android/support/v4/media/MediaMetadataCompat)instance with the specified fields.                                                                                                                                              |
| ` `[MediaMetadataCompat.Builder](https://developer.android.com/reference/android/support/v4/media/MediaMetadataCompat.Builder) | ` `[putBitmap](https://developer.android.com/reference/android/support/v4/media/MediaMetadataCompat.Builder#putBitmap(java.lang.String, android.graphics.Bitmap))`(String key, `[Bitmap](https://developer.android.com/reference/android/graphics/Bitmap.html)` value) ` Put a[Bitmap](https://developer.android.com/reference/android/graphics/Bitmap.html)into the metadata.                                             |
| ` `[MediaMetadataCompat.Builder](https://developer.android.com/reference/android/support/v4/media/MediaMetadataCompat.Builder) | ` `[putLong](https://developer.android.com/reference/android/support/v4/media/MediaMetadataCompat.Builder#putLong(java.lang.String, long))`(String key, long value) ` Put a long value into the metadata.                                                                                                                                                                                                                  |
| ` `[MediaMetadataCompat.Builder](https://developer.android.com/reference/android/support/v4/media/MediaMetadataCompat.Builder) | ` `[putRating](https://developer.android.com/reference/android/support/v4/media/MediaMetadataCompat.Builder#putRating(java.lang.String, android.support.v4.media.RatingCompat))`(String key, `[RatingCompat](https://developer.android.com/reference/android/support/v4/media/RatingCompat)` value) ` Put a[RatingCompat](https://developer.android.com/reference/android/support/v4/media/RatingCompat)into the metadata. |
| ` `[MediaMetadataCompat.Builder](https://developer.android.com/reference/android/support/v4/media/MediaMetadataCompat.Builder) | ` `[putString](https://developer.android.com/reference/android/support/v4/media/MediaMetadataCompat.Builder#putString(java.lang.String, java.lang.String))`(String key, String value) ` Put a String value into the metadata.                                                                                                                                                                                              |
| ` `[MediaMetadataCompat.Builder](https://developer.android.com/reference/android/support/v4/media/MediaMetadataCompat.Builder) | ` `[putText](https://developer.android.com/reference/android/support/v4/media/MediaMetadataCompat.Builder#putText(java.lang.String, java.lang.CharSequence))`(String key, CharSequence value) ` Put a CharSequence value into the metadata.                                                                                                                                                                                |

| ### Inherited methods |
|-----------------------|---|
| [![](https://developer.android.com/static/assets/images/styles/disclosure_down.png)](https://developer.android.com/reference/android/support/v4-media/MediaDescriptionCompat.Builder#)From class` java.lang.Object ` |-------------------|-------------------------------| | ` Object`         | ` clone() `                   | | ` boolean`        | ` equals(Object arg0) `       | | ` void`           | ` finalize() `                | | ` final Class<?>` | ` getClass() `                | | ` int`            | ` hashCode() `                | | ` final void`     | ` notify() `                  | | ` final void`     | ` notifyAll() `               | | ` String`         | ` toString() `                | | ` final void`     | ` wait(long arg0, int arg1) ` | | ` final void`     | ` wait(long arg0) `           | | ` final void`     | ` wait() `                    | ||

## Public constructors

### MediaMetadataCompat.Builder

added in[version 22.1.0](https://developer.android.com/topic/libraries/support-library/revisions)  

```
MediaMetadataCompat.Builder ()
```

Create an empty Builder. Any field that should be included in the[MediaMetadataCompat](https://developer.android.com/reference/android/support/v4/media/MediaMetadataCompat)must be added.

<br />

### MediaMetadataCompat.Builder

added in[version 22.1.0](https://developer.android.com/topic/libraries/support-library/revisions)  

```
MediaMetadataCompat.Builder (MediaMetadataCompat source)
```

Create a Builder using a[MediaMetadataCompat](https://developer.android.com/reference/android/support/v4/media/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.

<br />

## Public methods

### build

added in[version 22.1.0](https://developer.android.com/topic/libraries/support-library/revisions)  

```
MediaMetadataCompat build ()
```

Creates a[MediaMetadataCompat](https://developer.android.com/reference/android/support/v4/media/MediaMetadataCompat)instance with the specified fields.

<br />

|                                                                      Returns                                                                       ||
|-------------------------------------------------------------------------------------------------------------|---------------------------------------|
| [MediaMetadataCompat](https://developer.android.com/reference/android/support/v4/media/MediaMetadataCompat) | The new MediaMetadata instance <br /> |

### putBitmap

added in[version 22.1.0](https://developer.android.com/topic/libraries/support-library/revisions)  

```
MediaMetadataCompat.Builder putBitmap (String key,
                Bitmap value)
```

Put a[Bitmap](https://developer.android.com/reference/android/graphics/Bitmap.html)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_ART](https://developer.android.com/reference/android/support/v4/media/MediaMetadataCompat#METADATA_KEY_ART)
- [METADATA_KEY_ALBUM_ART](https://developer.android.com/reference/android/support/v4/media/MediaMetadataCompat#METADATA_KEY_ALBUM_ART)
- [METADATA_KEY_DISPLAY_ICON](https://developer.android.com/reference/android/support/v4/media/MediaMetadataCompat#METADATA_KEY_DISPLAY_ICON)

Large bitmaps may be scaled down when[setMetadata(MediaMetadataCompat)](https://developer.android.com/reference/android/support/v4/media/session/MediaSessionCompat#setMetadata(android.support.v4.media.MediaMetadataCompat))is called. To pass full resolution images[Uris](https://developer.android.com/reference/android/net/Uri.html)should be used with[putString(String, String)](https://developer.android.com/reference/android/support/v4/media/MediaMetadataCompat.Builder#putString(java.lang.String, java.lang.String)).

<br />

<br />

|                          Parameters                          ||
|---------|-----------------------------------------------------|
| `key`   | `String`: The key for referencing this value <br /> |
| `value` | `Bitmap`: The Bitmap to store <br />                |

|                                                                              Returns                                                                              ||
|-----------------------------------------------------------------------------------------------------------------------------|--------------------------------------|
| [MediaMetadataCompat.Builder](https://developer.android.com/reference/android/support/v4/media/MediaMetadataCompat.Builder) | The Builder to allow chaining <br /> |

### putLong

added in[version 22.1.0](https://developer.android.com/topic/libraries/support-library/revisions)  

```
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_DURATION](https://developer.android.com/reference/android/support/v4/media/MediaMetadataCompat#METADATA_KEY_DURATION)
- [METADATA_KEY_TRACK_NUMBER](https://developer.android.com/reference/android/support/v4/media/MediaMetadataCompat#METADATA_KEY_TRACK_NUMBER)
- [METADATA_KEY_NUM_TRACKS](https://developer.android.com/reference/android/support/v4/media/MediaMetadataCompat#METADATA_KEY_NUM_TRACKS)
- [METADATA_KEY_DISC_NUMBER](https://developer.android.com/reference/android/support/v4/media/MediaMetadataCompat#METADATA_KEY_DISC_NUMBER)
- [METADATA_KEY_YEAR](https://developer.android.com/reference/android/support/v4/media/MediaMetadataCompat#METADATA_KEY_YEAR)
- [METADATA_KEY_BT_FOLDER_TYPE](https://developer.android.com/reference/android/support/v4/media/MediaMetadataCompat#METADATA_KEY_BT_FOLDER_TYPE)
- [METADATA_KEY_ADVERTISEMENT](https://developer.android.com/reference/android/support/v4/media/MediaMetadataCompat#METADATA_KEY_ADVERTISEMENT)
- [METADATA_KEY_DOWNLOAD_STATUS](https://developer.android.com/reference/android/support/v4/media/MediaMetadataCompat#METADATA_KEY_DOWNLOAD_STATUS)

<br />

<br />

|                          Parameters                          ||
|---------|-----------------------------------------------------|
| `key`   | `String`: The key for referencing this value <br /> |
| `value` | `long`: The String value to store <br />            |

|                                                                              Returns                                                                              ||
|-----------------------------------------------------------------------------------------------------------------------------|--------------------------------------|
| [MediaMetadataCompat.Builder](https://developer.android.com/reference/android/support/v4/media/MediaMetadataCompat.Builder) | The Builder to allow chaining <br /> |

### putRating

added in[version 22.1.0](https://developer.android.com/topic/libraries/support-library/revisions)  

```
MediaMetadataCompat.Builder putRating (String key,
                RatingCompat value)
```

Put a[RatingCompat](https://developer.android.com/reference/android/support/v4/media/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:

- [METADATA_KEY_RATING](https://developer.android.com/reference/android/support/v4/media/MediaMetadataCompat#METADATA_KEY_RATING)
- [METADATA_KEY_USER_RATING](https://developer.android.com/reference/android/support/v4/media/MediaMetadataCompat#METADATA_KEY_USER_RATING)

<br />

<br />

|                          Parameters                          ||
|---------|-----------------------------------------------------|
| `key`   | `String`: The key for referencing this value <br /> |
| `value` | `RatingCompat`: The String value to store <br />    |

|                                                                              Returns                                                                              ||
|-----------------------------------------------------------------------------------------------------------------------------|--------------------------------------|
| [MediaMetadataCompat.Builder](https://developer.android.com/reference/android/support/v4/media/MediaMetadataCompat.Builder) | The Builder to allow chaining <br /> |

### putString

added in[version 22.1.0](https://developer.android.com/topic/libraries/support-library/revisions)  

```
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_TITLE](https://developer.android.com/reference/android/support/v4/media/MediaMetadataCompat#METADATA_KEY_TITLE)
- [METADATA_KEY_ARTIST](https://developer.android.com/reference/android/support/v4/media/MediaMetadataCompat#METADATA_KEY_ARTIST)
- [METADATA_KEY_ALBUM](https://developer.android.com/reference/android/support/v4/media/MediaMetadataCompat#METADATA_KEY_ALBUM)
- [METADATA_KEY_AUTHOR](https://developer.android.com/reference/android/support/v4/media/MediaMetadataCompat#METADATA_KEY_AUTHOR)
- [METADATA_KEY_WRITER](https://developer.android.com/reference/android/support/v4/media/MediaMetadataCompat#METADATA_KEY_WRITER)
- [METADATA_KEY_COMPOSER](https://developer.android.com/reference/android/support/v4/media/MediaMetadataCompat#METADATA_KEY_COMPOSER)
- [METADATA_KEY_DATE](https://developer.android.com/reference/android/support/v4/media/MediaMetadataCompat#METADATA_KEY_DATE)
- [METADATA_KEY_GENRE](https://developer.android.com/reference/android/support/v4/media/MediaMetadataCompat#METADATA_KEY_GENRE)
- [METADATA_KEY_ALBUM_ARTIST](https://developer.android.com/reference/android/support/v4/media/MediaMetadataCompat#METADATA_KEY_ALBUM_ARTIST)
- [METADATA_KEY_ART_URI](https://developer.android.com/reference/android/support/v4/media/MediaMetadataCompat#METADATA_KEY_ART_URI)
- [METADATA_KEY_ALBUM_ART_URI](https://developer.android.com/reference/android/support/v4/media/MediaMetadataCompat#METADATA_KEY_ALBUM_ART_URI)
- [METADATA_KEY_DISPLAY_TITLE](https://developer.android.com/reference/android/support/v4/media/MediaMetadataCompat#METADATA_KEY_DISPLAY_TITLE)
- [METADATA_KEY_DISPLAY_SUBTITLE](https://developer.android.com/reference/android/support/v4/media/MediaMetadataCompat#METADATA_KEY_DISPLAY_SUBTITLE)
- [METADATA_KEY_DISPLAY_DESCRIPTION](https://developer.android.com/reference/android/support/v4/media/MediaMetadataCompat#METADATA_KEY_DISPLAY_DESCRIPTION)
- [METADATA_KEY_DISPLAY_ICON_URI](https://developer.android.com/reference/android/support/v4/media/MediaMetadataCompat#METADATA_KEY_DISPLAY_ICON_URI)

<br />

<br />

|                          Parameters                          ||
|---------|-----------------------------------------------------|
| `key`   | `String`: The key for referencing this value <br /> |
| `value` | `String`: The String value to store <br />          |

|                                                                              Returns                                                                              ||
|-----------------------------------------------------------------------------------------------------------------------------|--------------------------------------|
| [MediaMetadataCompat.Builder](https://developer.android.com/reference/android/support/v4/media/MediaMetadataCompat.Builder) | The Builder to allow chaining <br /> |

### putText

added in[version 22.1.0](https://developer.android.com/topic/libraries/support-library/revisions)  

```
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_TITLE](https://developer.android.com/reference/android/support/v4/media/MediaMetadataCompat#METADATA_KEY_TITLE)
- [METADATA_KEY_ARTIST](https://developer.android.com/reference/android/support/v4/media/MediaMetadataCompat#METADATA_KEY_ARTIST)
- [METADATA_KEY_ALBUM](https://developer.android.com/reference/android/support/v4/media/MediaMetadataCompat#METADATA_KEY_ALBUM)
- [METADATA_KEY_AUTHOR](https://developer.android.com/reference/android/support/v4/media/MediaMetadataCompat#METADATA_KEY_AUTHOR)
- [METADATA_KEY_WRITER](https://developer.android.com/reference/android/support/v4/media/MediaMetadataCompat#METADATA_KEY_WRITER)
- [METADATA_KEY_COMPOSER](https://developer.android.com/reference/android/support/v4/media/MediaMetadataCompat#METADATA_KEY_COMPOSER)
- [METADATA_KEY_DATE](https://developer.android.com/reference/android/support/v4/media/MediaMetadataCompat#METADATA_KEY_DATE)
- [METADATA_KEY_GENRE](https://developer.android.com/reference/android/support/v4/media/MediaMetadataCompat#METADATA_KEY_GENRE)
- [METADATA_KEY_ALBUM_ARTIST](https://developer.android.com/reference/android/support/v4/media/MediaMetadataCompat#METADATA_KEY_ALBUM_ARTIST)
- [METADATA_KEY_ART_URI](https://developer.android.com/reference/android/support/v4/media/MediaMetadataCompat#METADATA_KEY_ART_URI)
- [METADATA_KEY_ALBUM_ART_URI](https://developer.android.com/reference/android/support/v4/media/MediaMetadataCompat#METADATA_KEY_ALBUM_ART_URI)
- [METADATA_KEY_DISPLAY_TITLE](https://developer.android.com/reference/android/support/v4/media/MediaMetadataCompat#METADATA_KEY_DISPLAY_TITLE)
- [METADATA_KEY_DISPLAY_SUBTITLE](https://developer.android.com/reference/android/support/v4/media/MediaMetadataCompat#METADATA_KEY_DISPLAY_SUBTITLE)
- [METADATA_KEY_DISPLAY_DESCRIPTION](https://developer.android.com/reference/android/support/v4/media/MediaMetadataCompat#METADATA_KEY_DISPLAY_DESCRIPTION)
- [METADATA_KEY_DISPLAY_ICON_URI](https://developer.android.com/reference/android/support/v4/media/MediaMetadataCompat#METADATA_KEY_DISPLAY_ICON_URI)

<br />

<br />

|                           Parameters                            ||
|---------|--------------------------------------------------------|
| `key`   | `String`: The key for referencing this value <br />    |
| `value` | `CharSequence`: The CharSequence value to store <br /> |

|                                                                              Returns                                                                              ||
|-----------------------------------------------------------------------------------------------------------------------------|--------------------------------------|
| [MediaMetadataCompat.Builder](https://developer.android.com/reference/android/support/v4/media/MediaMetadataCompat.Builder) | The Builder to allow chaining <br /> |

-

  ## Classes

  - [AudioAttributesCompat](https://developer.android.com/reference/android/support/v4/media/AudioAttributesCompat)
  - [AudioAttributesCompat.Builder](https://developer.android.com/reference/android/support/v4/media/AudioAttributesCompat.Builder)
  - [MediaBrowserCompat](https://developer.android.com/reference/android/support/v4/media/MediaBrowserCompat)
  - [MediaBrowserCompat.ConnectionCallback](https://developer.android.com/reference/android/support/v4/media/MediaBrowserCompat.ConnectionCallback)
  - [MediaBrowserCompat.CustomActionCallback](https://developer.android.com/reference/android/support/v4/media/MediaBrowserCompat.CustomActionCallback)
  - [MediaBrowserCompat.ItemCallback](https://developer.android.com/reference/android/support/v4/media/MediaBrowserCompat.ItemCallback)
  - [MediaBrowserCompat.MediaItem](https://developer.android.com/reference/android/support/v4/media/MediaBrowserCompat.MediaItem)
  - [MediaBrowserCompat.SearchCallback](https://developer.android.com/reference/android/support/v4/media/MediaBrowserCompat.SearchCallback)
  - [MediaBrowserCompat.SubscriptionCallback](https://developer.android.com/reference/android/support/v4/media/MediaBrowserCompat.SubscriptionCallback)
  - [MediaBrowserServiceCompat](https://developer.android.com/reference/android/support/v4/media/MediaBrowserServiceCompat)
  - [MediaBrowserServiceCompat.BrowserRoot](https://developer.android.com/reference/android/support/v4/media/MediaBrowserServiceCompat.BrowserRoot)
  - [MediaBrowserServiceCompat.Result](https://developer.android.com/reference/android/support/v4/media/MediaBrowserServiceCompat.Result)
  - [MediaDescriptionCompat](https://developer.android.com/reference/android/support/v4/media/MediaDescriptionCompat)
  - [MediaDescriptionCompat.Builder](https://developer.android.com/reference/android/support/v4/media/MediaDescriptionCompat.Builder)
  - [MediaMetadataCompat](https://developer.android.com/reference/android/support/v4/media/MediaMetadataCompat)
  - [MediaMetadataCompat.Builder](https://developer.android.com/reference/android/support/v4/media/MediaMetadataCompat.Builder)
  - [RatingCompat](https://developer.android.com/reference/android/support/v4/media/RatingCompat)
  - [VolumeProviderCompat](https://developer.android.com/reference/android/support/v4/media/VolumeProviderCompat)
  - [VolumeProviderCompat.Callback](https://developer.android.com/reference/android/support/v4/media/VolumeProviderCompat.Callback)