chameleon.rss.media

Class Player

java.lang.Object

chameleon.rss.media.Player

public class Player
extends Object

Allows the media object to be accessed through a web browser media player console. Required only if a direct media url attribute is not specified in the media content element.
Example:

 <media:player url="http://www.foo.com/player?id=1111" height="200" width="400"/>
 

Version:

$Revision: 92 $

Author:

Christophe Delory

Constructor Summary

Constructors

Constructor and Description
Player()

Method Summary

Modifier and Type	Method and Description
Integer	getHeight() Returns the integer representing the value in pixels for the height of the video in this item.
URI	getURL() Returns the URL of the player console that plays the media.
String	getURLString() Returns the URL of the player console that plays the media, as a string.
Integer	getWidth() Returns the integer representing the value in pixels for the width of the video in this item.
void	setHeight(int height) Initializes the integer representing the value in pixels for the height of the video in this item.
void	setHeight(Integer height) Initializes the integer representing the value in pixels for the height of the video in this item.
void	setURL(URI url) Initializes the URL of the player console that plays the media.
void	setURLString(String url) Initializes the URL of the player console that plays the media, as a string.
void	setWidth(int width) Initializes the integer representing the value in pixels for the width of the video in this item.
void	setWidth(Integer width) Initializes the integer representing the value in pixels for the width of the video in this item.

Methods inherited from class java.lang.Object

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

Constructor Detail

Player

public Player()

Method Detail

setURLString

public void setURLString(String url)
                  throws URISyntaxException

Initializes the URL of the player console that plays the media, as a string.

Parameters:

url - an URL as a string. Shall not be null.

Throws:

NullPointerException - if url is null.

URISyntaxException - if the given string violates RFC 2396, as augmented by the URI deviations.

See Also:

getURLString(), setURL(java.net.URI)

getURLString

public String getURLString()

Returns the URL of the player console that plays the media, as a string. No default value.

Returns:

an URL as a string. Shall not be null.

Throws:

NullPointerException - if no URL has been defined in this element.

See Also:

setURLString(java.lang.String), getURL()

setURL

public void setURL(URI url)

Initializes the URL of the player console that plays the media.

Parameters:

url - an URL. Shall not be null.

Throws:

NullPointerException - if url is null.

See Also:

getURL(), setURLString(java.lang.String)

getURL

public URI getURL()

Returns the URL of the player console that plays the media.

Returns:

an URL. May be null if not yet initialized.

See Also:

setURL(java.net.URI), getURLString()

setWidth

public void setWidth(int width)

Initializes the integer representing the value in pixels for the width of the video in this item.

Parameters:

width - a video width.

See Also:

getWidth(), setWidth(Integer)

setWidth

public void setWidth(Integer width)

Initializes the integer representing the value in pixels for the width of the video in this item.

Parameters:

width - a video width. May be null.

See Also:

getWidth(), setWidth(int)

getWidth

public Integer getWidth()

Returns the integer representing the value in pixels for the width of the video in this item. It is the width of the browser window that the URL should be opened in. No default value.

Returns:

a video width. May be null.

See Also:

setWidth(int)

setHeight

public void setHeight(int height)

Initializes the integer representing the value in pixels for the height of the video in this item.

Parameters:

height - a video height.

See Also:

setHeight(Integer), getHeight()

setHeight

public void setHeight(Integer height)

Initializes the integer representing the value in pixels for the height of the video in this item.

Parameters:

height - a video height. May be null.

See Also:

getHeight(), setHeight(int)

getHeight

public Integer getHeight()

Returns the integer representing the value in pixels for the height of the video in this item. It is the height of the browser window that the URL should be opened in. No default value.

Returns:

a video height. May be null.

See Also:

setHeight(int)