| Package | org.osmf.media |
| Class | public class PluginInfo |
| Inheritance | PluginInfo  Object |
| Language Version: | ActionScript 3.0 |
| Product Version: | OSMF 1.0 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
From the point of view of the Open Source Media Framework, the plugin's purpose is to expose the MediaFactoryItem objects that represent the media that the plugin handles. These MediaFactoryItem objects could describe standard media types such as video, audio, or image that can be represented by the built-in Open Source Media Framework MediaElements: VideoElement, AudioElement, or ImageElement. More likely, a plugin provides some type of specialized processing, such as a custom loader or special-purpose media element with custom implementations of the traits. For example, a plugin that provides tracking might implement a TrackingCompositeElement that includes a customized loader and a customized PlayTrait implementation that start and stop tracking as well as the video.
A PluginInfo also gives the plugin an opportunity to accept or reject a specific
Open Source Media Framework version through its isFrameworkVersionSupported() method.
A dynamic plugin is loaded at runtime from a SWF.
A static plugin is compiled as part of the Open Source Media Framework application.
An application attempting to load a dynamic plugin accesses the class
that extends PluginInfo through
the pluginInfo property on the root of the plugin SWF.
If this class is not found,
the plugin is not loaded.
An application attempting to load a static plugin accesses the PluginInfo
exposed by the PluginInfoResource object.
Related API Elements
Hide Inherited Public Properties
Show Inherited Public Properties| Property | Defined By | ||
|---|---|---|---|
 | constructor : Object
A reference to the class object or constructor function for a given object instance. | Object | |
| frameworkVersion : String [read-only]
The version of the framework that this plugin was compiled against. | PluginInfo | ||
| mediaElementCreationNotificationFunction : Function [read-only]
Optional function which is invoked for every MediaElement that is
created from the MediaFactory to which this plugin's MediaFactoryItem
objects are added. | PluginInfo | ||
| numMediaFactoryItems : int [read-only]
The number of MediaFactoryItem objects that the plugin
exposes to the loading application. | PluginInfo | ||
| Property | Defined By | ||
|---|---|---|---|
| mediaFactoryItems : Vector.<MediaFactoryItem>
The MediaFactoryItem objects that this PluginInfo exposes. | PluginInfo | ||
| Method | Defined By | ||
|---|---|---|---|
PluginInfo(mediaFactoryItems:Vector.<MediaFactoryItem> = null, mediaElementCreationNotificationFunction:Function = null)
Constructor. | PluginInfo | ||
Returns the MediaFactoryItem object at the specified index. | PluginInfo | ||
|
Indicates whether an object has a specified property defined. | Object | |
Initialization method invoked by the media framework when this plugin
is being initialized, and which provides the plugin the resource which
was used to request the plugin. | PluginInfo | ||
Returns true if the plugin supports the specified version
of the framework, in which case the loading application loads the plugin. | PluginInfo | ||
|
Indicates whether an instance of the Object class is in the prototype chain of the object specified
as the parameter. | Object | |
|
Indicates whether the specified property exists and is enumerable. | Object | |
|
Sets the availability of a dynamic property for loop operations. | Object | |
|
Returns the string representation of this object, formatted according to locale-specific conventions. | Object | |
|
Returns the string representation of the specified object. | Object | |
|
Returns the primitive value of the specified object. | Object | |
| Constant | Defined By | ||
|---|---|---|---|
| PLUGIN_MEDIAFACTORY_NAMESPACE : String = "http://www.osmf.org/plugin/mediaFactory/1.0" [static]
Metadata namespace URL for a MediaFactory that is passed from player
to plugin. | PluginInfo | ||
frameworkVersion | property |
frameworkVersion:String [read-only] | Language Version: | ActionScript 3.0 |
| Product Version: | OSMF 1.0 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
The version of the framework that this plugin was compiled against. The current version can be obtained from org.osmf.utils.Version.version.
Implementation
public function get frameworkVersion():StringmediaElementCreationNotificationFunction | property |
mediaElementCreationNotificationFunction:Function [read-only] | Language Version: | ActionScript 3.0 |
| Product Version: | OSMF 1.0 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
Optional function which is invoked for every MediaElement that is created from the MediaFactory to which this plugin's MediaFactoryItem objects are added. The function must take one param of type MediaElement, and return void. This callback function is useful for plugins who want to be notified when other MediaElement are created (e.g. so as to listen to or control them).
Implementation
public function get mediaElementCreationNotificationFunction():FunctionmediaFactoryItems | property |
mediaFactoryItems:Vector.<MediaFactoryItem>The MediaFactoryItem objects that this PluginInfo exposes.
Implementation
protected function get mediaFactoryItems():Vector.<MediaFactoryItem> protected function set mediaFactoryItems(value:Vector.<MediaFactoryItem>):voidnumMediaFactoryItems | property |
PluginInfo | () | Constructor |
public function PluginInfo(mediaFactoryItems:Vector.<MediaFactoryItem> = null, mediaElementCreationNotificationFunction:Function = null)| Language Version: | ActionScript 3.0 |
| Product Version: | OSMF 1.0 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
Constructor.
ParametersmediaFactoryItems:Vector.<MediaFactoryItem> (default = null) | |
mediaElementCreationNotificationFunction:Function (default = null) |
getMediaFactoryItemAt | () | method |
public function getMediaFactoryItemAt(index:int):MediaFactoryItem| Language Version: | ActionScript 3.0 |
| Product Version: | OSMF 1.0 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
Returns the MediaFactoryItem object at the specified index.
If the index is out of range, throws a RangeError.
Parameters
index:int — Zero-based index position of the requested MediaFactoryItem.
|
MediaFactoryItem — A MediaFactoryItem object representing media to be loaded.
|
Related API Elements
initializePlugin | () | method |
public function initializePlugin(resource:MediaResourceBase):void| Language Version: | ActionScript 3.0 |
| Product Version: | OSMF 1.0 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
Initialization method invoked by the media framework when this plugin is being initialized, and which provides the plugin the resource which was used to request the plugin. By default does nothing, but plugins can override this method to specify their own initialization logic.
Note that an instance of PluginInfo may be instantiated before the framework has determined that that plugin is truly going to be used, so it is strongly recommended that any initialization logic be placed within an override of this method to avoid duplicate initialization.
This method is called before getMediaFactoryItemAt or get numMediaFactoryItems.
Parameters
resource:MediaResourceBase |
isFrameworkVersionSupported | () | method |
public function isFrameworkVersionSupported(version:String):Boolean| Language Version: | ActionScript 3.0 |
| Product Version: | OSMF 1.0 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
Returns true if the plugin supports the specified version
of the framework, in which case the loading application loads the plugin.
Returns false if the plugin does not support the specified version
of the framework, in which case the loading application does not load the plugin.
Parameters
version:String — Version string of the Open Source Media Framework version.
|
Boolean — Returns true if the version is supported.
|
PLUGIN_MEDIAFACTORY_NAMESPACE | Constant |
public static const PLUGIN_MEDIAFACTORY_NAMESPACE:String = "http://www.osmf.org/plugin/mediaFactory/1.0"Metadata namespace URL for a MediaFactory that is passed from player to plugin.
Client code can set this on the MediaResourceBase that is passed
to MediaFactory.loadPlugin, and it will be exposed to
the plugin on the MediaResourceBase that is passed to
PluginInfo.initializePlugin.
Wed Nov 21 2018, 06:34 AM -08:00