net.rim.plazmic.mediaengine
Class MediaManager

java.lang.Object
  |
  +--net.rim.plazmic.mediaengine.MediaManager

All Implemented Interfaces:

ResourceProvider

public class MediaManager

extends Object

implements ResourceProvider

MediaManager class for downloading media content from the Internet or local storage. MediaManager downloads media content and resources and instantiates media data object that can be passed to the MediaPlayer for playback using MediaPlayer.setMedia(java.lang.Object).

Since:

JDE 3.7.0

See Also:

MediaPlayer

Field Summary

Constructor Summary

MediaManager()
The default constructor.

MediaManager(Connector c)
Creates a MediaManager instance given a connector.

MediaManager(Connector c, boolean enableRelative)
Creates a MediaManager instance given a connector and a boolean that indicates whether or not relative URLs are enabled.

Method Summary

void	addMediaListener(MediaListener listener) Adds a listener to the media.
void	cancel() Cancels the current download if one exists.
Object	createMedia(String uri) Loads media content from a given URI.
Object	createMedia(String uri, String suggestedType) Loads media content from a given URI.
void	createMediaLater(String uri) Loads media content asynchronously given a Uniform Resource Indicator (URI).
void	dispose() Disposes the download if one exists.
Connector	getConnector() Returns the connector for this MediaManager.
Connector	getDefaultConnector() Returns the default connector associated with this MediaManager.
void	removeMediaListener(MediaListener listener) Removes a listener from the media.
String	resolveURL(String url) Converts a relative url or an absolute path to an absolute url.
void	setConnector(Connector connector) Sets the connector for this MediaManager.
void	setProperty(String name, String value) Set connection properties.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

Constructor Detail

MediaManager

public MediaManager()

The default constructor.

Since:

JDE 3.7.0

MediaManager

public MediaManager(Connector c)

Creates a MediaManager instance given a connector.

Parameters:

c - The connector used to create the MediaManager.

Since:

JDE 3.7.0

MediaManager

public MediaManager(Connector c,
                    boolean enableRelative)

Creates a MediaManager instance given a connector and a boolean that indicates whether or not relative URLs are enabled.

Parameters:

c - The connector used to create the MediaManager.

enableRelative - A boolean indicating whether or not relative URLs are allowed.

Since:

JDE 3.7.0

Method Detail

setConnector

public void setConnector(Connector connector)

Sets the connector for this MediaManager.

Parameters:

connector - The connector to set.

Since:

JDE 4.0.2

getConnector

public Connector getConnector()

Returns the connector for this MediaManager.

Returns:

The connector instance.

Since:

JDE 3.7.0

getDefaultConnector

public Connector getDefaultConnector()

Returns the default connector associated with this MediaManager.

Returns:

The default connector.

Since:

JDE 3.7.0

setProperty

public void setProperty(String name,
                        String value)
                 throws IllegalArgumentException

Set connection properties.

This method allows the user to set any connector specific properties as name value pairs. Set of supported properties is specific to the Connector.

Parameters:

name - The property name to set. Property "URI_BASE" requires value to be an absolute URL

value - The property value to set.

Throws:

IllegalArgumentException - Thrown if the specified property name is invalid. exception if the property is not supported

Since:

JDE 4.0.2

resolveURL

public String resolveURL(String url)

Converts a relative url or an absolute path to an absolute url.

Parameters:

url - A relative or absolute path or absolute url.

Returns:

An absolute url based on the document base.

Since:

JDE 4.0.2

addMediaListener

public void addMediaListener(MediaListener listener)

Adds a listener to the media.

Parameters:

listener - The listener to add. If null throws java.lang.IllegalArgumentException.

Since:

JDE 4.0.2

removeMediaListener

public void removeMediaListener(MediaListener listener)

Removes a listener from the media.

Parameters:

listener - The listener to remove. If null throws java.lang.IllegalArgumentException.

Since:

JDE 4.0.2

createMedia

public Object createMedia(String uri)
                   throws IOException,
                          MediaException

Loads media content from a given URI.

Parameters:

uri - A string representing the URI. URI can be relative or absolute URL. Must not be null.

Returns:

An object representing the media content.

Throws:

IOException - Thrown if the i/o error occured during the download or parsing of the data.

MediaException - Thrown if the media is not supported or the download has been cancelled.

Since:

JDE 4.0.2

createMedia

public Object createMedia(String uri,
                          String suggestedType)
                   throws IOException,
                          MediaException

Loads media content from a given URI.

Parameters:

uri - A string representing the URI. URI can be relative or absolute URL. Must not be null. * @param suggestedType A string representing the MediaType @link MediaType Must not be null.

Returns:

An object representing the media content.

Throws:

IOException - Thrown if the i/o error occured during the download or parsing of the data.

MediaException - Thrown if the media is not supported or the download has been cancelled.

Since:

JDE 4.0.2

createMediaLater

public void createMediaLater(String uri)

Loads media content asynchronously given a Uniform Resource Indicator (URI).

Once download is complete the listeners will be notified with the event MediaListener.MEDIA_REALIZED. If download fails the listeners will be notified with the event MediaListener.MEDIA_LOADING_FAILED. Subsequent calls prior to download completion will automatically cancel the previous request.

Parameters:

uri - A string representing the URI.

Since:

JDE 4.0.2

cancel

public void cancel()

Cancels the current download if one exists.

This stops the current download. The download can be restarted from the beginning after a call to cancel() has been made.

Since:

JDE 3.7.0

dispose

public void dispose()

Disposes the download if one exists.

Calling dispose() releases all resources allocated by the manager. This method should be called when MediaManager is no longer needed.

Since:

JDE 3.7.0