com.bramosystems.oss.player.playlist.client.asx
Class ASXPlaylist

java.lang.Object
  com.bramosystems.oss.player.playlist.client.asx.ASXPlaylist

public final class ASXPlaylist
extends Object

Class represents an ASX playlist.

Since:

1.3

Author:

Sikirulai Braheem

Constructor Summary

ASXPlaylist()
Creates an empty ASX playlist

Method Summary

String	getAbstract() Returns the abstract element.
String	getAuthor() Returns the author of the playlist
String	getCopyright() Returns the copyright information of the playlist
List<ASXEntry>	getEntries() Returns the entries in this playlist
List<String>	getEntryRefs() Returns the URLs to external ASX playlists linked to this playlist
String	getMoreInfoHref() Returns the URL or e-mail address that provides more information about this playlist
HashMap<String,String>	getParams() Returns the custom parameters associated with this playlist
Repeat	getRepeat() Returns the playlist entries setup for playback repeats
String	getTitle() Returns the title of this playlist
double	getVersion() Returns the version of the ASX metafile from which this playlist is derived
boolean	isPreviewMode() Checks if the player should enter preview mode before playing the first clip
void	setAbstract(String _abstract) Sets the abstract element of the playlist
void	setAuthor(String author) Sets the author of the playlist
void	setCopyright(String copyright) Sets the copyright information of the playlist
void	setEntries(List<ASXEntry> entries) Sets the entries of this playlist
void	setEntryRefs(List<String> entryRefs) Sets the URLs of external ASX playlists linked to this playlist
void	setMoreInfoHref(String moreInfoHref) Sets the URL or e-mail address that provides more information about this playlist
void	setParams(HashMap<String,String> params) Associates custom paramters with this playlist
void	setPreviewMode(boolean previewMode) Sets if the player should preview the first clip before playing it.
void	setRepeat(Repeat repeat) Sets the playlist entries with playback repeats
void	setTitle(String title) Sets the title of this playlist
void	setVersion(double version) Sets the version of the ASX metafile
Playlist	toPlaylist() Returns this playlist as a Playlist object that can be used with player widgets with PlaylistSupport
String	toString() Returns a more descriptive representation of this playlist.

Methods inherited from class java.lang.Object

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

Constructor Detail

ASXPlaylist

public ASXPlaylist()

Creates an empty ASX playlist

Method Detail

getAbstract

public String getAbstract()

Returns the abstract element. The abstract gives a discription of the playlist.

Returns:

the abstract

setAbstract

public void setAbstract(String _abstract)

Sets the abstract element of the playlist

Parameters:

_abstract - describes the playlist

getAuthor

public String getAuthor()

Returns the author of the playlist

Returns:

the author of the playlist

setAuthor

public void setAuthor(String author)

Sets the author of the playlist

Parameters:

author - the author of the playlist

isPreviewMode

public boolean isPreviewMode()

Checks if the player should enter preview mode before playing the first clip

Returns:

true if player should preview the first clip before playing it, false otherwise

setPreviewMode

public void setPreviewMode(boolean previewMode)

Sets if the player should preview the first clip before playing it.

Parameters:

previewMode - true if player should preview the first clip, false otherwise

getCopyright

public String getCopyright()

Returns the copyright information of the playlist

Returns:

the copyright information

setCopyright

public void setCopyright(String copyright)

Sets the copyright information of the playlist

Parameters:

copyright - the copyright information

getEntries

public List<ASXEntry> getEntries()

Returns the entries in this playlist

Returns:

the entries in this playlist

setEntries

public void setEntries(List<ASXEntry> entries)

Sets the entries of this playlist

Parameters:

entries - the playlist entries

getEntryRefs

public List<String> getEntryRefs()

Returns the URLs to external ASX playlists linked to this playlist

Returns:

URLs of external ASX playlists

setEntryRefs

public void setEntryRefs(List<String> entryRefs)

Sets the URLs of external ASX playlists linked to this playlist

Parameters:

entryRefs - URLs of external ASX playlists

getMoreInfoHref

public String getMoreInfoHref()

Returns the URL or e-mail address that provides more information about this playlist

Returns:

URL or e-mail address that provides more information about this playlist

setMoreInfoHref

public void setMoreInfoHref(String moreInfoHref)

Sets the URL or e-mail address that provides more information about this playlist

Parameters:

moreInfoHref - the URL or e-mail address

getParams

public HashMap<String,String> getParams()

Returns the custom parameters associated with this playlist

Returns:

custom parameters in the playlist

setParams

public void setParams(HashMap<String,String> params)

Associates custom paramters with this playlist

Parameters:

params - custom parameters for the playlist

getRepeat

public Repeat getRepeat()

Returns the playlist entries setup for playback repeats

Returns:

playlist entries setup for playback repeats

setRepeat

public void setRepeat(Repeat repeat)

Sets the playlist entries with playback repeats

Parameters:

repeat - entries with playback repeats

getTitle

public String getTitle()

Returns the title of this playlist

Returns:

the playlist title

setTitle

public void setTitle(String title)

Sets the title of this playlist

Parameters:

title - the playlist title

getVersion

public double getVersion()

Returns the version of the ASX metafile from which this playlist is derived

Returns:

the version of the ASX metafile

setVersion

public void setVersion(double version)

Sets the version of the ASX metafile

Parameters:

version - the version of the ASX metafile

toString

public String toString()

Returns a more descriptive representation of this playlist. Useful during debugging

Overrides:

toString in class Object

toPlaylist

public Playlist toPlaylist()

Returns this playlist as a Playlist object that can be used with player widgets with PlaylistSupport

Returns:

Playlist object