|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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
Method Summary | |
---|---|
PluginVersion |
getDetectedPluginVersion(java.lang.String playerName)
Returns the version of the plugin required by the specified playerName that is currently
installed AND enabled on the browser |
AbstractMediaPlayer |
getPlayer(java.lang.String playerName,
java.lang.String mediaURL,
boolean autoplay)
Returns the player with the specified playerName . |
AbstractMediaPlayer |
getPlayer(java.lang.String playerName,
java.lang.String mediaURL,
boolean autoplay,
java.lang.String height,
java.lang.String width)
Returns the player with the specified playerName . |
PlayerElement |
getPlayerElement(java.lang.String playerName,
java.lang.String playerId,
java.lang.String mediaURL,
boolean autoplay,
java.util.HashMap<java.lang.String,java.lang.String> params)
Returns the DOM element structure for the specified playerName . |
Method Detail |
---|
PlayerElement getPlayerElement(java.lang.String playerName, java.lang.String playerId, java.lang.String mediaURL, boolean autoplay, java.util.HashMap<java.lang.String,java.lang.String> params)
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
playerName
- the name of the required playerplayerId
- the HTML element id/name
that should be used for the playermediaURL
- the first URL of the media to be loaded by the playerautoplay
- true
if playback should start immediately, false
otherwiseparams
- other HTML parameters that should be associated with the DOM element
playerName
java.lang.IllegalArgumentException
- if playerName
does not exist in this factoryPluginVersion getDetectedPluginVersion(java.lang.String playerName) throws PluginNotFoundException
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
playerName
- the name of the player
PluginNotFoundException
- if the required plugin is not installed AND enabled
java.lang.IllegalArgumentException
- if playerName
does not exist in this factoryAbstractMediaPlayer getPlayer(java.lang.String playerName, java.lang.String mediaURL, boolean autoplay, java.lang.String height, java.lang.String width) throws LoadException, PluginNotFoundException, PluginVersionException
playerName
.
Implementation classes should throw IllegalArgumentException
if the playerName
is not supported by the factory
playerName
- mediaURL
- the URL of the media to playbackautoplay
- true
to start playing automatically, false
otherwiseheight
- the height of the playerwidth
- the width of the player.
LoadException
- if an error occurs while loading the media.
PluginVersionException
- if the required plugin version is not installed on the client.
PluginNotFoundException
- if the required plugin is not installed on the client.
java.lang.IllegalArgumentException
- if playerName
does not exist in this factoryAbstractMediaPlayer getPlayer(java.lang.String playerName, java.lang.String mediaURL, boolean autoplay) throws LoadException, PluginNotFoundException, PluginVersionException
playerName
.
Implementation classes should throw IllegalArgumentException
if the playerName
is not supported by the factory
playerName
- mediaURL
- the URL of the media to playbackautoplay
- true
to start playing automatically, false
otherwise
LoadException
- if an error occurs while loading the media.
PluginVersionException
- if the required plugin version is not installed on the client.
PluginNotFoundException
- if the required plugin is not installed on the client.
java.lang.IllegalArgumentException
- if playerName
does not exist in this factory
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |