christophedelory.playlist.smil
Class Reference

java.lang.Object
  christophedelory.playlist.smil.Core
      christophedelory.playlist.smil.AbstractSmilElement
          christophedelory.playlist.smil.Reference

Direct Known Subclasses:

Animation, Audio, Image, Text, TextStream, Video

public class Reference
extends AbstractSmilElement

Represents a generic media reference which allows to define the media objects elements.

Version:

$Revision: 92 $

Author:

Christophe Delory

Constructor Summary

Reference()

Method Summary

void	acceptDown(SmilVisitor visitor) Accepts the specified SMIL playlist visitor.
void	addParam(Param param) Adds a general parameter to this SMIL media object.
String	getFill() Returns the fill parameter as a string.
String	getParamGroupString() Returns the parameter group associated to this reference.
List<Param>	getParams() Returns the list of general parameters which are associated to a media object of a SMIL presentation.
String	getSoundAlign() Returns the coarse 2D placement of the audio portion of a media element assigned to play within a given region.
String	getSource() Returns the URI (source) of the media element used for locating and fetching the associated media, as a string.
String	getType() Returns the content type of the media object referenced by the src attribute.
void	setFill(String fill) Initializes the fill parameter as a string.
void	setParamGroupString(String paramGroup) Initializes the parameter group associated to this reference.
void	setSoundAlign(String soundAlign) Initializes the coarse 2D placement of the audio portion of a media element assigned to play within a given region.
void	setSource(String source) Initializes the URI (source) of the media element from the specified string.
void	setType(String type) Initializes the content type of the media object.

Methods inherited from class christophedelory.playlist.smil.AbstractSmilElement

getBeginString, getDuration, getDurationString, getEnd, getMax, getMin, getParent, getRegionString, getRepeatCount, getRepeatCountString, getRepeatDuration, setBeginString, setDuration, setDurationString, setEnd, setMax, setMin, setParent, setRegionString, setRepeatCount, setRepeatCountString, setRepeatDuration

Methods inherited from class christophedelory.playlist.smil.Core

getClassName, getId, getLang, getTitle, setClassName, setId, setLang, setTitle

Methods inherited from class java.lang.Object

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

Constructor Detail

Reference

public Reference()

Method Detail

getSource

public String getSource()

Returns the URI (source) of the media element used for locating and fetching the associated media, as a string. A media object with no src attribute has an intrinsic duration of zero, and participates in timing just as any other media element. No media will be fetched by the SMIL implementation for a media element without a src attribute.

Returns:

an URI. May be null.

See Also:

setSource(java.lang.String)

setSource

public void setSource(String source)

Initializes the URI (source) of the media element from the specified string.

Parameters:

source - an URI. May be null.

See Also:

getSource()

getType

public String getType()

Returns the content type of the media object referenced by the src attribute. The usage of this attribute depends on the protocol of the src attribute. Different protocols: RTSP, HTTP, FTP.

Returns:

the content type of the media object. May be null.

See Also:

setType(java.lang.String)

setType

public void setType(String type)

Initializes the content type of the media object.

Parameters:

type - the media object content type. May be null.

See Also:

getType()

addParam

public void addParam(Param param)

Adds a general parameter to this SMIL media object.

Parameters:

param - a media object parameter. Shall not be null.

Throws:

NullPointerException - if param is null.

See Also:

getParams()

getParams

public List<Param> getParams()

Returns the list of general parameters which are associated to a media object of a SMIL presentation.

Returns:

the list of parameters. May be empty but not null.

See Also:

addParam(christophedelory.playlist.smil.Param)

getFill

public String getFill()

Returns the fill parameter as a string. The fill attribute allows an author to specify that an element should be extended beyond the active duration by freezing the final state of the element. The fill attribute is also used to determine the behavior when the active duration is less than the duration specified in the min attribute. For this reason, rather than referring to the end of the active duration, this description refers to the "last instance of the simple duration". Could be equal to "remove", "freeze", "hold", "transition", "auto", "default".

Returns:

the fill parameter. May be null.

See Also:

setFill(java.lang.String)

setFill

public void setFill(String fill)

Initializes the fill parameter as a string.

Parameters:

fill - the fill parameter. May be null.

See Also:

getFill()

getParamGroupString

public String getParamGroupString()

Returns the parameter group associated to this reference.

Returns:

the parameter group as a string. May be null.

See Also:

setParamGroupString(java.lang.String)

setParamGroupString

public void setParamGroupString(String paramGroup)

Initializes the parameter group associated to this reference.

Parameters:

paramGroup - the parameter group. May be null.

See Also:

getParamGroupString()

getSoundAlign

public String getSoundAlign()

Returns the coarse 2D placement of the audio portion of a media element assigned to play within a given region. The default value is inherited from the region.
The following values are allowed:

both

Place the audio on both channels. If stereo or other dual-channel audio is used, the audio will be reproduced on both channels, implementation permitting.

left

Place the audio on the left channel only. If stereo audio is used, only the left source audio will be reproduced on the left audio channel, implementation permitting.

right

Place the audio on the right channel only. If stereo audio is used, only the right source audio will be reproduced on the right audio channel, implementation permitting.

Returns:

the sound alignment. May be null.

See Also:

setSoundAlign(java.lang.String), Region.getSoundAlign()

setSoundAlign

public void setSoundAlign(String soundAlign)

Initializes the coarse 2D placement of the audio portion of a media element assigned to play within a given region.

Parameters:

soundAlign - the sound alignment. May be null.

See Also:

getSoundAlign(), Region.setSoundAlign(java.lang.String)

acceptDown

public void acceptDown(SmilVisitor visitor)

Description copied from class: AbstractSmilElement

Accepts the specified SMIL playlist visitor.

Specified by:

acceptDown in class AbstractSmilElement

Parameters:

visitor - a SMIL playlist visitor. Shall not be null.