Packagecom.brightcove.api.modules
Classpublic class APIModule
InheritanceAPIModule Inheritance flash.events.EventDispatcher
Subclasses AdvertisingModule, AuthModule, CaptionsModule, ContentModule, CuePointsModule, ExperienceModule, MenuModule, SearchModule, SocialModule, VideoPlayerModule

Abstract base class for all API modules. This can not be used outside of Brightcove classes.



Public Properties
 PropertyDefined By
  module : Object
[read-only] Returns the instance of the module that is wrapped by this instance.
APIModule
Public Methods
 MethodDefined By
  
APIModule(pModule:Object)
Constructor.
APIModule
  
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = true):void
[override] Adds a listener for an event.
APIModule
  
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
[override] Removes a listener for an event.
APIModule
Property Detail
moduleproperty
module:Object  [read-only]

Returns the instance of the module that is wrapped by this instance.


Implementation
    public function get module():Object
Constructor Detail
APIModule()Constructor
public function APIModule(pModule:Object)

Constructor.

Parameters
pModule:Object
Method Detail
addEventListener()method
override public function addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = true):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 = true) — AS3 docs.

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.