christophedelory.playlist.asx
Class Entry

java.lang.Object
  christophedelory.playlist.asx.Child
      christophedelory.playlist.asx.AsxElement
          christophedelory.playlist.asx.AsxOrEntryElement
              christophedelory.playlist.asx.Entry

public class Entry
extends AsxOrEntryElement

Defines a media clip. This element is the fundamental construct in an ASX file. The ENTRY element and its associated attributes define meta-information for a single, logical piece of content, called a clip. Child elements within the scope of an ENTRY element define media content for the WMP control to open (REF), information about the clip that the WMP control will display as text (AUTHOR, COPYRIGHT, TITLE), and other settings related to the clip. The REF child element links the content to be streamed for the parent ENTRY element. Though the script will not break, the ENTRY is meaningless without a REF child.

Version:

$Revision: 92 $

Author:

Christophe Delory

Constructor Summary

Entry()

Method Summary

void	addReference(Reference ref) Adds a reference to this ASX.
String	getClientSkipString() Returns a value indicating whether the user can skip forward past the clip.
Duration	getDuration() Returns the length of time the WMP control will render a stream.
Marker	getEndMarker() Returns the marker at which Windows Media Player ends rendering the stream.
List<Reference>	getReferences() Returns the list of references defined for this ASX.
String	getSkipIfRefString() Returns the value indicating whether the Windows Media Player control should skip this clip when the ENTRY element is included in a second ASX file through the use of an ENTRYREF element.
Marker	getStartMarker() Returns the marker at which Windows Media Player starts rendering the stream.
Duration	getStartTime() Returns the start time of this ENTRY.
boolean	isClientSkip() Indicates whether the user can skip forward past the clip.
boolean	isSkipIfRef() Indicates whether the Windows Media Player control should skip this clip when the ENTRY element is included in a second ASX file through the use of an ENTRYREF element.
void	setClientSkip(boolean clientSkip) Indicates whether the user can skip forward past the clip.
void	setClientSkipString(String clientSkip) Initializes the value indicating whether the user can skip forward past the clip.
void	setDuration(Duration duration) Initializes the length of time the WMP control will render a stream.
void	setEndMarker(Marker endMarker) Initializes the marker at which Windows Media Player ends rendering the stream.
void	setSkipIfRef(boolean skipIfRef) Indicates whether the Windows Media Player control should skip this clip when the ENTRY element is included in a second ASX file through the use of an ENTRYREF element.
void	setSkipIfRefString(String skipIfRef) Initializes the value indicating whether the Windows Media Player control should skip this clip when the ENTRY element is included in a second ASX file through the use of an ENTRYREF element.
void	setStartMarker(Marker startMarker) Initializes the marker at which Windows Media Player starts rendering the stream.
void	setStartTime(Duration startTime) Initializes the start time of this ENTRY.

Methods inherited from class christophedelory.playlist.asx.AsxOrEntryElement

addLogURL, addParam, findParamValue, getAbstract, getAuthor, getBanner, getBase, getCopyright, getLogURLs, getMoreInfo, getParams, getPreviewDuration, getTitle, setAbstract, setAuthor, setBanner, setBase, setCopyright, setMoreInfo, setPreviewDuration, setTitle

Methods inherited from class christophedelory.playlist.asx.Child

getParent, setParent

Methods inherited from class java.lang.Object

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

Constructor Detail

Entry

public Entry()

Method Detail

getClientSkipString

public String getClientSkipString()

Returns a value indicating whether the user can skip forward past the clip. If the value of the CLIENTSKIP attribute is NO, the user cannot skip forward past the piece of content defined by the ENTRY element. This does not work if the child REF element references another metafile. Nested metafiles should be referenced using the ENTRYREF element.
Possible values include the following:

YES

User can skip forward past the clip.

NO

User cannot skip forward past the clip.

The default value is "YES".

Returns:

the associated value as a string. May be null.

See Also:

setClientSkipString(java.lang.String), isClientSkip()

setClientSkipString

public void setClientSkipString(String clientSkip)

Initializes the value indicating whether the user can skip forward past the clip.

Parameters:

clientSkip - the value. May be null.

See Also:

getClientSkipString(), setClientSkip(boolean)

isClientSkip

public boolean isClientSkip()

Indicates whether the user can skip forward past the clip.

Returns:

the associated boolean.

See Also:

setClientSkip(boolean), getClientSkipString()

setClientSkip

public void setClientSkip(boolean clientSkip)

Indicates whether the user can skip forward past the clip.

Parameters:

clientSkip - the associated boolean.

See Also:

isClientSkip(), setClientSkipString(java.lang.String)

getSkipIfRefString

public String getSkipIfRefString()

Returns the value indicating whether the Windows Media Player control should skip this clip when the ENTRY element is included in a second ASX file through the use of an ENTRYREF element. The SKIPIFREF attribute pertains only to ENTRY elements that are included in a second ASX file through the use of an ENTRYREF element. The ENTRYREF element references another ASX file for logical inclusion in the current file. If the value of the SKIPIFREF attribute for an ENTRY element from the referenced ASX file is YES, the WMP control ignores this pulled-in entry, and moves on to the next ENTRY element, if any. The next ENTRY element can be the next entry in the original file, or the next entry in the ASX file referenced in the ENTRYREF element.
Possible values include the following:

YES

The WMP control will ignore this entry, if referenced through an ENTRYREF element.

NO

The WMP control will not ignore this entry.

The default value is "NO".

Returns:

the associated value. May be null.

See Also:

setSkipIfRefString(java.lang.String), isSkipIfRef()

setSkipIfRefString

public void setSkipIfRefString(String skipIfRef)

Initializes the value indicating whether the Windows Media Player control should skip this clip when the ENTRY element is included in a second ASX file through the use of an ENTRYREF element.

Parameters:

skipIfRef - a value. May be null.

See Also:

getSkipIfRefString(), setSkipIfRef(boolean)

isSkipIfRef

public boolean isSkipIfRef()

Indicates whether the Windows Media Player control should skip this clip when the ENTRY element is included in a second ASX file through the use of an ENTRYREF element.

Returns:

the associated boolean.

See Also:

setSkipIfRef(boolean), getSkipIfRefString()

setSkipIfRef

public void setSkipIfRef(boolean skipIfRef)

Indicates whether the Windows Media Player control should skip this clip when the ENTRY element is included in a second ASX file through the use of an ENTRYREF element.

Parameters:

skipIfRef - the associated boolean.

See Also:

isSkipIfRef(), setSkipIfRefString(java.lang.String)

getDuration

public Duration getDuration()

Returns the length of time the WMP control will render a stream. A DURATION element defined within a REF element overrides one that appears within the REF element's parent ENTRY element.

Returns:

a duration. May be null.

See Also:

setDuration(christophedelory.playlist.asx.Duration)

setDuration

public void setDuration(Duration duration)

Initializes the length of time the WMP control will render a stream.

Parameters:

duration - a duration. May be null.

See Also:

getDuration()

getStartTime

public Duration getStartTime()

Returns the start time of this ENTRY. Defines a time index into the content from which the stream must play. This element can be used only with stored, on-demand content that has been indexed.

Returns:

a start time. May be null.

See Also:

setStartTime(christophedelory.playlist.asx.Duration)

setStartTime

public void setStartTime(Duration startTime)

Initializes the start time of this ENTRY.

Parameters:

startTime - a start time. May be null.

See Also:

getStartTime()

getStartMarker

public Marker getStartMarker()

Returns the marker at which Windows Media Player starts rendering the stream. A STARTMARKER element defined within a REF element takes precedence over a STARTMARKER element defined within the REF element's parent ENTRY element. A STARTMARKER element also takes precedence over a STARTTIME element. If the marker specified by a STARTMARKER element occurs later in the stream than the marker defined by an ENDMARKER element, no content plays, but no error is generated.

Returns:

a start marker. May be null.

See Also:

setStartMarker(christophedelory.playlist.asx.Marker)

setStartMarker

public void setStartMarker(Marker startMarker)

Initializes the marker at which Windows Media Player starts rendering the stream.

Parameters:

startMarker - a start marker. May be null.

See Also:

getStartMarker()

getEndMarker

public Marker getEndMarker()

Returns the marker at which Windows Media Player ends rendering the stream. In preview mode, reaching an end marker stops the preview, even if the time specified by the PREVIEWDURATION element has not elapsed. The ENDMARKER element takes precedence over the DURATION element. If the ENDMARKER is hit before the time specified by DURATION has elapsed, playback will end. An ENDMARKER element defined within a REF element takes precedence over an ENDMARKER defined within the REF element's parent ENTRY element. If the marker specified by an END MARKER element occurs earlier in the stream than the marker defined by a STARTMARKER element, no content plays, but no error is generated.

Returns:

an end marker. May be null.

See Also:

setEndMarker(christophedelory.playlist.asx.Marker)

setEndMarker

public void setEndMarker(Marker endMarker)

Initializes the marker at which Windows Media Player ends rendering the stream.

Parameters:

endMarker - an end marker. May be null.

See Also:

getEndMarker()

addReference

public void addReference(Reference ref)

Adds a reference to this ASX.

Parameters:

ref - an ASX reference. Shall not be null.

Throws:

NullPointerException - if ref is null.

See Also:

getReferences()

getReferences

public List<Reference> getReferences()

Returns the list of references defined for this ASX.

Returns:

a list of references. May be empty but not null.

See Also:

addReference(christophedelory.playlist.asx.Reference)