# MediaMetadataCompat.Builder

Artifact: [androidx.media:media](https://developer.android.com/jetpack/androidx/releases/media) [View Source](https://cs.android.com/search?q=file:android/support/v4/media/MediaMetadataCompat.java+class:android.support.v4.media.MediaMetadataCompat.Builder) Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/media#1.1.0) Deprecated in [1.8.0](https://developer.android.com/jetpack/androidx/releases/media#1.8.0)

*** ** * ** ***


```
public final class MediaMetadataCompat.Builder
```

<br />

*** ** * ** ***

> [!CAUTION]
> **This class is deprecated.**   
>
> androidx.media is deprecated. Please migrate to [androidx.media3](https://developer.android.com/media/media3).

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

## Summary

| ### Public constructors |
|---|
| `[Builder](https://developer.android.com/reference/android/support/v4/media/MediaMetadataCompat.Builder#Builder())()` **This method is deprecated.** Deprecated in Java |
| `[Builder](https://developer.android.com/reference/android/support/v4/media/MediaMetadataCompat.Builder#Builder(android.support.v4.media.MediaMetadataCompat))(https://developer.android.com/reference/android/support/v4/media/MediaMetadataCompat source)` **This method is deprecated.** Deprecated in Java |

| ### Public methods |
|---|---|
| `https://developer.android.com/reference/android/support/v4/media/MediaMetadataCompat` | `[build](https://developer.android.com/reference/android/support/v4/media/MediaMetadataCompat.Builder#build())()` **This method is deprecated.** Deprecated in Java |
| `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))(https://developer.android.com/reference/java/lang/String.html key, https://developer.android.com/reference/android/graphics/Bitmap.html value)` **This method is deprecated.** Deprecated in Java |
| `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))(https://developer.android.com/reference/java/lang/String.html key, long value)` **This method is deprecated.** Deprecated in Java |
| `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))(https://developer.android.com/reference/java/lang/String.html key, https://developer.android.com/reference/android/support/v4/media/RatingCompat value)` **This method is deprecated.** Deprecated in Java |
| `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))(https://developer.android.com/reference/java/lang/String.html key, https://developer.android.com/reference/java/lang/String.html value)` **This method is deprecated.** Deprecated in Java |
| `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))(https://developer.android.com/reference/java/lang/String.html key, https://developer.android.com/reference/java/lang/CharSequence.html value)` **This method is deprecated.** Deprecated in Java |

## Public constructors

### Builder

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/media#1.1.0) Deprecated in [1.8.0](https://developer.android.com/jetpack/androidx/releases/media#1.8.0)

```
public [Builder](https://developer.android.com/reference/android/support/v4/media/MediaMetadataCompat.Builder#Builder())()
```

> [!CAUTION]
> **This method is deprecated.**   
> Deprecated in Java

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

### Builder

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/media#1.1.0) Deprecated in [1.8.0](https://developer.android.com/jetpack/androidx/releases/media#1.8.0)

```
public [Builder](https://developer.android.com/reference/android/support/v4/media/MediaMetadataCompat.Builder#Builder(android.support.v4.media.MediaMetadataCompat))(MediaMetadataCompat source)
```

> [!CAUTION]
> **This method is deprecated.**   
> Deprecated in Java

Create a Builder using a `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.

| Parameters |
|---|---|
| `https://developer.android.com/reference/android/support/v4/media/MediaMetadataCompat source` |   |

## Public methods

### build

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/media#1.1.0) Deprecated in [1.8.0](https://developer.android.com/jetpack/androidx/releases/media#1.8.0)

```
public MediaMetadataCompat [build](https://developer.android.com/reference/android/support/v4/media/MediaMetadataCompat.Builder#build())()
```

> [!CAUTION]
> **This method is deprecated.**   
> Deprecated in Java

Creates a `https://developer.android.com/reference/android/support/v4/media/MediaMetadataCompat` instance with the specified fields.

| Returns |
|---|---|
| `https://developer.android.com/reference/android/support/v4/media/MediaMetadataCompat` | The new MediaMetadata instance |

### putBitmap

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/media#1.1.0) Deprecated in [1.8.0](https://developer.android.com/jetpack/androidx/releases/media#1.8.0)

```
public MediaMetadataCompat.Builder [putBitmap](https://developer.android.com/reference/android/support/v4/media/MediaMetadataCompat.Builder#putBitmap(java.lang.String,android.graphics.Bitmap))(String key, Bitmap value)
```

> [!CAUTION]
> **This method is deprecated.**   
> Deprecated in Java

Put a `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:

- `https://developer.android.com/reference/android/support/v4/media/MediaMetadataCompat#METADATA_KEY_ART()`
- `https://developer.android.com/reference/android/support/v4/media/MediaMetadataCompat#METADATA_KEY_ALBUM_ART()`
- `https://developer.android.com/reference/android/support/v4/media/MediaMetadataCompat#METADATA_KEY_DISPLAY_ICON()`

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

| Parameters |
|---|---|
| `https://developer.android.com/reference/java/lang/String.html key` | The key for referencing this value |
| `https://developer.android.com/reference/android/graphics/Bitmap.html value` | The Bitmap to store |

| Returns |
|---|---|
| `https://developer.android.com/reference/android/support/v4/media/MediaMetadataCompat.Builder` | The Builder to allow chaining |

### putLong

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/media#1.1.0) Deprecated in [1.8.0](https://developer.android.com/jetpack/androidx/releases/media#1.8.0)

```
public MediaMetadataCompat.Builder [putLong](https://developer.android.com/reference/android/support/v4/media/MediaMetadataCompat.Builder#putLong(java.lang.String,long))(String key, long value)
```

> [!CAUTION]
> **This method is deprecated.**   
> Deprecated in Java

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:

- `https://developer.android.com/reference/android/support/v4/media/MediaMetadataCompat#METADATA_KEY_DURATION()`
- `https://developer.android.com/reference/android/support/v4/media/MediaMetadataCompat#METADATA_KEY_TRACK_NUMBER()`
- `https://developer.android.com/reference/android/support/v4/media/MediaMetadataCompat#METADATA_KEY_NUM_TRACKS()`
- `https://developer.android.com/reference/android/support/v4/media/MediaMetadataCompat#METADATA_KEY_DISC_NUMBER()`
- `https://developer.android.com/reference/android/support/v4/media/MediaMetadataCompat#METADATA_KEY_YEAR()`
- `https://developer.android.com/reference/android/support/v4/media/MediaMetadataCompat#METADATA_KEY_BT_FOLDER_TYPE()`
- `https://developer.android.com/reference/android/support/v4/media/MediaMetadataCompat#METADATA_KEY_ADVERTISEMENT()`
- `https://developer.android.com/reference/android/support/v4/media/MediaMetadataCompat#METADATA_KEY_DOWNLOAD_STATUS()`

| Parameters |
|---|---|
| `https://developer.android.com/reference/java/lang/String.html key` | The key for referencing this value |
| `long value` | The String value to store |

| Returns |
|---|---|
| `https://developer.android.com/reference/android/support/v4/media/MediaMetadataCompat.Builder` | The Builder to allow chaining |

### putRating

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/media#1.1.0) Deprecated in [1.8.0](https://developer.android.com/jetpack/androidx/releases/media#1.8.0)

```
public 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 value)
```

> [!CAUTION]
> **This method is deprecated.**   
> Deprecated in Java

Put a `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:

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

| Parameters |
|---|---|
| `https://developer.android.com/reference/java/lang/String.html key` | The key for referencing this value |
| `https://developer.android.com/reference/android/support/v4/media/RatingCompat value` | The String value to store |

| Returns |
|---|---|
| `https://developer.android.com/reference/android/support/v4/media/MediaMetadataCompat.Builder` | The Builder to allow chaining |

### putString

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/media#1.1.0) Deprecated in [1.8.0](https://developer.android.com/jetpack/androidx/releases/media#1.8.0)

```
public 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)
```

> [!CAUTION]
> **This method is deprecated.**   
> Deprecated in Java

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:

- `https://developer.android.com/reference/android/support/v4/media/MediaMetadataCompat#METADATA_KEY_TITLE()`
- `https://developer.android.com/reference/android/support/v4/media/MediaMetadataCompat#METADATA_KEY_ARTIST()`
- `https://developer.android.com/reference/android/support/v4/media/MediaMetadataCompat#METADATA_KEY_ALBUM()`
- `https://developer.android.com/reference/android/support/v4/media/MediaMetadataCompat#METADATA_KEY_AUTHOR()`
- `https://developer.android.com/reference/android/support/v4/media/MediaMetadataCompat#METADATA_KEY_WRITER()`
- `https://developer.android.com/reference/android/support/v4/media/MediaMetadataCompat#METADATA_KEY_COMPOSER()`
- `https://developer.android.com/reference/android/support/v4/media/MediaMetadataCompat#METADATA_KEY_DATE()`
- `https://developer.android.com/reference/android/support/v4/media/MediaMetadataCompat#METADATA_KEY_GENRE()`
- `https://developer.android.com/reference/android/support/v4/media/MediaMetadataCompat#METADATA_KEY_ALBUM_ARTIST()`
- `https://developer.android.com/reference/android/support/v4/media/MediaMetadataCompat#METADATA_KEY_ART_URI()`
- `https://developer.android.com/reference/android/support/v4/media/MediaMetadataCompat#METADATA_KEY_ALBUM_ART_URI()`
- `https://developer.android.com/reference/android/support/v4/media/MediaMetadataCompat#METADATA_KEY_DISPLAY_TITLE()`
- `https://developer.android.com/reference/android/support/v4/media/MediaMetadataCompat#METADATA_KEY_DISPLAY_SUBTITLE()`
- `https://developer.android.com/reference/android/support/v4/media/MediaMetadataCompat#METADATA_KEY_DISPLAY_DESCRIPTION()`
- `https://developer.android.com/reference/android/support/v4/media/MediaMetadataCompat#METADATA_KEY_DISPLAY_ICON_URI()`

| Parameters |
|---|---|
| `https://developer.android.com/reference/java/lang/String.html key` | The key for referencing this value |
| `https://developer.android.com/reference/java/lang/String.html value` | The String value to store |

| Returns |
|---|---|
| `https://developer.android.com/reference/android/support/v4/media/MediaMetadataCompat.Builder` | The Builder to allow chaining |

### putText

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/media#1.1.0) Deprecated in [1.8.0](https://developer.android.com/jetpack/androidx/releases/media#1.8.0)

```
public 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)
```

> [!CAUTION]
> **This method is deprecated.**   
> Deprecated in Java

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:

- `https://developer.android.com/reference/android/support/v4/media/MediaMetadataCompat#METADATA_KEY_TITLE()`
- `https://developer.android.com/reference/android/support/v4/media/MediaMetadataCompat#METADATA_KEY_ARTIST()`
- `https://developer.android.com/reference/android/support/v4/media/MediaMetadataCompat#METADATA_KEY_ALBUM()`
- `https://developer.android.com/reference/android/support/v4/media/MediaMetadataCompat#METADATA_KEY_AUTHOR()`
- `https://developer.android.com/reference/android/support/v4/media/MediaMetadataCompat#METADATA_KEY_WRITER()`
- `https://developer.android.com/reference/android/support/v4/media/MediaMetadataCompat#METADATA_KEY_COMPOSER()`
- `https://developer.android.com/reference/android/support/v4/media/MediaMetadataCompat#METADATA_KEY_DATE()`
- `https://developer.android.com/reference/android/support/v4/media/MediaMetadataCompat#METADATA_KEY_GENRE()`
- `https://developer.android.com/reference/android/support/v4/media/MediaMetadataCompat#METADATA_KEY_ALBUM_ARTIST()`
- `https://developer.android.com/reference/android/support/v4/media/MediaMetadataCompat#METADATA_KEY_ART_URI()`
- `https://developer.android.com/reference/android/support/v4/media/MediaMetadataCompat#METADATA_KEY_ALBUM_ART_URI()`
- `https://developer.android.com/reference/android/support/v4/media/MediaMetadataCompat#METADATA_KEY_DISPLAY_TITLE()`
- `https://developer.android.com/reference/android/support/v4/media/MediaMetadataCompat#METADATA_KEY_DISPLAY_SUBTITLE()`
- `https://developer.android.com/reference/android/support/v4/media/MediaMetadataCompat#METADATA_KEY_DISPLAY_DESCRIPTION()`
- `https://developer.android.com/reference/android/support/v4/media/MediaMetadataCompat#METADATA_KEY_DISPLAY_ICON_URI()`

| Parameters |
|---|---|
| `https://developer.android.com/reference/java/lang/String.html key` | The key for referencing this value |
| `https://developer.android.com/reference/java/lang/CharSequence.html value` | The CharSequence value to store |

| Returns |
|---|---|
| `https://developer.android.com/reference/android/support/v4/media/MediaMetadataCompat.Builder` | The Builder to allow chaining |