Packagecom.brightcove.api
Classpublic class BrightcoveFlexComponent
InheritanceBrightcoveFlexComponent Inheritance mx.core.UIComponent

Flex class to wrap the BrightcovePlayer snippet in order to simplify use within Flex applications as well as to provide strong typing of objects retrieved through the API, like the internal modules and components in the player. See the Embedding in a Flex application section in the article, Player ActionScript Wrapper Classes, for a code example.



Public Properties
 PropertyDefined By
  autoLoad : Boolean
Returns whether the nested player is set to autoload upon instantiation of this object.
BrightcoveFlexComponent
  playerClass : Class
Returns the fully qualified class name of the Brightcove player to instantiate.
BrightcoveFlexComponent
Public Methods
 MethodDefined By
  
Constructor.
BrightcoveFlexComponent
  
getModule(moduleName:String):APIModule
Returns the API module stored by the specified string.
BrightcoveFlexComponent
  
load():void
Instantiates the BrightcovePlayer which loads the Brightcove player SWF.
BrightcoveFlexComponent
Events
 Event Summary Defined By
  Dispatched when there is some error condition in the player preventing load or playback.BrightcoveFlexComponent
  Dispatched when player is first loaded into shell application.BrightcoveFlexComponent
Property Detail
autoLoadproperty
autoLoad:Boolean

Returns whether the nested player is set to autoload upon instantiation of this object.


Implementation
    public function get autoLoad():Boolean
    public function set autoLoad(value:Boolean):void
playerClassproperty 
playerClass:Class

Returns the fully qualified class name of the Brightcove player to instantiate. This allows you to change the name and package structure of the BrightcovePlayer class generated by the Brightcove Publishing module.


Implementation
    public function get playerClass():Class
    public function set playerClass(value:Class):void
Constructor Detail
BrightcoveFlexComponent()Constructor
public function BrightcoveFlexComponent()

Constructor.

Method Detail
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.
load()method 
public function load():void

Instantiates the BrightcovePlayer which loads the Brightcove player SWF.

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.