FileDocCategorySizeDatePackage
MetaDataControl.javaAPI DocphoneME MR2 API (J2ME)3787Wed May 02 16:47:14 BST 2007javax.microedition.media.control

MetaDataControl

public interface MetaDataControl implements javax.microedition.media.Control
MetaDataControl is used to retrieve metadata information included within the media streams. A MetaDataControl object recognizes and stores metadata and provides XML-like accessor methods to retrieve this information.
Predefined keys are provided to refer to commonly used metadata fields (title, copyright, data, author).

Fields Summary
String
AUTHOR_KEY
Default key for AUTHOR information.

Value "author" is assigned to AUTHOR_KEY.

String
COPYRIGHT_KEY
Default key for COPYRIGHT information.

Value "copyright" is assigned to COPYRIGHT_KEY.

String
DATE_KEY
Default key for DATE information.

Value "date" is assigned to DATE_KEY.

String
TITLE_KEY
Default key for TITLE information.

Value "title" is assigned to TITLE_KEY.

Constructors Summary
Methods Summary
public java.lang.StringgetKeyValue(java.lang.String key)
Retrieve the value found in the metadata associated with the given key. Only keys obtained from getKeys are valid and can be used to retrieve metadata values. If null or an invalid key is used, an IllegalArgumentException will be thrown.

Some keys are valid but the associated metadata may not be available before a certain portion of the media is played. For example, some streaming media types may contain metadata that's stored at the end of the file. As a result, the metadata may not be available until the playback reaches the end of media. When that happens, calling getKeyValues with those keys will return null before the data is available. However, when the playback reaches the end of media, all metadata values must be made available.

param
key a key to retrieve the value.
return
the value of the key or null if the given key is valid but the value is not yet available.
exception
IllegalArgumentException Thrown if the given key is null or invalid.

public java.lang.String[]getKeys()
Return the list of keys for the available metadata values. The returned array must be an array with at least one key.

return
The list of keys for the available metadata values.