Most visited

Recently visited

Results for

Added in API level 19
Deprecated since API level 21

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

MediaMetadataEditor

public abstract class MediaMetadataEditor
extends Object

java.lang.Object
↳	android.media.MediaMetadataEditor

Known Direct Subclasses

RemoteControlClient.MetadataEditor, RemoteController.MetadataEditor

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

An abstract class for editing and storing metadata that can be published by RemoteControlClient. See the editMetadata(boolean) method to instantiate a RemoteControlClient.MetadataEditor object.

Summary

Constants
`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`	`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.

Inherited methods

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 millis, int nanos)` Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object, or some other thread interrupts the current thread, or a certain amount of real time has elapsed.
`final void`	`wait(long millis)` Causes the current thread to wait until either another thread invokes the `notify()` method or the `notifyAll()` method for this object, or a specified amount of time has elapsed.
`final void`	`wait()` Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object.

Constants

BITMAP_KEY_ARTWORK

Added in API level 19

int BITMAP_KEY_ARTWORK

The metadata key for the content artwork / album art.

Constant Value: 100 (0x00000064)

RATING_KEY_BY_OTHERS

Added in API level 19

int RATING_KEY_BY_OTHERS

The metadata key for the content's average rating, not the user's rating. The value associated with this key is a Rating instance.

See also:

RATING_KEY_BY_USER

Constant Value: 101 (0x00000065)

RATING_KEY_BY_USER

Added in API level 19

int RATING_KEY_BY_USER

The metadata key for the content's user rating. The value associated with this key is a Rating instance. This key can be flagged as "editable" (with addEditableKey(int)) to enable receiving user rating values through the RemoteControlClient.OnMetadataUpdateListener interface.

Constant Value: 268435457 (0x10000001)

Public methods

addEditableKey

Added in API level 19

void addEditableKey (int key)

Flags the given key as being editable. This should only be used by metadata publishers, such as RemoteControlClient, which will declare the metadata field as eligible to be updated, with new values received through the RemoteControlClient.OnMetadataUpdateListener interface.

Parameters
`key`	`int`: the type of metadata that can be edited. The supported key is `RATING_KEY_BY_USER`.

apply

Added in API level 19

void apply ()

Applies all of the metadata changes that have been set since the MediaMetadataEditor instance was created or since clear() was called. Subclasses should synchronize on this for thread safety.

clear

Added in API level 19

void clear ()

Clears all the pending metadata changes set since the MediaMetadataEditor instance was created or since this method was last called. Note that clearing the metadata doesn't reset the editable keys (use removeEditableKeys() instead).

getBitmap

Added in API level 19

Bitmap getBitmap (int key, 
                Bitmap defaultValue)

Returns the Bitmap value for the key.

Parameters
`key`	`int`: the `BITMAP_KEY_ARTWORK` key
`defaultValue`	`Bitmap`: the value returned if the key is not present

Returns
`Bitmap`	the `Bitmap` value for the key, or the supplied default value if the key is not present

Throws
`IllegalArgumentException`

getEditableKeys

Added in API level 19

int[] getEditableKeys ()

Retrieves the keys flagged as editable.

Returns
`int[]`	null if there are no editable keys, or an array containing the keys.

getLong

Added in API level 19

long getLong (int key, 
                long defaultValue)

Returns the long value for the key.

Parameters
`key`	`int`: one of the keys supported in `putLong(int, long)`
`defaultValue`	`long`: the value returned if the key is not present

Returns
`long`	the long value for the key, or the supplied default value if the key is not present

Throws
`IllegalArgumentException`

getObject

Added in API level 19

Object getObject (int key, 
                Object defaultValue)

Returns an object representation of the value for the key

Parameters
`key`	`int`: one of the keys supported in `putObject(int, Object)`
`defaultValue`	`Object`: the value returned if the key is not present

Returns
`Object`	the object for the key, as a `Long`, `Bitmap`, `String`, or `Rating` depending on the key value, or the supplied default value if the key is not present

Throws
`IllegalArgumentException`

getString

Added in API level 19

String getString (int key, 
                String defaultValue)

Returns the String value for the key.

Parameters
`key`	`int`: one of the keys supported in `putString(int, String)`
`defaultValue`	`String`: the value returned if the key is not present

Returns
`String`	the `String` value for the key, or the supplied default value if the key is not present

Throws
`IllegalArgumentException`

putBitmap

Added in API level 19

MediaMetadataEditor putBitmap (int key, 
                Bitmap bitmap)

Adds image.

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
`MediaMetadataEditor`	Returns a reference to the same MediaMetadataEditor object, so you can chain put calls together.

Throws
	IllegalArgumentException
`IllegalArgumentException`

See also:

Bitmap

putLong

Added in API level 19

MediaMetadataEditor putLong (int key, 
                long value)

Adds numerical information. 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 values are `METADATA_KEY_CD_TRACK_NUMBER`, `METADATA_KEY_DISC_NUMBER`, `METADATA_KEY_DURATION` (with a value expressed in milliseconds), `METADATA_KEY_YEAR`.
`value`	`long`: The long value for the given key

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

Throws
`IllegalArgumentException`

putObject

Added in API level 19

MediaMetadataEditor putObject (int key, 
                Object value)

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, String)` `Long` object are the same as for `putLong(int, long)` `Rating` object are `RATING_KEY_BY_OTHERS` and `RATING_KEY_BY_USER`.
`value`	`Object`: the metadata to add.

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

Throws
`IllegalArgumentException`

putString

Added in API level 19

MediaMetadataEditor putString (int key, 
                String value)

Adds textual information. 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 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_WRITER`.
`value`	`String`: The text for the given key, or `null` to signify there is no valid information for the field.

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

Throws
`IllegalArgumentException`

removeEditableKeys

Added in API level 19

void removeEditableKeys ()

Causes all metadata fields to be read-only.

Interfaces

Classes

Exceptions

Most visited

Recently visited

Results for

MediaMetadataEditor

Summary

Constants

Public methods

Inherited methods

Constants

BITMAP_KEY_ARTWORK

RATING_KEY_BY_OTHERS

RATING_KEY_BY_USER

Public methods

addEditableKey

apply

clear

getBitmap

getEditableKeys

getLong

getObject

getString

putBitmap

putLong

putObject

putString

removeEditableKeys