# RemoteControlClient.MetadataEditor
Added in [API level 14](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
Deprecated in [API level
21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
Summary: [Constants](https://developer.android.com/reference/android/media/RemoteControlClient.MetadataEditor#constants) \| [Inherited Constants](https://developer.android.com/reference/android/media/RemoteControlClient.MetadataEditor#inhconstants) \| [Methods](https://developer.android.com/reference/android/media/RemoteControlClient.MetadataEditor#pubmethods) \| [Inherited Methods](https://developer.android.com/reference/android/media/RemoteControlClient.MetadataEditor#inhmethods)
# RemoteControlClient.MetadataEditor
*** ** * ** ***
[Kotlin](https://developer.android.com/reference/kotlin/android/media/RemoteControlClient.MetadataEditor "View this page in Kotlin") \|Java
`
public
class
RemoteControlClient.MetadataEditor
`
`
`
`
extends `[MediaMetadataEditor](https://developer.android.com/reference/android/media/MediaMetadataEditor)`
`
`
`
|---|---|--------------------------------------------------|
| [java.lang.Object](https://developer.android.com/reference/java/lang/Object) |||
| ↳ | [android.media.MediaMetadataEditor](https://developer.android.com/reference/android/media/MediaMetadataEditor) ||
| | ↳ | android.media.RemoteControlClient.MetadataEditor |
*** ** * ** ***
**This class was deprecated
in API level 21.**
Use [MediaMetadata](https://developer.android.com/reference/android/media/MediaMetadata) and [MediaSession](https://developer.android.com/reference/android/media/session/MediaSession) instead.
Class used to modify metadata in a [RemoteControlClient](https://developer.android.com/reference/android/media/RemoteControlClient) object.
Use [RemoteControlClient.editMetadata(boolean)](https://developer.android.com/reference/android/media/RemoteControlClient#editMetadata(boolean)) to create an instance of an editor,
on which you set the metadata for the RemoteControlClient instance. Once all the information
has been set, use [apply()](https://developer.android.com/reference/android/media/RemoteControlClient.MetadataEditor#apply()) to make it the new metadata that should be displayed
for the associated client. Once the metadata has been "applied", you cannot reuse this
instance of the MetadataEditor.
## Summary
| ### Constants ||
|-------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `int` | [BITMAP_KEY_ARTWORK](https://developer.android.com/reference/android/media/RemoteControlClient.MetadataEditor#BITMAP_KEY_ARTWORK) The metadata key for the content artwork / album art. |
| ### Inherited constants |
|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| From class [android.media.MediaMetadataEditor](https://developer.android.com/reference/android/media/MediaMetadataEditor) |-------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `int` | [BITMAP_KEY_ARTWORK](https://developer.android.com/reference/android/media/MediaMetadataEditor#BITMAP_KEY_ARTWORK) The metadata key for the content artwork / album art. | | `int` | [RATING_KEY_BY_OTHERS](https://developer.android.com/reference/android/media/MediaMetadataEditor#RATING_KEY_BY_OTHERS) The metadata key for the content's average rating, not the user's rating. | | `int` | [RATING_KEY_BY_USER](https://developer.android.com/reference/android/media/MediaMetadataEditor#RATING_KEY_BY_USER) The metadata key for the content's user rating. | |
| ### Public methods ||
|-----------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| ` void` | ` `[apply](https://developer.android.com/reference/android/media/RemoteControlClient.MetadataEditor#apply())`() ` Associates all the metadata that has been set since the MetadataEditor instance was created with [RemoteControlClient.editMetadata(boolean)](https://developer.android.com/reference/android/media/RemoteControlClient#editMetadata(boolean)), or since [clear()](https://developer.android.com/reference/android/media/RemoteControlClient.MetadataEditor#clear()) was called, with the RemoteControlClient. |
| ` void` | ` `[clear](https://developer.android.com/reference/android/media/RemoteControlClient.MetadataEditor#clear())`() ` Clears all the metadata that has been set since the MetadataEditor instance was created (with [RemoteControlClient.editMetadata(boolean)](https://developer.android.com/reference/android/media/RemoteControlClient#editMetadata(boolean))). |
| ` `[RemoteControlClient.MetadataEditor](https://developer.android.com/reference/android/media/RemoteControlClient.MetadataEditor) | ` `[putBitmap](https://developer.android.com/reference/android/media/RemoteControlClient.MetadataEditor#putBitmap(int,%20android.graphics.Bitmap))`(int key, `[Bitmap](https://developer.android.com/reference/android/graphics/Bitmap)` bitmap) ` Sets the album / artwork picture to be displayed on the remote control. |
| ` `[RemoteControlClient.MetadataEditor](https://developer.android.com/reference/android/media/RemoteControlClient.MetadataEditor) | ` `[putLong](https://developer.android.com/reference/android/media/RemoteControlClient.MetadataEditor#putLong(int,%20long))`(int key, long value) ` Adds numerical information to be displayed. |
| ` `[RemoteControlClient.MetadataEditor](https://developer.android.com/reference/android/media/RemoteControlClient.MetadataEditor) | ` `[putObject](https://developer.android.com/reference/android/media/RemoteControlClient.MetadataEditor#putObject(int,%20java.lang.Object))`(int key, `[Object](https://developer.android.com/reference/java/lang/Object)` object) ` Adds information stored as an instance. |
| ` `[RemoteControlClient.MetadataEditor](https://developer.android.com/reference/android/media/RemoteControlClient.MetadataEditor) | ` `[putString](https://developer.android.com/reference/android/media/RemoteControlClient.MetadataEditor#putString(int,%20java.lang.String))`(int key, `[String](https://developer.android.com/reference/java/lang/String)` value) ` Adds textual information to be displayed. |
| ### Inherited methods |
|-----------------------|---|
| From class ` `[android.media.MediaMetadataEditor](https://developer.android.com/reference/android/media/MediaMetadataEditor)` ` |-----------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | ` void` | ` `[addEditableKey](https://developer.android.com/reference/android/media/MediaMetadataEditor#addEditableKey(int))`(int key) ` Flags the given key as being editable. | | ` abstract void` | ` `[apply](https://developer.android.com/reference/android/media/MediaMetadataEditor#apply())`() ` Applies all of the metadata changes that have been set since the MediaMetadataEditor instance was created or since [clear()](https://developer.android.com/reference/android/media/MediaMetadataEditor#clear()) was called. | | ` void` | ` `[clear](https://developer.android.com/reference/android/media/MediaMetadataEditor#clear())`() ` Clears all the pending metadata changes set since the MediaMetadataEditor instance was created or since this method was last called. | | ` `[Bitmap](https://developer.android.com/reference/android/graphics/Bitmap) | ` `[getBitmap](https://developer.android.com/reference/android/media/MediaMetadataEditor#getBitmap(int,%20android.graphics.Bitmap))`(int key, `[Bitmap](https://developer.android.com/reference/android/graphics/Bitmap)` defaultValue) ` Returns the [Bitmap](https://developer.android.com/reference/android/graphics/Bitmap) value for the key. | | ` int[]` | ` `[getEditableKeys](https://developer.android.com/reference/android/media/MediaMetadataEditor#getEditableKeys())`() ` Retrieves the keys flagged as editable. | | ` long` | ` `[getLong](https://developer.android.com/reference/android/media/MediaMetadataEditor#getLong(int,%20long))`(int key, long defaultValue) ` Returns the long value for the key. | | ` `[Object](https://developer.android.com/reference/java/lang/Object) | ` `[getObject](https://developer.android.com/reference/android/media/MediaMetadataEditor#getObject(int,%20java.lang.Object))`(int key, `[Object](https://developer.android.com/reference/java/lang/Object)` defaultValue) ` Returns an object representation of the value for the key | | ` `[String](https://developer.android.com/reference/java/lang/String) | ` `[getString](https://developer.android.com/reference/android/media/MediaMetadataEditor#getString(int,%20java.lang.String))`(int key, `[String](https://developer.android.com/reference/java/lang/String)` defaultValue) ` Returns the [String](https://developer.android.com/reference/java/lang/String) value for the key. | | ` `[MediaMetadataEditor](https://developer.android.com/reference/android/media/MediaMetadataEditor) | ` `[putBitmap](https://developer.android.com/reference/android/media/MediaMetadataEditor#putBitmap(int,%20android.graphics.Bitmap))`(int key, `[Bitmap](https://developer.android.com/reference/android/graphics/Bitmap)` bitmap) ` Adds image. | | ` `[MediaMetadataEditor](https://developer.android.com/reference/android/media/MediaMetadataEditor) | ` `[putLong](https://developer.android.com/reference/android/media/MediaMetadataEditor#putLong(int,%20long))`(int key, long value) ` Adds numerical information. | | ` `[MediaMetadataEditor](https://developer.android.com/reference/android/media/MediaMetadataEditor) | ` `[putObject](https://developer.android.com/reference/android/media/MediaMetadataEditor#putObject(int,%20java.lang.Object))`(int key, `[Object](https://developer.android.com/reference/java/lang/Object)` value) ` Adds information stored as an instance. | | ` `[MediaMetadataEditor](https://developer.android.com/reference/android/media/MediaMetadataEditor) | ` `[putString](https://developer.android.com/reference/android/media/MediaMetadataEditor#putString(int,%20java.lang.String))`(int key, `[String](https://developer.android.com/reference/java/lang/String)` value) ` Adds textual information. | | ` void` | ` `[removeEditableKeys](https://developer.android.com/reference/android/media/MediaMetadataEditor#removeEditableKeys())`() ` Causes all metadata fields to be read-only. | ||
| From class ` `[java.lang.Object](https://developer.android.com/reference/java/lang/Object)` ` |--------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | ` `[Object](https://developer.android.com/reference/java/lang/Object) | ` `[clone](https://developer.android.com/reference/java/lang/Object#clone())`() ` Creates and returns a copy of this object. | | ` boolean` | ` `[equals](https://developer.android.com/reference/java/lang/Object#equals(java.lang.Object))`(`[Object](https://developer.android.com/reference/java/lang/Object)` obj) ` Indicates whether some other object is "equal to" this one. | | ` void` | ` `[finalize](https://developer.android.com/reference/java/lang/Object#finalize())`() ` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. | | ` final `[Class](https://developer.android.com/reference/java/lang/Class)`` | ` `[getClass](https://developer.android.com/reference/java/lang/Object#getClass())`() ` Returns the runtime class of this `Object`. | | ` int` | ` `[hashCode](https://developer.android.com/reference/java/lang/Object#hashCode())`() ` Returns a hash code value for the object. | | ` final void` | ` `[notify](https://developer.android.com/reference/java/lang/Object#notify())`() ` Wakes up a single thread that is waiting on this object's monitor. | | ` final void` | ` `[notifyAll](https://developer.android.com/reference/java/lang/Object#notifyAll())`() ` Wakes up all threads that are waiting on this object's monitor. | | ` `[String](https://developer.android.com/reference/java/lang/String) | ` `[toString](https://developer.android.com/reference/java/lang/Object#toString())`() ` Returns a string representation of the object. | | ` final void` | ` `[wait](https://developer.android.com/reference/java/lang/Object#wait(long,%20int))`(long timeoutMillis, int nanos) ` Causes the current thread to wait until it is awakened, typically by being *notified* or *interrupted*, or until a certain amount of real time has elapsed. | | ` final void` | ` `[wait](https://developer.android.com/reference/java/lang/Object#wait(long))`(long timeoutMillis) ` Causes the current thread to wait until it is awakened, typically by being *notified* or *interrupted*, or until a certain amount of real time has elapsed. | | ` final void` | ` `[wait](https://developer.android.com/reference/java/lang/Object#wait())`() ` Causes the current thread to wait until it is awakened, typically by being *notified* or *interrupted*. | ||
## Constants
### BITMAP_KEY_ARTWORK
Added in [API level 14](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public static final int BITMAP_KEY_ARTWORK
```
The metadata key for the content artwork / album art.
Constant Value:
100
(0x00000064)
## Public methods
### apply
Added in [API level 14](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public void apply ()
```
Associates all the metadata that has been set since the MetadataEditor instance was
created with [RemoteControlClient.editMetadata(boolean)](https://developer.android.com/reference/android/media/RemoteControlClient#editMetadata(boolean)), or since
[clear()](https://developer.android.com/reference/android/media/RemoteControlClient.MetadataEditor#clear()) was called, with the RemoteControlClient. Once "applied",
this MetadataEditor cannot be reused to edit the RemoteControlClient's metadata.
### clear
Added in [API level 14](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public void clear ()
```
Clears all the metadata that has been set since the MetadataEditor instance was created
(with [RemoteControlClient.editMetadata(boolean)](https://developer.android.com/reference/android/media/RemoteControlClient#editMetadata(boolean))).
Note that clearing the metadata doesn't reset the editable keys
(use [MediaMetadataEditor.removeEditableKeys()](https://developer.android.com/reference/android/media/MediaMetadataEditor#removeEditableKeys()) instead).
### putBitmap
Added in [API level 14](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public RemoteControlClient.MetadataEditor putBitmap (int key,
Bitmap bitmap)
```
Sets the album / artwork picture to be displayed on the remote control.
| Parameters ||
|----------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `key` | `int`: the identifier of the bitmap to set. The only valid value is [BITMAP_KEY_ARTWORK](https://developer.android.com/reference/android/media/RemoteControlClient.MetadataEditor#BITMAP_KEY_ARTWORK)
|
| `bitmap` | `Bitmap`: The bitmap for the artwork, or null if there isn't any.
|
| Returns ||
|--------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------|
| [RemoteControlClient.MetadataEditor](https://developer.android.com/reference/android/media/RemoteControlClient.MetadataEditor) | Returns a reference to the same MetadataEditor object, so you can chain put calls together.
|
| Throws ||
|--------------------------------------------------------------------------------------------------------|------------------------------------|
| | java.lang.IllegalArgumentException |
| [IllegalArgumentException](https://developer.android.com/reference/java/lang/IllegalArgumentException) | |
**See also:**
- [Bitmap](https://developer.android.com/reference/android/graphics/Bitmap)
### putLong
Added in [API level 14](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public RemoteControlClient.MetadataEditor putLong (int key,
long value)
```
Adds numerical information to be displayed.
Note that none of the information added after [apply()](https://developer.android.com/reference/android/media/RemoteControlClient.MetadataEditor#apply()) has been called,
will be displayed.
| Parameters ||
|---------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `key` | `int`: the identifier of a the metadata field to set. Valid values are [MediaMetadataRetriever.METADATA_KEY_CD_TRACK_NUMBER](https://developer.android.com/reference/android/media/MediaMetadataRetriever#METADATA_KEY_CD_TRACK_NUMBER), [MediaMetadataRetriever.METADATA_KEY_DISC_NUMBER](https://developer.android.com/reference/android/media/MediaMetadataRetriever#METADATA_KEY_DISC_NUMBER), [MediaMetadataRetriever.METADATA_KEY_DURATION](https://developer.android.com/reference/android/media/MediaMetadataRetriever#METADATA_KEY_DURATION) (with a value expressed in milliseconds), [MediaMetadataRetriever.METADATA_KEY_YEAR](https://developer.android.com/reference/android/media/MediaMetadataRetriever#METADATA_KEY_YEAR).
|
| `value` | `long`: The long value for the given key
|
| Returns ||
|--------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------|
| [RemoteControlClient.MetadataEditor](https://developer.android.com/reference/android/media/RemoteControlClient.MetadataEditor) | Returns a reference to the same MetadataEditor object, so you can chain put calls together.
|
| Throws ||
|--------------------------------------------------------------------------------------------------------|------------------------------------|
| | java.lang.IllegalArgumentException |
| [IllegalArgumentException](https://developer.android.com/reference/java/lang/IllegalArgumentException) | |
### putObject
Added in [API level 19](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
Deprecated in [API level
21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public RemoteControlClient.MetadataEditor putObject (int key,
Object object)
```
Adds information stored as an instance.
Note that none of the information added after [apply()](https://developer.android.com/reference/android/media/MediaMetadataEditor#apply()) has been called
will be available to consumers of metadata stored by the MediaMetadataEditor.
| Parameters ||
|----------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `key` | `int`: the identifier of a the metadata field to set. Valid keys for a: - [Bitmap](https://developer.android.com/reference/android/graphics/Bitmap) object are [BITMAP_KEY_ARTWORK](https://developer.android.com/reference/android/media/RemoteControlClient.MetadataEditor#BITMAP_KEY_ARTWORK), - [String](https://developer.android.com/reference/java/lang/String) object are the same as for [putString(int, java.lang.String)](https://developer.android.com/reference/android/media/RemoteControlClient.MetadataEditor#putString(int,%20java.lang.String)) - [Long](https://developer.android.com/reference/java/lang/Long) object are the same as for [putLong(int, long)](https://developer.android.com/reference/android/media/RemoteControlClient.MetadataEditor#putLong(int,%20long)) - [Rating](https://developer.android.com/reference/android/media/Rating) object are [MediaMetadataEditor.RATING_KEY_BY_OTHERS](https://developer.android.com/reference/android/media/MediaMetadataEditor#RATING_KEY_BY_OTHERS) and [MediaMetadataEditor.RATING_KEY_BY_USER](https://developer.android.com/reference/android/media/MediaMetadataEditor#RATING_KEY_BY_USER).
|
| `object` | `Object`: the metadata to add.
|
| Returns ||
|--------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------|
| [RemoteControlClient.MetadataEditor](https://developer.android.com/reference/android/media/RemoteControlClient.MetadataEditor) | Returns a reference to the same MediaMetadataEditor object, so you can chain put calls together.
|
| Throws ||
|--------------------------------------------------------------------------------------------------------|---|
| [IllegalArgumentException](https://developer.android.com/reference/java/lang/IllegalArgumentException) | |
### putString
Added in [API level 14](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public RemoteControlClient.MetadataEditor putString (int key,
String value)
```
Adds textual information to be displayed.
Note that none of the information added after [apply()](https://developer.android.com/reference/android/media/RemoteControlClient.MetadataEditor#apply()) has been called,
will be displayed.
| Parameters ||
|---------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `key` | `int`: The identifier of a the metadata field to set. Valid values are [MediaMetadataRetriever.METADATA_KEY_ALBUM](https://developer.android.com/reference/android/media/MediaMetadataRetriever#METADATA_KEY_ALBUM), [MediaMetadataRetriever.METADATA_KEY_ALBUMARTIST](https://developer.android.com/reference/android/media/MediaMetadataRetriever#METADATA_KEY_ALBUMARTIST), [MediaMetadataRetriever.METADATA_KEY_TITLE](https://developer.android.com/reference/android/media/MediaMetadataRetriever#METADATA_KEY_TITLE), [MediaMetadataRetriever.METADATA_KEY_ARTIST](https://developer.android.com/reference/android/media/MediaMetadataRetriever#METADATA_KEY_ARTIST), [MediaMetadataRetriever.METADATA_KEY_AUTHOR](https://developer.android.com/reference/android/media/MediaMetadataRetriever#METADATA_KEY_AUTHOR), [MediaMetadataRetriever.METADATA_KEY_COMPILATION](https://developer.android.com/reference/android/media/MediaMetadataRetriever#METADATA_KEY_COMPILATION), [MediaMetadataRetriever.METADATA_KEY_COMPOSER](https://developer.android.com/reference/android/media/MediaMetadataRetriever#METADATA_KEY_COMPOSER), [MediaMetadataRetriever.METADATA_KEY_DATE](https://developer.android.com/reference/android/media/MediaMetadataRetriever#METADATA_KEY_DATE), [MediaMetadataRetriever.METADATA_KEY_GENRE](https://developer.android.com/reference/android/media/MediaMetadataRetriever#METADATA_KEY_GENRE), [MediaMetadataRetriever.METADATA_KEY_TITLE](https://developer.android.com/reference/android/media/MediaMetadataRetriever#METADATA_KEY_TITLE), [MediaMetadataRetriever.METADATA_KEY_WRITER](https://developer.android.com/reference/android/media/MediaMetadataRetriever#METADATA_KEY_WRITER).
|
| `value` | `String`: The text for the given key, or `null` to signify there is no valid information for the field.
|
| Returns ||
|--------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------|
| [RemoteControlClient.MetadataEditor](https://developer.android.com/reference/android/media/RemoteControlClient.MetadataEditor) | Returns a reference to the same MetadataEditor object, so you can chain put calls together.
|
| Throws ||
|--------------------------------------------------------------------------------------------------------|---|
| [IllegalArgumentException](https://developer.android.com/reference/java/lang/IllegalArgumentException) | |