PluginInfo

Pacote	org.osmf.media
Classe	public class PluginInfo
Herança	PluginInfo Object

Versão da linguagem:

ActionScript 3.0

Versão de produto:

OSMF 1.0

Versões de runtime:

Flash Player 10, AIR 1.5

PluginInfo is the encapsulation of the set of MediaFactoryItem objects that will be available to the application after the plugin has been successfully loaded. Every Open Source Media Framework plugin must define an instance or subclass of PluginInfo to provide the application with the information it needs to create and load the plugin's MediaElement.

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.

Elementos da API relacionados

PluginInfoResource
MediaFactoryItem

Propriedades públicas

Ocultar propriedades públicas herdadas

Mostrar propriedades públicas herdadas

	Propriedade		Definido por
		constructor : Object Uma referência ao objeto de classe ou à função de construtor de uma determinada ocorrência de objeto.	Object
		frameworkVersion : String [somente leitura] The version of the framework that this plugin was compiled against.	PluginInfo
		mediaElementCreationNotificationFunction : Function [somente leitura] 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 [somente leitura] The number of MediaFactoryItem objects that the plugin exposes to the loading application.	PluginInfo

Propriedades protegidas

	Propriedade		Definido por
		mediaFactoryItems : Vector.<MediaFactoryItem> The MediaFactoryItem objects that this PluginInfo exposes.	PluginInfo

Métodos públicos

Ocultar métodos públicos herdados

Mostrar métodos públicos herdados

	Método		Definido por
		PluginInfo(mediaFactoryItems:Vector.<MediaFactoryItem> = null, mediaElementCreationNotificationFunction:Function = null) Constructor.	PluginInfo
		getMediaFactoryItemAt(index:int):MediaFactoryItem Returns the MediaFactoryItem object at the specified index.	PluginInfo
		hasOwnProperty(name:String):Boolean Indica se um objeto tem uma propriedade especificada definida.	Object
		initializePlugin(resource:MediaResourceBase):void 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
		isFrameworkVersionSupported(version:String):Boolean Returns true if the plugin supports the specified version of the framework, in which case the loading application loads the plugin.	PluginInfo
		isPrototypeOf(theClass:Object):Boolean Indica se uma ocorrência da classe Object está na cadeia de protótipos do objeto especificado como o parâmetro.	Object
		propertyIsEnumerable(name:String):Boolean Indica se a propriedade especificada existe e é enumerável.	Object
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Define a disponibilidade de uma propriedade dinâmica para operações de repetição.	Object
		toLocaleString():String Retorna a representação da string deste objeto, formatado segundo as convenções específicas para a localidade.	Object
		toString():String Retorna a representação de string do objeto especificado.	Object
		valueOf():Object Retorna o valor primitivo do objeto especificado.	Object

Constantes públicas

	Constante		Definido por
		PLUGIN_MEDIAFACTORY_NAMESPACE : String = "http://www.osmf.org/plugin/mediaFactory/1.0" [estático] Metadata namespace URL for a MediaFactory that is passed from player to plugin.	PluginInfo

Detalhes da propriedade

frameworkVersion

propriedade

frameworkVersion:String [somente leitura]

Versão da linguagem:

ActionScript 3.0

Versão de produto:

OSMF 1.0

Versões de runtime:

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.

Implementação
public function get frameworkVersion():String

mediaElementCreationNotificationFunction

propriedade

mediaElementCreationNotificationFunction:Function [somente leitura]

Versão da linguagem:

ActionScript 3.0

Versão de produto:

OSMF 1.0

Versões de runtime:

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).

Implementação
public function get mediaElementCreationNotificationFunction():Function

mediaFactoryItems

propriedade

mediaFactoryItems:Vector.<MediaFactoryItem>

The MediaFactoryItem objects that this PluginInfo exposes.

Implementação
protected function get mediaFactoryItems():Vector.<MediaFactoryItem>
protected function set mediaFactoryItems(value:Vector.<MediaFactoryItem>):void

numMediaFactoryItems

propriedade

numMediaFactoryItems:int [somente leitura]

Versão da linguagem:

ActionScript 3.0

Versão de produto:

OSMF 1.0

Versões de runtime:

Flash Player 10, AIR 1.5

The number of MediaFactoryItem objects that the plugin exposes to the loading application.

Implementação
public function get numMediaFactoryItems():int

Detalhes do construtor

()

Construtor

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

Versão da linguagem:

ActionScript 3.0

Versão de produto:

OSMF 1.0

Versões de runtime:

Flash Player 10, AIR 1.5

Constructor.

Parâmetros

	`mediaFactoryItems:Vector.<MediaFactoryItem>` (default = `null`) — Vector of MediaFactoryItem objects that this plugin exposes.

	`mediaElementCreationNotificationFunction:Function` (default = `null`) — Optional function which, if specified, is invoked for each MediaElement that is created from the MediaFactory to which this MediaFactoryItem is added. If specified, the function must take one param of type MediaElement, and return void. This callback function is useful for MediaFactoryItems which need to be notified when other MediaElements are created (e.g. so as to listen to or control them).

Detalhes do método

getMediaFactoryItemAt

()

método

public function getMediaFactoryItemAt(index:int):MediaFactoryItem

Versão da linguagem:

ActionScript 3.0

Versão de produto:

OSMF 1.0

Versões de runtime:

Flash Player 10, AIR 1.5

Returns the MediaFactoryItem object at the specified index.

If the index is out of range, throws a RangeError.

Parâmetros

index:int — Zero-based index position of the requested MediaFactoryItem.

Retorna

MediaFactoryItem — A MediaFactoryItem object representing media to be loaded.

Elementos da API relacionados

RangeError

initializePlugin

()

método

public function initializePlugin(resource:MediaResourceBase):void

Versão da linguagem:

ActionScript 3.0

Versão de produto:

OSMF 1.0

Versões de runtime:

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.

Parâmetros

resource:MediaResourceBase

isFrameworkVersionSupported

()

método

public function isFrameworkVersionSupported(version:String):Boolean

Versão da linguagem:

ActionScript 3.0

Versão de produto:

OSMF 1.0

Versões de runtime:

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.

Parâmetros

version:String — Version string of the Open Source Media Framework version.

Retorna

Boolean — Returns true if the version is supported.

Detalhes da constante

PLUGIN_MEDIAFACTORY_NAMESPACE

Constante

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.

Aspectos jurídicos | Política de privacidade on-line

PluginInfo - AS3 OSMF

Classes x

frameworkVersion

mediaElementCreationNotificationFunction

mediaFactoryItems

numMediaFactoryItems

PluginInfo

getMediaFactoryItemAt

initializePlugin

isFrameworkVersionSupported

PLUGIN_MEDIAFACTORY_NAMESPACE