christophedelory.playlist.asx
Class Param

java.lang.Object
  christophedelory.playlist.asx.Child
      christophedelory.playlist.asx.Param

public class Param
extends Child

Defines a custom parameter associated with a clip or show. This element allows users to place additional information about each clip inside the ENTRY element that contains it. A parameter can also be associated with the show rather than an individual clip, by placing this element directly after the ASX tag.
This ASX element is only available for Windows Media Player version 6.01 and later. The standard installation of Microsoft Internet Explorer 5 includes a compatible version of Windows Media Player.
Windows Media Player version 7.0 or later. Windows Media Player 9 Series or later is required for the predefined NAME attributes. Windows Media Player 10 or later is required for the predefined names CanPause, CanSeek, CanSkipBack, and CanSkipForward.

Version:

$Revision: 92 $

Author:

Christophe Delory

Constructor Summary

Param()
Builds a new and empty param element.

Param(String name, String value)
Builds a new param element from the specified inputs.

Method Summary

boolean	equals(Object o)
String	getName() Returns the name used to access the parameter value.
String	getValue() Returns the value associated with this parameter.
int	hashCode()
void	setName(String name) Initializes the name used to access the parameter value.
void	setValue(String value) Initializes the value associated with this parameter.

Methods inherited from class christophedelory.playlist.asx.Child

getParent, setParent

Methods inherited from class java.lang.Object

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

Constructor Detail

Param

public Param()

Builds a new and empty param element.

Param

public Param(String name,
             String value)

Builds a new param element from the specified inputs.

Parameters:

name - the name of the parameter.

value - the value of the parameter.

Throws:

NullPointerException - if name is null.

NullPointerException - if value is null.

Method Detail

getName

public String getName()

Returns the name used to access the parameter value. The name can be any valid string.
The following strings have already been defined:

AllowShuffle

The VALUE attribute specifies whether the metafile playlist allows the Windows Media Player shuffle feature to play the entries in random order. The VALUE attribute can be set to "Yes" or "No". The default value is "No".

CanPause

The VALUE attribute specifies whether the user can pause playback. The VALUE attribute can be set to "Yes" or "No". The default value is "Yes".

CanSeek

The VALUE attribute specifies whether the user can change the current playback position by using the seek bar, fast forward, or fast reverse. The VALUE attribute can be set to "Yes" or "No". The default value is "Yes".

CanSkipBack

The VALUE attribute specifies whether the user can skip backward to the previous playlist item by clicking Previous. The VALUE attribute can be set to "Yes" or "No". The default value is "Yes".

CanSkipForward

The VALUE attribute specifies whether the user can skip forward to the next playlist item by clicking Next. The VALUE attribute can be set to "Yes" or "No". The default value is "Yes".

CPRadioID

The VALUE attribute specifies the ID of a radio feed provided by a type 1 online store. That is, the VALUE attribute must be equal to the RadioID field of one of the radio feeds in the online store's catalog. The parent element is the ASX element.

Encoding

The VALUE attribute is set to "utf-8" to indicate that the metafile is a Unicode (UTF-8) encoded file.

HtmlFlink

The VALUE attribute is a string provided by a type 1 online store. Windows Media Player passes the string to the IWMPContentPartner::GetItemInfo method, which is implemented by the online store's plug-in. The GetItemInfo method returns the URL of the Web page to display in the Now Playing pane of the Player. The Web page has access to all of the methods that the External object exposes to type 1 stores. For a list of those methods, see External Object for Type 1 Online Stores.

HTMLView

The VALUE attribute specifies a URL that displays in the Now Playing pane of the full mode Player for the duration of the playlist or the current entry depending on whether the parent element is the ASX element or an ENTRY element. HTMLView is not supported for the Windows Media Player control.

Log:FieldName[:NameSpace]

The VALUE attribute specifies the value that the indicated log field will be set to. The :NameSpace portion of the NAME attribute is optional.

Prebuffer

The VALUE attribute specifies whether the next playlist entry begins buffering before the end of the current entry, which enables a seamless transition. The VALUE attribute can be set to "true" or "false".

ShowWhileBuffering

The VALUE attribute specifies whether an image file referenced by the current ENTRY element continues to display past its specified duration time while the next playlist entry is buffered. The VALUE attribute can be set to "true" or "false".

Returns:

the parameter name. Shall not be null.

See Also:

setName(java.lang.String)

setName

public void setName(String name)

Initializes the name used to access the parameter value.

Parameters:

name - the parameter name. Shall not be null.

Throws:

NullPointerException - if name is null.

See Also:

getName()

getValue

public String getValue()

Returns the value associated with this parameter. It can be either a numeric or string value.

Returns:

the parameter value. Shall not be null.

See Also:

setValue(java.lang.String)

setValue

public void setValue(String value)

Initializes the value associated with this parameter.

Parameters:

value - the parameter value. Shall not be null.

Throws:

NullPointerException - if value is null.

See Also:

getValue()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object