| Package | com.brightcove.api |
| Class | public class BrightcovePlayerWrapper |
| Inheritance | BrightcovePlayerWrapper  flash.display.Sprite |
| Method | Defined By | ||
|---|---|---|---|
BrightcovePlayerWrapper(player:Sprite)
Wrapper object for Brightcove player to ensure all objects returned are wrapped in API SWC wrapper classes. | BrightcovePlayerWrapper | ||
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void [override]
Adds a listener for an event. | BrightcovePlayerWrapper | ||
Returns the API module stored by the specified string. | BrightcovePlayerWrapper | ||
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void [override]
Removes a listener for an event. | BrightcovePlayerWrapper | ||
| Event | Summary | Defined By | ||
|---|---|---|---|---|
| Dispatched when there is some error condition in the player preventing load or playback. | BrightcovePlayerWrapper | |||
| Dispatched when player is first loaded into shell application. | BrightcovePlayerWrapper | |||
| BrightcovePlayerWrapper | () | Constructor |
public function BrightcovePlayerWrapper(player:Sprite)Wrapper object for Brightcove player to ensure all objects returned are wrapped in API SWC wrapper classes.
Parametersplayer:Sprite — Brightcove player object to wrap API calls to.
|
| addEventListener | () | method |
override public function addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):voidAdds a listener for an event.
Parameters
type:String — AS3 docs.
| |
listener:Function — AS3 docs.
| |
useCapture:Boolean (default = false) | |
priority:int (default = 0) | |
useWeakReference:Boolean (default = false) |
| getModule | () | method |
public function getModule(moduleName:String):APIModuleReturns the API module stored by the specified string.
Parameters
moduleName:String — name of the API module to retrieve.
|
APIModule — The API module stored as the specified string.
|
| removeEventListener | () | method |
override public function removeEventListener(type:String, listener:Function, useCapture:Boolean = false):voidRemoves a listener for an event.
Parameters
type:String — AS3 docs.
| |
listener:Function — AS3 docs.
| |
useCapture:Boolean (default = false) |
| templateError | Event |
com.brightcove.api.events.ErrorEventcom.brightcove.api.events.ErrorEvent.TEMPLATE_ERRORDispatched when there is some error condition in the player preventing load or playback.
The ErrorEvent.TEMPLATE_ERROR constant defines the value of thetype property of the event object for a
templateLoaded event.
| templateLoaded | Event |
com.brightcove.api.events.ExperienceEventcom.brightcove.api.events.ExperienceEvent.TEMPLATE_LOADEDDispatched when player is first loaded into shell application.
The ExperienceEvent.TEMPLATE_LOADED constant defines the value of thetype property of the event object for a
templateLoaded event.