| 套件 | org.osmf.media |
| 類別 | public class PluginInfo |
| 繼承 | PluginInfo  Object |
| 語言版本: | ActionScript 3.0 |
| 產品版本: | OSMF 1.0 |
| 執行階段版本: | 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.
相關 API 元素
隱藏繼承公用屬性
顯示繼承公用屬性| 屬性 | 定義自 | ||
|---|---|---|---|
 | constructor : Object
類別物件的參照或是特定物件實體的建構函數。 | Object | |
| frameworkVersion : String [唯讀]
The version of the framework that this plugin was compiled against. | PluginInfo | ||
| mediaElementCreationNotificationFunction : Function [唯讀]
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 [唯讀]
The number of MediaFactoryItem objects that the plugin
exposes to the loading application. | PluginInfo | ||
| 屬性 | 定義自 | ||
|---|---|---|---|
| mediaFactoryItems : Vector.<MediaFactoryItem>
The MediaFactoryItem objects that this PluginInfo exposes. | PluginInfo | ||
| 方法 | 定義自 | ||
|---|---|---|---|
PluginInfo(mediaFactoryItems:Vector.<MediaFactoryItem> = null, mediaElementCreationNotificationFunction:Function = null)
Constructor. | PluginInfo | ||
Returns the MediaFactoryItem object at the specified index. | PluginInfo | ||
|
指出物件是否有已定義的指定屬性。 | 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 | ||
|
指出 Object 類別的實體是否位於指定為參數的物件原型鏈中。 | Object | |
|
指出指定的屬性是否存在，以及是否可列舉。 | Object | |
|
為迴圈作業設定動態屬性的可用性。 | Object | |
|
傳回代表此物件的字串，根據地區特定慣例進行格式化。 | Object | |
|
會傳回指定之物件的字串形式。 | Object | |
|
會傳回指定之物件的基本值。 | Object | |
| 常數 | 定義自 | ||
|---|---|---|---|
| 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. | PluginInfo | ||
frameworkVersion | 屬性 |
mediaElementCreationNotificationFunction | 屬性 |
mediaElementCreationNotificationFunction:Function [唯讀] | 語言版本: | ActionScript 3.0 |
| 產品版本: | OSMF 1.0 |
| 執行階段版本: | 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).
實作
public function get mediaElementCreationNotificationFunction():FunctionmediaFactoryItems | 屬性 |
mediaFactoryItems:Vector.<MediaFactoryItem>The MediaFactoryItem objects that this PluginInfo exposes.
實作
protected function get mediaFactoryItems():Vector.<MediaFactoryItem> protected function set mediaFactoryItems(value:Vector.<MediaFactoryItem>):voidnumMediaFactoryItems | 屬性 |
PluginInfo | () | 建構函式 |
public function PluginInfo(mediaFactoryItems:Vector.<MediaFactoryItem> = null, mediaElementCreationNotificationFunction:Function = null)| 語言版本: | ActionScript 3.0 |
| 產品版本: | OSMF 1.0 |
| 執行階段版本: | Flash Player 10, AIR 1.5 |
Constructor.
參數mediaFactoryItems:Vector.<MediaFactoryItem> (default = null) | |
mediaElementCreationNotificationFunction:Function (default = null) |
getMediaFactoryItemAt | () | 方法 |
public function getMediaFactoryItemAt(index:int):MediaFactoryItem| 語言版本: | ActionScript 3.0 |
| 產品版本: | OSMF 1.0 |
| 執行階段版本: | Flash Player 10, AIR 1.5 |
Returns the MediaFactoryItem object at the specified index.
If the index is out of range, throws a RangeError.
參數
index:int — Zero-based index position of the requested MediaFactoryItem.
|
MediaFactoryItem — A MediaFactoryItem object representing media to be loaded.
|
相關 API 元素
initializePlugin | () | 方法 |
public function initializePlugin(resource:MediaResourceBase):void| 語言版本: | ActionScript 3.0 |
| 產品版本: | OSMF 1.0 |
| 執行階段版本: | 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.
參數
resource:MediaResourceBase |
isFrameworkVersionSupported | () | 方法 |
public function isFrameworkVersionSupported(version:String):Boolean| 語言版本: | ActionScript 3.0 |
| 產品版本: | OSMF 1.0 |
| 執行階段版本: | 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.
參數
version:String — Version string of the Open Source Media Framework version.
|
Boolean — Returns true if the version is supported.
|
PLUGIN_MEDIAFACTORY_NAMESPACE | 常數 |
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, 03:47 PM Z