Packageorg.openvideoplayer.plugins
Interfacepublic interface IOvpPlugIn

This is a Plug-in interface for the Open Video Player code base. Each plug-in needs to implement this interface on it's main display object (meaning the Application in Flex or the Document Class in Flash). There is some redundancy in the names of the methods, this is to insure there are no method name collisions with base classes or other interfaces in the plug-in's main display object.



Public Properties
 PropertyDefined By
  ovpPlugInCoreVersion : String
[read-only] Should return the OVP version the plug-in was built against.
IOvpPlugIn
  ovpPlugInDescription : String
[read-only] Should return a human readable description of the plug-in.
IOvpPlugIn
  ovpPlugInName : String
[read-only] Should return the human readable name for the plug-in.
IOvpPlugIn
  ovpPlugInTracingOn : Boolean
Tells the plug-in to turn on/off tracing.
IOvpPlugIn
  ovpPlugInVersion : String
[read-only] Should return the version of the plug-in.
IOvpPlugIn
Public Methods
 MethodDefined By
  
Called from the player.
IOvpPlugIn
Property Detail
ovpPlugInCoreVersionproperty
ovpPlugInCoreVersion:String  [read-only]

Should return the OVP version the plug-in was built against.


Implementation
    public function get ovpPlugInCoreVersion():String
ovpPlugInDescriptionproperty 
ovpPlugInDescription:String  [read-only]

Should return a human readable description of the plug-in.


Implementation
    public function get ovpPlugInDescription():String
ovpPlugInNameproperty 
ovpPlugInName:String  [read-only]

Should return the human readable name for the plug-in.


Implementation
    public function get ovpPlugInName():String
ovpPlugInTracingOnproperty 
ovpPlugInTracingOn:Boolean

Tells the plug-in to turn on/off tracing.


Implementation
    public function get ovpPlugInTracingOn():Boolean
    public function set ovpPlugInTracingOn(value:Boolean):void
ovpPlugInVersionproperty 
ovpPlugInVersion:String  [read-only]

Should return the version of the plug-in. Note this is independent from the property below and allows a plug-in to version itself independent of the OVP core version it is built against.


Implementation
    public function get ovpPlugInVersion():String
Method Detail
initOvpPlugIn()method
public function initOvpPlugIn(player:IOvpPlayer):void

Called from the player. Allows a plug-in to call properties, methods, and listen for events coming from the player.

Parameters

player:IOvpPlayer

See also