com.intertrust.wasabi.media

Class MediaDownload

java.lang.Object

com.intertrust.wasabi.media.MediaDownload

public class MediaDownload
extends java.lang.Object

Media Download module. The functionality of this module provides MPEG DASH content download and conversion into a single Fragmented MP4 media file on the local file system and another file for an optional subtitles file. Supported is also download of a single file without any conversion.

Since:

1.21

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MediaDownload.Constraints Media Download resource constrains not to be exceeded.
static class	MediaDownload.ContentBase The download content parameters.
static class	MediaDownload.ContentState Content download states
static class	MediaDownload.ContentStatus The download content status.
static class	MediaDownload.DashContent MPEG DASH content parameters
static interface	MediaDownload.Listener The Media Download Listener interface.
static class	MediaDownload.SingleFileContent Single file parameters
static class	MediaDownload.SourceType The content source type.
static class	MediaDownload.State The overall Media Download status.
static class	MediaDownload.Status The Media Download status.

Constructor Summary

Constructors

Constructor and Description
MediaDownload() Obtain a Media Download singleton object reference.

Method Summary

Methods

Modifier and Type	Method and Description
void	addContent(java.lang.String path, MediaDownload.ContentBase content) Register a new content for download.
void	cancelContent(java.lang.String path) Cancel the content from download.
void	finalize() Do release if necessary.
void	pause() Pause the Media Download.
MediaDownload.ContentStatus	queryContentStatus(java.lang.String path) Query the status of the content being downloaded.
MediaDownload.Status	queryStatus() Query the Media Download status.
void	release() Release a Media Download singleton reference.
void	removeListener() Remove the listener, if any.
void	resume() Resume the Media Download.
void	setConstraints(MediaDownload.Constraints constraints) Assign the Media Download constraints.
void	setListener(MediaDownload.Listener listener) Set the listener.

Methods inherited from class java.lang.Object

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

Constructor Detail

MediaDownload

public MediaDownload()
              throws ErrorCodeException

Obtain a Media Download singleton object reference. The first instance of Media Download in an application will instantiate the Media Download singleton object. The object is in the PAUSED state initially. The returned reference may be released through the MediaDownload#release() once no longer needed. References are counted and the Media Download object continues to exist until the last reference has been released. returns reference to the Media Download singleton object

Throws:

ErrorCodeException

Method Detail

release

public void release()
             throws ErrorCodeException

Release a Media Download singleton reference. An application may invoke this method to cause Media Download destruction once last reference is released. However, it is not necessary to invoke this method.

Throws:

ErrorCodeException

finalize

public void finalize()

Do release if necessary.

Overrides:

finalize in class java.lang.Object

setListener

public void setListener(MediaDownload.Listener listener)
                 throws ErrorCodeException,
                        java.lang.NullPointerException

Set the listener. There can be only one listener associated with the Media Download object. Any previous listener will be removed in the call to MediaDownload#setListener().

Parameters:

listener - pointer to the listener object that will be copied by the MediaDownload#setListener() function

Throws:

ErrorCodeException

java.lang.NullPointerException

removeListener

public void removeListener()
                    throws ErrorCodeException

Remove the listener, if any.

Throws:

ErrorCodeException

pause

public void pause()
           throws ErrorCodeException

Pause the Media Download. Put the Media Download singleton object into the PAUSED state.

Throws:

ErrorCodeException

resume

public void resume()
            throws ErrorCodeException

Resume the Media Download. Put the Media Download singleton object into the RUNNING state.

Throws:

ErrorCodeException

setConstraints

public void setConstraints(MediaDownload.Constraints constraints)
                    throws ErrorCodeException,
                           java.lang.NullPointerException

Assign the Media Download constraints. The effects on the module may not be immediate. For example, the number of connection may exceed the constraints until the currently active downloads have been completed or cancelled. If constraints is null, constraints are reset to no constraints.

Parameters:

constraints - the new constraints object

Throws:

ErrorCodeException

java.lang.NullPointerException

queryStatus

public MediaDownload.Status queryStatus()
                                 throws ErrorCodeException

Query the Media Download status.

Returns:

the current Media Download status.

Throws:

ErrorCodeException

addContent

public void addContent(java.lang.String path,
              MediaDownload.ContentBase content)
                throws ErrorCodeException,
                       java.lang.NullPointerException

Register a new content for download.

Parameters:

path - the unique directory path to where the newly downloaded content will be stored. The directory may or may not exist, but the parent directory must exist. If the directory at path does not exist, it is created.

content - description of the content to be downloaded.

Throws:

ErrorCodeException

java.lang.NullPointerException

cancelContent

public void cancelContent(java.lang.String path)
                   throws ErrorCodeException,
                          java.lang.NullPointerException

Cancel the content from download.

Parameters:

path - the unique directory path that identifies the content being downloaded.

Throws:

ErrorCodeException

java.lang.NullPointerException

queryContentStatus

public MediaDownload.ContentStatus queryContentStatus(java.lang.String path)
                                               throws ErrorCodeException,
                                                      java.lang.NullPointerException

Query the status of the content being downloaded. The content is identified by the unique download directory in the path parameter. Ownership of the returned status object is transferred to the caller. The caller must invoke WSB_MediaDownload_ReleaseContentStatus() to release the status object once no longer needed.

Parameters:

path - the unique directory path that identifies the content being queried

Returns:

newly allocated content status object

Throws:

ErrorCodeException

java.lang.NullPointerException