com.bramosystems.oss.player.core.client
Enum ConfigParameter

java.lang.Object
  java.lang.Enum<ConfigParameter>
      com.bramosystems.oss.player.core.client.ConfigParameter

All Implemented Interfaces:

Serializable, Comparable<ConfigParameter>

public enum ConfigParameter
extends Enum<ConfigParameter>

An enum of player configuration parameters.

The parameters are applied as HTML param tags on the underlying player plugin.

Since:

1.1

Author:

Sikiru Braheem

See Also:

AbstractMediaPlayer.setConfigParameter(ConfigParameter, ConfigValue)

Enum Constant Summary

BackgroundColor
Parameter for the background color property or a player.

QTScale
Parameter for QuickTimePlayers' Scale property.

TransparencyMode
Parameter for the transparency mode for a player (if available).

WMPUIMode
Parameter for WinMediaPlayers' UI Mode property.

Method Summary

Class[]	getValueType() Returns the required value type for this parameter.
static ConfigParameter	valueOf(String name) Returns the enum constant of this type with the specified name.
static ConfigParameter[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

TransparencyMode

public static final ConfigParameter TransparencyMode

Parameter for the transparency mode for a player (if available).

This parameter requires a TransparencyMode value type

WMPUIMode

public static final ConfigParameter WMPUIMode

Parameter for WinMediaPlayers' UI Mode property.

The mode indicates which controls are shown on the user interface.

This parameter requires a WinMediaPlayer.UIMode value type

QTScale

public static final ConfigParameter QTScale

Parameter for QuickTimePlayers' Scale property.

This parameter is used to scale the dimensions of a QuickTime movie. It requires either a QuickTimePlayer.Scale value type or a double value

A double value scales the movie by a factor of the value. For example, to play a movie at half its normal size, use QTScale with a value of 0.5

Since:

1.2

See Also:

QuickTimePlayer.Scale

BackgroundColor

public static final ConfigParameter BackgroundColor

Parameter for the background color property or a player.

This parameter is used to specify the background color for the exposed part of a players' alloted space The value should be specified as a CSS color value (i.e. hexadecimal RGB values)

Since:

1.2.1

Method Detail

values

public static ConfigParameter[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (ConfigParameter c : ConfigParameter.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static ConfigParameter valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getValueType

public Class[] getValueType()

Returns the required value type for this parameter.

Returns:

the required type of value