Packagecom.brightcove.api
Classpublic class BrightcovePlayerWrapper
InheritanceBrightcovePlayerWrapper Inheritance flash.display.Sprite



Public Methods
 MethodDefined By
  
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
  
getModule(moduleName:String):APIModule
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
Events
 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
Constructor Detail
BrightcovePlayerWrapper()Constructor
public function BrightcovePlayerWrapper(player:Sprite)

Wrapper object for Brightcove player to ensure all objects returned are wrapped in API SWC wrapper classes.

Parameters
player:Sprite — Brightcove player object to wrap API calls to.
Method Detail
addEventListener()method
override public function addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void

Adds a listener for an event.

Parameters

type:String — AS3 docs.
 
listener:Function — AS3 docs.
 
useCapture:Boolean (default = false) — AS3 docs.
 
priority:int (default = 0) — AS3 docs.
 
useWeakReference:Boolean (default = false) — AS3 docs.

getModule()method 
public function getModule(moduleName:String):APIModule

Returns the API module stored by the specified string.

Parameters

moduleName:String — name of the API module to retrieve.

Returns
APIModule — The API module stored as the specified string.
removeEventListener()method 
override public function removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void

Removes a listener for an event.

Parameters

type:String — AS3 docs.
 
listener:Function — AS3 docs.
 
useCapture:Boolean (default = false) — AS3 docs.

Event Detail
templateError Event
Event Object Type: com.brightcove.api.events.ErrorEvent
ErrorEvent.type property = com.brightcove.api.events.ErrorEvent.TEMPLATE_ERROR

Dispatched when there is some error condition in the player preventing load or playback.

The ErrorEvent.TEMPLATE_ERROR constant defines the value of the type property of the event object for a templateLoaded event.
templateLoaded Event  
Event Object Type: com.brightcove.api.events.ExperienceEvent
ExperienceEvent.type property = com.brightcove.api.events.ExperienceEvent.TEMPLATE_LOADED

Dispatched when player is first loaded into shell application.

The ExperienceEvent.TEMPLATE_LOADED constant defines the value of the type property of the event object for a templateLoaded event.