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

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

public class ASXEntry
extends Object

Describes an ASX playlist entry

Since:

1.3

Author:

Sikirulai Braheem

Constructor Summary

ASXEntry()
Creates an empty ASX entry

Method Summary

String	getAbstract() Returns the abstract describing this entry
String	getAuthor() Returns the author of this entry
String	getCopyright() Returns the copyright information of this playlist entry
PlayTime	getDuration() Returns the playback duration of the playlist entry
String	getMoreInfoHref() Returns the URL or e-mail address that provides more information about this playlist entry
HashMap<String,String>	getParams() Returns the custom parameters associated with this playlist entry
List<Ref>	getRefs() Returns the URL references of this media entry.
PlayTime	getStartTime() Returns the time when playback should start
String	getTitle() Returns the title of this entry
boolean	isClientSkip() Checks if this entry can be skipped during playback
boolean	isSkipIfRef() Checks if this entry should be skipped by a player when referenced by another playlist
void	setAbstract(String _abstract) Sets the abstract element that describes this entry
void	setAuthor(String author) Sets the author of this entry
void	setClientSkip(boolean clientSkip) Sets if this entry can be skipped during playback
void	setCopyright(String copyright) Sets the copyright information of this playlist entry
void	setDuration(PlayTime duration) Sets the playback duration of the playlist entry
void	setMoreInfoHref(String moreInfoHref) Sets the URL or e-mail address that provides more information about this playlist entry
void	setParams(HashMap<String,String> params) Associates custom paramters with this playlist entry
void	setRefs(List<Ref> refs) Sets the URL references of this media entry.
void	setSkipIfRef(boolean skipIfRef) Sets if this entry should be skipped by a player when referenced by another playlist
void	setStartTime(PlayTime startTime) Sets the time when playback should start
void	setTitle(String title) Sets the title of this playlist entry
String	toString() Returns a more descriptive representation of this entry.

Methods inherited from class java.lang.Object

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

Constructor Detail

ASXEntry

public ASXEntry()

Creates an empty ASX entry

Method Detail

getAbstract

public String getAbstract()

Returns the abstract describing this entry

Returns:

the abstract

setAbstract

public void setAbstract(String _abstract)

Sets the abstract element that describes this entry

Parameters:

_abstract - the abstract

getAuthor

public String getAuthor()

Returns the author of this entry

Returns:

the author

setAuthor

public void setAuthor(String author)

Sets the author of this entry

Parameters:

author - the author of this entry

isClientSkip

public boolean isClientSkip()

Checks if this entry can be skipped during playback

Returns:

true if this entry can be skipped, false otherwise

setClientSkip

public void setClientSkip(boolean clientSkip)

Sets if this entry can be skipped during playback

Parameters:

clientSkip - true if this entry can be skipped, false otherwise

getCopyright

public String getCopyright()

Returns the copyright information of this playlist entry

Returns:

the copyright information

setCopyright

public void setCopyright(String copyright)

Sets the copyright information of this playlist entry

Parameters:

copyright - the copyright information

getDuration

public PlayTime getDuration()

Returns the playback duration of the playlist entry

Returns:

the duration of playback

setDuration

public void setDuration(PlayTime duration)

Sets the playback duration of the playlist entry

Parameters:

duration - the duration of playback

getMoreInfoHref

public String getMoreInfoHref()

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

Returns:

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

setMoreInfoHref

public void setMoreInfoHref(String moreInfoHref)

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

Parameters:

moreInfoHref - the URL or e-mail address

getParams

public HashMap<String,String> getParams()

Returns the custom parameters associated with this playlist entry

Returns:

custom parameters in the playlist entry

setParams

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

Associates custom paramters with this playlist entry

Parameters:

params - custom parameters for the playlist entry

getRefs

public List<Ref> getRefs()

Returns the URL references of this media entry. The URL may point to the same media content probably in different formats.

Returns:

the URL references of this media entry

setRefs

public void setRefs(List<Ref> refs)

Sets the URL references of this media entry.

Parameters:

refs - the URL references of this media entry

isSkipIfRef

public boolean isSkipIfRef()

Checks if this entry should be skipped by a player when referenced by another playlist

Returns:

true if this entry should be skipped when referenced by another playlist, false otherwise

setSkipIfRef

public void setSkipIfRef(boolean skipIfRef)

Sets if this entry should be skipped by a player when referenced by another playlist

Parameters:

skipIfRef - true if this entry should be skipped when referenced by another playlist, false otherwise

getStartTime

public PlayTime getStartTime()

Returns the time when playback should start

Returns:

the time when playback should start

setStartTime

public void setStartTime(PlayTime startTime)

Sets the time when playback should start

Parameters:

startTime - the time when playback should start

getTitle

public String getTitle()

Returns the title of this entry

Returns:

the title of this playlist entry

setTitle

public void setTitle(String title)

Sets the title of this playlist entry

Parameters:

title - the title of this playlist entry

toString

public String toString()

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

Overrides:

toString in class Object