javax.microedition.media.control
Interface MetaDataControl

All Superinterfaces:
Control

public interface MetaDataControl
extends 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).

Since:
BlackBerry API 4.0.0

Field Summary
static String AUTHOR_KEY
          Default key for AUTHOR information.
static String COPYRIGHT_KEY
          Default key for COPYRIGHT information.
static String DATE_KEY
          Default key for DATE information.
static String TITLE_KEY
          Default key for TITLE information.
 
Method Summary
 String getKeyValue(String key)
          Retrieve the value found int the metadata associated with the given key.
 String[] getKeys()
          Return the list of keys for the available metadata values.
 



Field Detail

AUTHOR_KEY

static final String AUTHOR_KEY
Default key for AUTHOR information.

Value "author" is assigned to AUTHOR_KEY.

See Also:
Constant Field Values
Since:
BlackBerry API 4.0.0

COPYRIGHT_KEY

static final String COPYRIGHT_KEY
Default key for COPYRIGHT information.

Value "copyright" is assigned to COPYRIGHT_KEY.

See Also:
Constant Field Values
Since:
BlackBerry API 4.0.0

DATE_KEY

static final String DATE_KEY
Default key for DATE information.

Value "data" is assinged to DATE_KEY.

See Also:
Constant Field Values
Since:
BlackBerry API 4.0.0

TITLE_KEY

static final String TITLE_KEY
Default key for TITLE information.

Value "title" is assigned to TITLE_KEY.

See Also:
Constant Field Values
Since:
BlackBerry API 4.0.0


Method Detail

getKeys

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

Returns:
The list of keys for the available metadata values.
Since:
BlackBerry API 4.0.0

getKeyValue

String getKeyValue(String key)
Retrieve the value found int 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 ahppens, 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.

Parameters:
key - A key to retrieve the value.
Returns:
The value of the key or null if the given key is valid but the value is not yet available.
Throws:
IllegalArugmentException - Thrown if the given key is null or invalid.
Since:
BlackBerry API 4.0.0





Copyright 1999-2010 Research In Motion Limited. 295 Phillip Street, Waterloo, Ontario, Canada, N2L 3W8. All Rights Reserved.
Copyright 1993-2003 Sun Microsystems, Inc. 901 San Antonio Road, Palo Alto, California, 94303, U.S.A. All Rights Reserved.
Copyright 2002-2003 Nokia Corporation All Rights Reserved.
Java is a trademark of Sun Microsystems, Inc.