Android APIs
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 Overview

Class used to modify metadata in a RemoteControlClient object. Use 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.
[Expand]
Inherited Constants
From class android.media.MediaMetadataEditor
Public Methods
void apply()
Associates all the metadata that has been set since the MetadataEditor instance was created with 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 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.
[Expand]
Inherited Methods
From class android.media.MediaMetadataEditor
From class java.lang.Object

Constants

public static final int BITMAP_KEY_ARTWORK

Added in API level 14

The metadata key for the content artwork / album art.

Constant Value: 100 (0x00000064)

Public Methods

public void apply ()

Added in API level 14

Associates all the metadata that has been set since the MetadataEditor instance was created with editMetadata(boolean), or since clear() was called, with the RemoteControlClient. Once "applied", this MetadataEditor cannot be reused to edit the RemoteControlClient's metadata.

public void clear ()

Added in API level 14

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

public RemoteControlClient.MetadataEditor putBitmap (int key, Bitmap bitmap)

Added in API level 14

Sets the album / artwork picture to be displayed on the remote control.

Parameters
key the identifier of the bitmap to set. The only valid value is BITMAP_KEY_ARTWORK
bitmap The bitmap for the artwork, or null if there isn't any.
Returns
  • Returns a reference to the same MetadataEditor object, so you can chain put calls together.
Throws
IllegalArgumentException
IllegalArgumentException
See Also

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

Added in API level 14

Adds numerical information to be displayed. Note that none of the information added after apply() has been called, will be displayed.

Parameters
key the identifier of a the metadata field to set. Valid values are METADATA_KEY_CD_TRACK_NUMBER, METADATA_KEY_DISC_NUMBER, METADATA_KEY_DURATION (with a value expressed in milliseconds), METADATA_KEY_YEAR.
value The long value for the given key
Returns
  • Returns a reference to the same MetadataEditor object, so you can chain put calls together.

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

Added in API level 19

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 the identifier of a the metadata field to set. Valid keys for a:
object the metadata to add.
Returns
  • Returns a reference to the same MediaMetadataEditor object, so you can chain put calls together.

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

Added in API level 14

Adds textual information to be displayed. Note that none of the information added after apply() has been called, will be displayed.

Parameters
key The identifier of a the metadata field to set. Valid values are METADATA_KEY_ALBUM, METADATA_KEY_ALBUMARTIST, METADATA_KEY_TITLE, METADATA_KEY_ARTIST, METADATA_KEY_AUTHOR, METADATA_KEY_COMPILATION, METADATA_KEY_COMPOSER, METADATA_KEY_DATE, METADATA_KEY_GENRE, METADATA_KEY_TITLE, METADATA_KEY_WRITER.
value The text for the given key, or null to signify there is no valid information for the field.
Returns
  • Returns a reference to the same MetadataEditor object, so you can chain put calls together.