用于 Adobe® Flash® Platform 的 ActionScript® 3.0 参考
主页  |  隐藏包列表和类列表 |   |   |  新增内容  |  索引  |  附录  |  为什么显示为英语?
过滤条件: 正在从服务器检索数据...
正在从服务器检索数据...
org.osmf.media 

PluginInfo  - AS3 OSMF

org.osmf.media
public class PluginInfo
继承PluginInfo Inheritance Object

语言版本: ActionScript 3.0
产品版本: OSMF 1.0
运行时版本: Flash Player 10, AIR 1.5

PluginInfo 是成功加载插件后,对适用于应用程序的 MediaFactoryItem 对象集的封装。每个 Open Source Media Framework 插件必须定义 PluginInfo 的实例或子类,才能为应用程序提供创建和加载插件的 MediaElement 所需的信息。

从 Open Source Media Framework 的角度看,插件的作用是公开表示该插件处理的媒体的 MediaFactoryItem 对象。这些 MediaFactoryItem 对象可以描述可由内置的 Open Source Media Framework MediaElement(VideoElement、AudioElement 或 ImageElement)表示的视频、音频或图像等标准媒体类型。插件很可能提供了某些专用的处理类型,如自定义加载器或带有特征的自定义实现的专用媒体元素。例如,提供跟踪功能的插件可以实现包括自定义加载器和自定义 PlayTrait 实现(可以启动和停止跟踪和视频)的 TrackingCompositeElement。

PluginInfo 还可以使插件通过 isFrameworkVersionSupported() 方法接收或拒绝特定的 Open Source Media Framework 版本。

动态插件在运行时从 SWF 加载。静态插件作为 Open Source Media Framework 应用程序的一部分编译。尝试加载动态插件的应用程序将访问插件 SWF 的根上通过 pluginInfo 属性扩展 PluginInfo 的类。如果找不到此类,则不加载插件。尝试加载静态插件的应用程序将访问由 PluginInfoResource 对象公开的 PluginInfo。

相关 API 元素



公共属性
 属性由以下参数定义
 Inheritedconstructor : Object
对类对象或给定对象实例的构造函数的引用。
Object
  frameworkVersion : String
[只读] 针对其编译此插件的框架的版本。
PluginInfo
  mediaElementCreationNotificationFunction : Function
[只读] 对每个 MediaElement(它是从添加了此插件的 MediaFactoryItem 对象的 MediaFactory 创建的)调用的可选函数。
PluginInfo
  numMediaFactoryItems : int
[只读] 插件对正在加载的应用程序公开的 MediaFactoryItem 对象的数目。
PluginInfo
受保护的属性
 属性由以下参数定义
  mediaFactoryItems : Vector.<MediaFactoryItem>
此 PluginInfo 公开的 MediaFactoryItem 对象。
PluginInfo
公共方法
 方法由以下参数定义
  
PluginInfo(mediaFactoryItems:Vector.<MediaFactoryItem> = null, mediaElementCreationNotificationFunction:Function = null)
构造函数。
PluginInfo
  
返回指定索引处的 MediaFactoryItem 对象。
PluginInfo
 Inherited
表示对象是否已经定义了指定的属性。
Object
  
初始化此插件时通过媒体框架调用的初始化方法,而且它可以为插件提供请求插件所用的资源。
PluginInfo
  
如果插件支持指定的框架版本,则返回 true,在这种情况下,正在加载的应用程序将加载插件。
PluginInfo
 Inherited
表示 Object 类的实例是否在指定为参数的对象的原型链中。
Object
 Inherited
表示指定的属性是否存在、是否可枚举。
Object
 Inherited
设置循环操作动态属性的可用性。
Object
 Inherited
返回此对象的字符串表示形式,其格式设置遵守区域设置特定的约定。
Object
 Inherited
返回指定对象的字符串表示形式。
Object
 Inherited
返回指定对象的原始值。
Object
公共常量
 常量由以下参数定义
  PLUGIN_MEDIAFACTORY_NAMESPACE : String = "http://www.osmf.org/plugin/mediaFactory/1.0"
[静态] 从播放器传递到插件的 MediaFactory 的元数据命名空间 URL。
PluginInfo
属性详细信息

frameworkVersion

属性
frameworkVersion:String  [只读]

语言版本: ActionScript 3.0
产品版本: OSMF 1.0
运行时版本: Flash Player 10, AIR 1.5

针对其编译此插件的框架的版本。当前版本可从 org.osmf.utils.Version.version 获取。



实现
    public function get frameworkVersion():String

mediaElementCreationNotificationFunction

属性 
mediaElementCreationNotificationFunction:Function  [只读]

语言版本: ActionScript 3.0
产品版本: OSMF 1.0
运行时版本: Flash Player 10, AIR 1.5

对每个 MediaElement(它是从添加了此插件的 MediaFactoryItem 对象的 MediaFactory 创建的)调用的可选函数。函数必须采用一个 MediaElement 类型的参数,并返回 void。此回调函数对于在创建其它 MediaElement 时需要通知的插件很有用(例如,以便侦听或控制它们)。



实现
    public function get mediaElementCreationNotificationFunction():Function

mediaFactoryItems

属性 
mediaFactoryItems:Vector.<MediaFactoryItem>

此 PluginInfo 公开的 MediaFactoryItem 对象。



实现
    protected function get mediaFactoryItems():Vector.<MediaFactoryItem>
    protected function set mediaFactoryItems(value:Vector.<MediaFactoryItem>):void

numMediaFactoryItems

属性 
numMediaFactoryItems:int  [只读]

语言版本: ActionScript 3.0
产品版本: OSMF 1.0
运行时版本: Flash Player 10, AIR 1.5

插件对正在加载的应用程序公开的 MediaFactoryItem 对象的数目。



实现
    public function get numMediaFactoryItems():int
构造函数详细信息

PluginInfo

()构造函数
public function PluginInfo(mediaFactoryItems:Vector.<MediaFactoryItem> = null, mediaElementCreationNotificationFunction:Function = null)

语言版本: ActionScript 3.0
产品版本: OSMF 1.0
运行时版本: Flash Player 10, AIR 1.5

构造函数。

参数
mediaFactoryItems:Vector.<MediaFactoryItem> (default = null) — 此插件公开的 MediaFactoryItem 对象的矢量。
 
mediaElementCreationNotificationFunction:Function (default = null) — 对每个 MediaElement(它是从添加了此 MediaFactoryItem 的 MediaFactory 创建的)调用的可选函数(如果已指定)。如果已指定,则函数必须采用一个 MediaElement 类型的参数,并返回 void。此回调函数对于在创建其它 MediaElement 时需要通知的 MediaFactoryItem 很有用(例如,以便侦听或控制它们)。
方法详细信息

getMediaFactoryItemAt

()方法
public function getMediaFactoryItemAt(index:int):MediaFactoryItem

语言版本: ActionScript 3.0
产品版本: OSMF 1.0
运行时版本: Flash Player 10, AIR 1.5

返回指定索引处的 MediaFactoryItem 对象。

如果此索引超出范围,则引发 RangeError。

参数

index:int — 请求的 MediaFactoryItem 的从零开始的索引位置。

返回
MediaFactoryItem — 表示要加载的媒体的 MediaFactoryItem 对象。

相关 API 元素

initializePlugin

()方法 
public function initializePlugin(resource:MediaResourceBase):void

语言版本: ActionScript 3.0
产品版本: OSMF 1.0
运行时版本: Flash Player 10, AIR 1.5

初始化此插件时通过媒体框架调用的初始化方法,而且它可以为插件提供请求插件所用的资源。默认情况下,不执行任何操作,但插件可以覆盖此方法以指定自己的初始化逻辑。

请注意,在框架确定确实要使用插件之前,PluginInfo 实例可能已实例化,因此强烈建议将任何初始化逻辑置于此方法的覆盖范围内,以避免重复初始化。

在 getMediaFactoryItemAt 或 get numMediaFactoryItems 之前调用此方法。

参数

resource:MediaResourceBase

isFrameworkVersionSupported

()方法 
public function isFrameworkVersionSupported(version:String):Boolean

语言版本: ActionScript 3.0
产品版本: OSMF 1.0
运行时版本: Flash Player 10, AIR 1.5

如果插件支持指定的框架版本,则返回 true,在这种情况下,正在加载的应用程序将加载插件。如果插件不支持指定的框架版本,则返回 false,在这种情况下,正在加载的应用程序将不加载插件。

参数

version:String — Open Source Media Framework 版本的版本字符串。

返回
Boolean — 如果支持此版本,则返回 true
常量详细信息

PLUGIN_MEDIAFACTORY_NAMESPACE

常量
public static const PLUGIN_MEDIAFACTORY_NAMESPACE:String = "http://www.osmf.org/plugin/mediaFactory/1.0"

从播放器传递到插件的 MediaFactory 的元数据命名空间 URL。

客户端代码可对传递到 MediaFactory.loadPlugin 的 MediaResourceBase 设置此 URL,并将对传递到 PluginInfo.initializePlugin 的 MediaResourceBase 上的插件公开。





[ X ]为什么显示为英语?
《ActionScript 3.0 参考》中的内容以英语显示

《ActionScript 3.0 参考》中的部分内容未翻译成所有语言。当某个语言元素未翻译时,将显示为英语。例如,ga.controls.HelpBox 类未翻译成任何语言。因此在简体中文版的参考中,ga.controls.HelpBox 类显示为英语。