Please note that the contents of this offline web site may be out of date. To access the most recent documentation visit the online version .
Note that links that point to online resources are green in color and will open in a new window.
We would love it if you could give us feedback about this material by filling this form (You have to be online to fill it)

Summary: Constants | Inherited Constants | Methods | Inherited Methods | [Expand All]

Added in API level 14

public class

RemoteControlClient.MetadataEditor

extends MediaMetadataEditor

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

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
synchronized 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.
synchronized void	clear () Clears all the metadata that has been set since the MetadataEditor instance was created (with `editMetadata(boolean)` ).
synchronized RemoteControlClient.MetadataEditor	putBitmap (int key, Bitmap bitmap) Sets the album / artwork picture to be displayed on the remote control.
synchronized RemoteControlClient.MetadataEditor	putLong (int key, long value) Adds numerical information to be displayed.
synchronized RemoteControlClient.MetadataEditor	putString (int key, String value) Adds textual information to be displayed.

[Expand]

Inherited Methods

From class android.media.MediaMetadataEditor

synchronized 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.
synchronized void	clear () Clears all the pending metadata changes set since the MediaMetadataEditor instance was created or since this method was last called.
synchronized Bitmap	getBitmap (int key, Bitmap defaultValue) Returns the `Bitmap` value for the key.
synchronized int[]	getEditableKeys () Retrieves the keys flagged as editable.
synchronized long	getLong (int key, long defaultValue) Returns the long value for the key.
synchronized Object	getObject (int key, Object defaultValue) Returns an object representation of the value for the key
synchronized String	getString (int key, String defaultValue) Returns the `String` value for the key.
synchronized MediaMetadataEditor	putBitmap (int key, Bitmap bitmap) Adds image.
synchronized MediaMetadataEditor	putLong (int key, long value) Adds numerical information.
synchronized MediaMetadataEditor	putObject (int key, Object value) Adds information stored as an instance.
synchronized MediaMetadataEditor	putString (int key, String value) Adds textual information.
synchronized 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 o) Compares this instance with the specified object and indicates if they are equal.
void	finalize () Invoked when the garbage collector has detected that this instance is no longer reachable.
final Class <?>	getClass () Returns the unique instance of `Class` that represents this object's class.
int	hashCode () Returns an integer hash code for this object.
final void	notify () Causes a thread which is waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up.
final void	notifyAll () Causes all threads which are waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up.
String	toString () Returns a string containing a concise, human-readable description of this object.
final void	wait () Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object.
final void	wait (long millis, int nanos) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires.
final void	wait (long millis) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires.

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 synchronized 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 synchronized 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 synchronized 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

public synchronized 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.

Throws

IllegalArgumentException

public synchronized 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.

Throws

IllegalArgumentException

Results

Interfaces

Classes

Exceptions

RemoteControlClient.MetadataEditor

Class Overview

Summary

Constants

public static final int BITMAP_KEY_ARTWORK

Public Methods

public synchronized void apply ()

public synchronized void clear ()

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

Parameters

Returns

Throws

See Also

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

Parameters

Returns

Throws

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

Parameters

Returns

Throws