Packagecom.brightcove.api
Classpublic class BrightcoveModuleWrapper
InheritanceBrightcoveModuleWrapper Inheritance flash.events.EventDispatcher



Public Methods
 MethodDefined By
  
BrightcoveModuleWrapper(playerInterface:IEventDispatcher)
Wrapper object for Brightcove player interface to ensure all objects returned are wrapped in API SWC wrapper classes.
BrightcoveModuleWrapper
  
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
[override] Adds a listener for an event.
BrightcoveModuleWrapper
  
getModule(moduleName:String):APIModule
Returns the API module stored by the specified string.
BrightcoveModuleWrapper
  
Loads all API modules into the player.
BrightcoveModuleWrapper
  
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
[override] Removes a listener for an event.
BrightcoveModuleWrapper
Events
 Event Summary Defined By
  Dispatched when player has loaded its API modules after a call to loadModules().BrightcoveModuleWrapper
  Dispatched when player is first loaded into shell application.BrightcoveModuleWrapper
Constructor Detail
BrightcoveModuleWrapper()Constructor
public function BrightcoveModuleWrapper(playerInterface:IEventDispatcher)

Wrapper object for Brightcove player interface to ensure all objects returned are wrapped in API SWC wrapper classes. See the Using BrightcoveModuleWrapper section in the article, Creating Custom Player Components, and the Wrapping a SWFLoader or Module SWF section in the article, Player ActionScript Wrapper Classes, for a code examples.

Parameters
playerInterface:IEventDispatcher — Brightcove player interface 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.
loadModules()method 
public function loadModules():void

Loads all API modules into the player. This should be used if the API has not been enabled for the player and the modules have not previously loaded.

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
modulesLoaded Event
Event Object Type: com.brightcove.api.events.ExperienceEvent
ExperienceEvent.type property = com.brightcove.api.events.ExperienceEvent.MODULES_LOADED

Dispatched when player has loaded its API modules after a call to loadModules().

The ExperienceEvent.MODULES_LOADED constant defines the value of the type property of the event object for a modulesLoaded 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.