com.bramosystems.oss.player.core.client

Class PlayerInfo

java.lang.Object

com.bramosystems.oss.player.core.client.PlayerInfo

All Implemented Interfaces:

Serializable

public class PlayerInfo
extends Object
implements Serializable

Wraps basic information about a player widget registered with the API.

Since:

1.3

Author:

Sikirulai Braheem

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
PlayerInfo(String providerName, String playerName, PluginVersion requiredPluginVersion, boolean hasPlaylistSupport, boolean hasMatrixSupport) Creates PlayerInfo object

Method Summary

Methods

Modifier and Type	Method and Description
PluginInfo	getDetectedPluginInfo() Returns the infomation object about the browser plugin that is used by the player widget
PluginVersion	getDetectedPluginVersion() Returns the version of the required player plugin detected on the browser
String	getPlayerName() Returns the name of the player
String	getProviderName() Returns the provider name of the player
Set<String>	getRegisteredExtensions() Returns the media format file extensions supported by the player
Set<String>	getRegisteredProtocols() Returns the streaming protocols supported by the player
PluginVersion	getRequiredPluginVersion() Returns the minimum plugin version required by the player
boolean	isHasMatrixSupport() Returns true if player has matrix support, false otherwise
boolean	isHasPlaylistSupport() Returns true if player has playlist support, false otherwise
void	setDetectedPluginInfo(PluginInfo detectedPluginInfo) Sets the infomation object about the browser plugin that is used by the player widget
void	setDetectedPluginVersion(PluginVersion detectedPluginVersion) Sets the version of the required player plugin detected on the browser
protected void	setRegisteredExtensions(Set<String> registeredExtensions) Sets the media format file extensions supported by the player
protected void	setRegisteredProtocols(Set<String> registeredProtocols) Sets the streaming protocols supported by the player
String	toString() Returns the name of the player and its provider in the format :: .

Methods inherited from class java.lang.Object

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

Constructor Detail

PlayerInfo

public PlayerInfo(String providerName,
          String playerName,
          PluginVersion requiredPluginVersion,
          boolean hasPlaylistSupport,
          boolean hasMatrixSupport)

Creates PlayerInfo object

Parameters:

providerName - the provider of the player

playerName - the name of the player

requiredPluginVersion - the minimum plugin version required by the player

hasPlaylistSupport - true if player supports playlists, false otherwise.

hasMatrixSupport - true if player supports matrix, false otherwise.

Method Detail

getProviderName

public String getProviderName()

Returns the provider name of the player

Returns:

the provider name

getPlayerName

public String getPlayerName()

Returns the name of the player

Returns:

the player name

getRequiredPluginVersion

public PluginVersion getRequiredPluginVersion()

Returns the minimum plugin version required by the player

Returns:

the required minimum plugin version

isHasMatrixSupport

public boolean isHasMatrixSupport()

Returns true if player has matrix support, false otherwise

Returns:

true if player has matrix support, false otherwise

See Also:

MatrixSupport

isHasPlaylistSupport

public boolean isHasPlaylistSupport()

Returns true if player has playlist support, false otherwise

Returns:

@code true} if player has playlist support, false otherwise

See Also:

PlaylistSupport

getDetectedPluginVersion

public PluginVersion getDetectedPluginVersion()

Returns the version of the required player plugin detected on the browser

Returns:

the player plugin version detected on the browser

setDetectedPluginVersion

public void setDetectedPluginVersion(PluginVersion detectedPluginVersion)

Sets the version of the required player plugin detected on the browser

Parameters:

detectedPluginVersion - the player plugin version detected on the browser

getRegisteredExtensions

public Set<String> getRegisteredExtensions()

Returns the media format file extensions supported by the player

Returns:

media file extensions supported by the player

setRegisteredExtensions

protected void setRegisteredExtensions(Set<String> registeredExtensions)

Sets the media format file extensions supported by the player

Parameters:

registeredExtensions - the supported media file format extensions

getRegisteredProtocols

public Set<String> getRegisteredProtocols()

Returns the streaming protocols supported by the player

Returns:

the supported streaming protocols

setRegisteredProtocols

protected void setRegisteredProtocols(Set<String> registeredProtocols)

Sets the streaming protocols supported by the player

Parameters:

registeredProtocols - the supported streaming protocols

setDetectedPluginInfo

public void setDetectedPluginInfo(PluginInfo detectedPluginInfo)

Sets the infomation object about the browser plugin that is used by the player widget

Parameters:

detectedPluginInfo - the detected PluginInfo object

Since:

2.0.1

getDetectedPluginInfo

public PluginInfo getDetectedPluginInfo()

Returns the infomation object about the browser plugin that is used by the player widget

Returns:

the detected PluginInfo object

Since:

2.0.1

toString

public String toString()

Returns the name of the player and its provider in the format :: .

Overrides:

toString in class Object

Returns:

name of the player widget represented by this object.

Since:

2.0.1