Added in API level 14
Deprecated in API level 21

Summary: Constants | Inherited Constants | Methods | Inherited Methods

RemoteControlClient.MetadataEditor

---

Kotlin |Java

public class RemoteControlClient.MetadataEditor
extends MediaMetadataEditor

java.lang.Object
↳	android.media.MediaMetadataEditor
	↳	android.media.RemoteControlClient.MetadataEditor

---

This class was deprecated in API level 21.
Use MediaMetadata and MediaSession instead.

Class used to modify metadata in a RemoteControlClient object. Use 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() 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 The metadata key for the content artwork / album art.

Inherited constants
From class android.media.MediaMetadataEditor int BITMAP_KEY_ARTWORK The metadata key for the content artwork / album art. int RATING_KEY_BY_OTHERS The metadata key for the content's average rating, not the user's rating. int RATING_KEY_BY_USER The metadata key for the content's user rating.

Public methods
void	apply() Associates all the metadata that has been set since the MetadataEditor instance was created with RemoteControlClient#editMetadata(boolean), or since clear() was called, with the RemoteControlClient.
void	clear() Clears all the metadata that has been set since the MetadataEditor instance was created (with RemoteControlClient#editMetadata(boolean)).
RemoteControlClient.MetadataEditor	putBitmap(int key, Bitmap bitmap) Sets the album / artwork picture to be displayed on the remote control.
RemoteControlClient.MetadataEditor	putLong(int key, long value) Adds numerical information to be displayed.
RemoteControlClient.MetadataEditor	putObject(int key, Object object) Adds information stored as an instance.
RemoteControlClient.MetadataEditor	putString(int key, String value) Adds textual information to be displayed.

Inherited methods
From class android.media.MediaMetadataEditor void addEditableKey(int key) Flags the given key as being editable. abstract void apply() Applies all of the metadata changes that have been set since the MediaMetadataEditor instance was created or since clear() was called. void clear() Clears all the pending metadata changes set since the MediaMetadataEditor instance was created or since this method was last called. Bitmap getBitmap(int key, Bitmap defaultValue) Returns the Bitmap value for the key. int[] getEditableKeys() Retrieves the keys flagged as editable. long getLong(int key, long defaultValue) Returns the long value for the key. Object getObject(int key, Object defaultValue) Returns an object representation of the value for the key String getString(int key, String defaultValue) Returns the String value for the key. MediaMetadataEditor putBitmap(int key, Bitmap bitmap) Adds image. MediaMetadataEditor putLong(int key, long value) Adds numerical information. MediaMetadataEditor putObject(int key, Object value) Adds information stored as an instance. MediaMetadataEditor putString(int key, String value) Adds textual information. void removeEditableKeys() Causes all metadata fields to be read-only.
From class java.lang.Object Object clone() Creates and returns a copy of this object. boolean equals(Object obj) Indicates whether some other object is "equal to" this one. void finalize() Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. final Class<?> getClass() Returns the runtime class of this Object. int hashCode() Returns a hash code value for the object. final void notify() Wakes up a single thread that is waiting on this object's monitor. final void notifyAll() Wakes up all threads that are waiting on this object's monitor. String toString() Returns a string representation of the object. final void wait(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(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() 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

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

public void apply ()

Associates all the metadata that has been set since the MetadataEditor instance was created with RemoteControlClient#editMetadata(boolean), or since 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

public void clear ()

Clears all the metadata that has been set since the MetadataEditor instance was created (with RemoteControlClient#editMetadata(boolean)). Note that clearing the metadata doesn't reset the editable keys (use MediaMetadataEditor#removeEditableKeys() instead).

putBitmap

Added in API level 14

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
bitmap	Bitmap: The bitmap for the artwork, or null if there isn't any.

Returns
RemoteControlClient.MetadataEditor	Returns a reference to the same MetadataEditor object, so you can chain put calls together.

Throws
	java.lang.IllegalArgumentException
IllegalArgumentException

See also:

• Bitmap

putLong

Added in API level 14

public RemoteControlClient.MetadataEditor putLong (int key, 
                long value)

Adds numerical information to be displayed. Note that none of the information added after 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, MediaMetadataRetriever.METADATA_KEY_DISC_NUMBER, MediaMetadataRetriever.METADATA_KEY_DURATION (with a value expressed in milliseconds), MediaMetadataRetriever.METADATA_KEY_YEAR.
value	long: The long value for the given key

Returns
RemoteControlClient.MetadataEditor	Returns a reference to the same MetadataEditor object, so you can chain put calls together.

Throws
	java.lang.IllegalArgumentException
IllegalArgumentException

putObject

Added in API level 19
Deprecated in API level 21

public RemoteControlClient.MetadataEditor putObject (int key, 
                Object object)

Adds information stored as an instance. Note that none of the information added after 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 object are BITMAP_KEY_ARTWORK, String object are the same as for putString(int, java.lang.String) Long object are the same as for putLong(int, long) Rating object are MediaMetadataEditor.RATING_KEY_BY_OTHERS and MediaMetadataEditor.RATING_KEY_BY_USER.
object	Object: the metadata to add.

Returns
RemoteControlClient.MetadataEditor	Returns a reference to the same MediaMetadataEditor object, so you can chain put calls together.

Throws
IllegalArgumentException

putString

Added in API level 14

public RemoteControlClient.MetadataEditor putString (int key, 
                String value)

Adds textual information to be displayed. Note that none of the information added after 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, MediaMetadataRetriever.METADATA_KEY_ALBUMARTIST, MediaMetadataRetriever.METADATA_KEY_TITLE, MediaMetadataRetriever.METADATA_KEY_ARTIST, MediaMetadataRetriever.METADATA_KEY_AUTHOR, MediaMetadataRetriever.METADATA_KEY_COMPILATION, MediaMetadataRetriever.METADATA_KEY_COMPOSER, MediaMetadataRetriever.METADATA_KEY_DATE, MediaMetadataRetriever.METADATA_KEY_GENRE, MediaMetadataRetriever.METADATA_KEY_TITLE, 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	Returns a reference to the same MetadataEditor object, so you can chain put calls together.

Throws
IllegalArgumentException