| Paket | org.osmf.media |
| Klass | public class PluginInfo |
| Arv | PluginInfo  Object |
| Språkversion: | ActionScript 3.0 |
| Produktversion: | OSMF 1.0 |
| Körningsmiljöversioner: | 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.
Relaterade API-element
Dölj ärvda publika egenskaper
Visa ärvda publika egenskaper| Egenskap | Definieras med | ||
|---|---|---|---|
 | constructor : Object
En referens till klassobjektet eller konstruktorfunktionen för en given objektinstans. | Object | |
| frameworkVersion : String [skrivskyddad]
The version of the framework that this plugin was compiled against. | PluginInfo | ||
| mediaElementCreationNotificationFunction : Function [skrivskyddad]
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 [skrivskyddad]
The number of MediaFactoryItem objects that the plugin
exposes to the loading application. | PluginInfo | ||
| Egenskap | Definieras med | ||
|---|---|---|---|
| mediaFactoryItems : Vector.<MediaFactoryItem>
The MediaFactoryItem objects that this PluginInfo exposes. | PluginInfo | ||
| Metod | Definieras med | ||
|---|---|---|---|
PluginInfo(mediaFactoryItems:Vector.<MediaFactoryItem> = null, mediaElementCreationNotificationFunction:Function = null)
Constructor. | PluginInfo | ||
Returns the MediaFactoryItem object at the specified index. | PluginInfo | ||
|
Anger om det finns en egenskap angiven för ett objekt. | 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 | ||
|
Anger om en instans av klassen Object finns i prototypkedjan för objektet som anges som parameter. | Object | |
|
Anger om den angivna egenskapen finns och är uppräkningsbar. | Object | |
|
Anger tillgänglighet för en dynamisk egenskap för slingåtgärder. | Object | |
|
Returnerar det här objektets strängrepresentation, formaterad i enlighet med språkspecifika konventioner. | Object | |
|
Returnerar det angivna objektets strängbeteckning. | Object | |
|
Returnerar det angivna objektets primitiva värde. | Object | |
| Konstant | Definieras med | ||
|---|---|---|---|
| PLUGIN_MEDIAFACTORY_NAMESPACE : String = "http://www.osmf.org/plugin/mediaFactory/1.0" [statisk]
Metadata namespace URL for a MediaFactory that is passed from player
to plugin. | PluginInfo | ||
frameworkVersion | egenskap |
frameworkVersion:String [skrivskyddad] | Språkversion: | ActionScript 3.0 |
| Produktversion: | OSMF 1.0 |
| Körningsmiljöversioner: | 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.
Implementering
public function get frameworkVersion():StringmediaElementCreationNotificationFunction | egenskap |
mediaElementCreationNotificationFunction:Function [skrivskyddad] | Språkversion: | ActionScript 3.0 |
| Produktversion: | OSMF 1.0 |
| Körningsmiljöversioner: | 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).
Implementering
public function get mediaElementCreationNotificationFunction():FunctionmediaFactoryItems | egenskap |
mediaFactoryItems:Vector.<MediaFactoryItem>The MediaFactoryItem objects that this PluginInfo exposes.
Implementering
protected function get mediaFactoryItems():Vector.<MediaFactoryItem> protected function set mediaFactoryItems(value:Vector.<MediaFactoryItem>):voidnumMediaFactoryItems | egenskap |
PluginInfo | () | Konstruktor |
public function PluginInfo(mediaFactoryItems:Vector.<MediaFactoryItem> = null, mediaElementCreationNotificationFunction:Function = null)| Språkversion: | ActionScript 3.0 |
| Produktversion: | OSMF 1.0 |
| Körningsmiljöversioner: | Flash Player 10, AIR 1.5 |
Constructor.
ParametrarmediaFactoryItems:Vector.<MediaFactoryItem> (default = null) | |
mediaElementCreationNotificationFunction:Function (default = null) |
getMediaFactoryItemAt | () | metod |
public function getMediaFactoryItemAt(index:int):MediaFactoryItem| Språkversion: | ActionScript 3.0 |
| Produktversion: | OSMF 1.0 |
| Körningsmiljöversioner: | Flash Player 10, AIR 1.5 |
Returns the MediaFactoryItem object at the specified index.
If the index is out of range, throws a RangeError.
Parametrar
index:int — Zero-based index position of the requested MediaFactoryItem.
|
MediaFactoryItem — A MediaFactoryItem object representing media to be loaded.
|
Relaterade API-element
initializePlugin | () | metod |
public function initializePlugin(resource:MediaResourceBase):void| Språkversion: | ActionScript 3.0 |
| Produktversion: | OSMF 1.0 |
| Körningsmiljöversioner: | 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.
Parametrar
resource:MediaResourceBase |
isFrameworkVersionSupported | () | metod |
public function isFrameworkVersionSupported(version:String):Boolean| Språkversion: | ActionScript 3.0 |
| Produktversion: | OSMF 1.0 |
| Körningsmiljöversioner: | 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.
Parametrar
version:String — Version string of the Open Source Media Framework version.
|
Boolean — Returns true if the version is supported.
|
PLUGIN_MEDIAFACTORY_NAMESPACE | Konstant |
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.
Tue Jun 12 2018, 01:40 PM Z