com.bramosystems.oss.player.core.client.spi

Interface PlayerProviderFactory

public interface PlayerProviderFactory

Interface defines the methods required of player provider implementations. The implementation classes are consulted by the API framework during player widget creation.

Note: Classes that implement this interface should be annotated with PlayerProvider to be recognized during compilation

Since:

1.3

Author:

Sikirulai Braheem

Method Summary

Methods

Modifier and Type	Method and Description
PluginInfo	getDetectedPluginInfo(String playerName) Returns the information of the plugin required by the specified playerName that is currently installed AND enabled on the browser
PluginVersion	getDetectedPluginVersion(String playerName) Returns the version of the plugin required by the specified playerName that is currently installed AND enabled on the browser
Set<String>	getPermittedMediaProtocols(String playerName, PluginVersion version) Returns the set of media URL protocols that can be used with the specified player.
Set<String>	getPermittedMimeTypes(String playerName, PluginVersion version) Returns the set of media file extensions that can be used with the specified player.
AbstractMediaPlayer	getPlayer(String playerName, String mediaURL, boolean autoplay) Returns the player with the specified playerName.
AbstractMediaPlayer	getPlayer(String playerName, String mediaURL, boolean autoplay, String height, String width) Returns the player with the specified playerName.
PlayerElement	getPlayerElement(String playerName, String playerId, String mediaURL, boolean autoplay, HashMap<String,String> params) Returns the DOM element structure for the specified playerName.
void	init(ConfigurationContext context) Initializes the provider with the specified configuration context

Method Detail

init

void init(ConfigurationContext context)

Initializes the provider with the specified configuration context

Since:

2.0

getPlayerElement

PlayerElement getPlayerElement(String playerName,
                             String playerId,
                             String mediaURL,
                             boolean autoplay,
                             HashMap<String,String> params)

Returns the DOM element structure for the specified playerName. The DOM element structure will be inserted into the page when required.

Implementation classes should throw IllegalArgumentException if the playerName is not supported by the factory

Parameters:

playerName - the name of the required player

playerId - the HTML element id/name that should be used for the player

mediaURL - the first URL of the media to be loaded by the player

autoplay - true if playback should start immediately, false otherwise

params - other HTML parameters that should be associated with the DOM element

Returns:

the DOM element structure for the specified playerName

Throws:

IllegalArgumentException - if playerName does not exist in this factory

getDetectedPluginVersion

PluginVersion getDetectedPluginVersion(String playerName)
                                       throws PluginNotFoundException

Returns the version of the plugin required by the specified playerName that is currently installed AND enabled on the browser

The detection methods in the PlayerUtil class may be used by implementation classes if applicable.

Implementation classes should throw IllegalArgumentException if the playerName is not supported by the factory

Parameters:

playerName - the name of the player

Returns:

the version of the required plugin that is installed and enabled on the browser

Throws:

PluginNotFoundException - if the required plugin is not installed AND enabled

IllegalArgumentException - if playerName does not exist in this factory

getDetectedPluginInfo

PluginInfo getDetectedPluginInfo(String playerName)
                                 throws PluginNotFoundException

Returns the information of the plugin required by the specified playerName that is currently installed AND enabled on the browser

The detection methods in the PlayerUtil class may be used by implementation classes if applicable.

Implementation classes should throw IllegalArgumentException if the playerName is not supported by the factory

Parameters:

playerName - the name of the player

Returns:

the information of the required plugin that is installed and enabled on the browser

Throws:

PluginNotFoundException - if the required plugin is not installed AND enabled

IllegalArgumentException - if playerName does not exist in this factory

Since:

2.0.1

getPlayer

AbstractMediaPlayer getPlayer(String playerName,
                            String mediaURL,
                            boolean autoplay,
                            String height,
                            String width)
                              throws PluginNotFoundException,
                                     PluginVersionException

Returns the player with the specified playerName.

Implementation classes should throw IllegalArgumentException if the playerName is not supported by the factory

Parameters:

playerName - the player name

mediaURL - the URL of the media to playback

autoplay - true to start playing automatically, false otherwise

height - the height of the player

width - the width of the player.

Returns:

the player implementation

Throws:

PluginVersionException - if the required plugin version is not installed on the client.

PluginNotFoundException - if the required plugin is not installed on the client.

IllegalArgumentException - if playerName does not exist in this factory

getPlayer

AbstractMediaPlayer getPlayer(String playerName,
                            String mediaURL,
                            boolean autoplay)
                              throws PluginNotFoundException,
                                     PluginVersionException

Returns the player with the specified playerName.

Implementation classes should throw IllegalArgumentException if the playerName is not supported by the factory

Parameters:

playerName -

mediaURL - the URL of the media to playback

autoplay - true to start playing automatically, false otherwise

Returns:

the player implementation

Throws:

PluginVersionException - if the required plugin version is not installed on the client.

PluginNotFoundException - if the required plugin is not installed on the client.

IllegalArgumentException - if playerName does not exist in this factory

getPermittedMimeTypes

Set<String> getPermittedMimeTypes(String playerName,
                                PluginVersion version)

Returns the set of media file extensions that can be used with the specified player. The extensions are used with the dynamic player selection algorithm.

Parameters:

playerName - the player name

version - the plugin version

Returns:

set of media file extensions

Throws:

IllegalArgumentException - if playerName does not exist in this factory

Since:

2.0.1

getPermittedMediaProtocols

Set<String> getPermittedMediaProtocols(String playerName,
                                     PluginVersion version)

Returns the set of media URL protocols that can be used with the specified player. The URL protocols are used with the dynamic player selection algorithm.

Parameters:

playerName - the player name

version - the plugin version

Returns:

set of media URL protocols

Throws:

IllegalArgumentException - if playerName does not exist in this factory

Since:

2.0.1