ActionScript® 3.0 Referenzhandbuch für die Adobe® Flash®-Plattform
Home  |  Liste der Pakete und Klassen ausblenden |  Pakete  |  Klassen  |  Neue Funktionen  |  Stichwortverzeichnis  |  Anhänge  |  Warum auf Englisch?
Filter: Daten werden vom Server abgerufen...
Daten werden vom Server abgerufen...
org.osmf.media 

PluginInfo  - AS3 OSMF

Paketorg.osmf.media
Klassepublic class PluginInfo
VererbungPluginInfo Inheritance Object

Sprachversion: ActionScript 3.0
Produktversion: OSMF 1.0
Laufzeitversionen: Flash Player 10, AIR 1.5

PluginInfo ist die Kapselung der Gruppe von MediaFactoryItem-Objekten, die der Anwendung nach dem Laden des Plugins zur Verfügung steht. Jedes Open Source Media Framework-Plugin muss eine Instanz oder Unterklasse von PluginInfo definieren, die der Anwendung die zum Erstellen und Laden des MediaElement des Plugins benötigten Informationen angibt.

Aus Sicht des Open Source Media Framework ist der Zweck des Plugins, die MediaFactoryItem-Objekte bereitzustellen, die die vom Plugin verarbeiteten Medien darstellen. Diese MediaFactoryItem-Objekte können Standardmedientypen wie Video, Audio oder Bild beschreiben, die von den integrierten MediaElements des Open Source Media Framework dargestellt werden können: VideoElement, AudioElement oder ImageElement. Häufiger ist es jedoch der Fall, dass ein Plugin eine bestimmte Art von spezialisierter Verarbeitung, z. B. eine angepasste Ladefunktion oder ein Medienelement für einen besonderen Einsatzzweck mit angepassten Merkmalsimplementierungen bereitstellt. Beispiel: Ein Plugin, das eine Verfolgungsfunktion bereitstellt, implementiert ein TrackingCompositeElement, das eine angepasste Ladefunktion und eine angepasste PlayTrait-Implementierung enthält, die die Verfolgung sowie das Video starten und stoppen.

Eine PluginInfo gibt dem Plugin auch die Möglichkeit, eine bestimmte Open Source Media Framework-Version über die isFrameworkVersionSupported()-Methode zu akzeptieren oder zurückzuweisen.

Ein dynamisches Plugin wird zur Laufzeit aus einer SWF-Datei geladen. Ein statisches Plugin wird als Teil der Open Source Media Framework-Anwendung kompiliert. Anwendungen, die versuchen, ein dynamisches Plugin zu laden, greifen im Stammordner der SWF-Plugindatei über die pluginInfo-Eigenschaft auf die Klasse zu, die PluginInfo erweitert. Wenn diese Klasse nicht gefunden wird, wird das Plugin nicht geladen. Eine Anwendung, die versucht, ein statisches Plugin zu laden, greift auf die vom PluginInfoResource-Objekt bereitgestellte PluginInfo zu.

Verwandte API-Elemente



Öffentliche Eigenschaften
 EigenschaftDefiniert von
 Inheritedconstructor : Object
Ein Verweis auf das Klassenobjekt oder die Konstruktorfunktion für eine angegebene Objektinstanz.
Object
  frameworkVersion : String
[schreibgeschützt] Die Framework-Version, unter der dieses Plugin kompiliert wurde.
PluginInfo
  mediaElementCreationNotificationFunction : Function
[schreibgeschützt] Optionale Funktion, die für jedes MediaElement aufgerufen wird, das aus der MediaFactory erstellt wird, der die MediaFactoryItem-Objekte dieses Plugins hinzugefügt werden.
PluginInfo
  numMediaFactoryItems : int
[schreibgeschützt] Die Anzahl der MediaFactoryItem-Objekte, die das Plugin für die ladende Anwendung bereitstellt.
PluginInfo
Geschützte Eigenschaften
 EigenschaftDefiniert von
  mediaFactoryItems : Vector.<MediaFactoryItem>
Die MediaFactoryItem-Objekte, die diese PluginInfo bereitstellt.
PluginInfo
Öffentliche Methoden
 MethodeDefiniert von
  
PluginInfo(mediaFactoryItems:Vector.<MediaFactoryItem> = null, mediaElementCreationNotificationFunction:Function = null)
Konstruktor.
PluginInfo
  
Gibt das MediaFactoryItem-Objekt an der angegebenen Indexposition zurück.
PluginInfo
 Inherited
Gibt an, ob für ein Objekt eine bestimmte Eigenschaft definiert wurde.
Object
  
Initialisierungsmethode, die vom Media Framework aufgerufen wird, wenn dieses Plugin initialisiert wird. Es stellt für das Plugin die Ressource bereit, mit der das Plugin angefordert wurde.
PluginInfo
  
Gibt „true“ zurück, wenn das Plugin die angegebene Version des Frameworks unterstützt. In diesem Fall lädt die ladende Anwendung das Plugin.
PluginInfo
 Inherited
Gibt an, ob eine Instanz der Object-Klasse in der Prototypkette des Objekts vorhanden ist, das als Parameter angegeben wurde.
Object
 Inherited
Gibt an, ob die angegebene Eigenschaft vorhanden ist und durchlaufen werden kann.
Object
 Inherited
Legt die Verfügbarkeit einer dynamischen Eigenschaft für Schleifenoperationen fest.
Object
 Inherited
Gibt die Stringdarstellung dieses Objekts zurück, formatiert entsprechend den Konventionen des Gebietsschemas.
Object
 Inherited
Gibt das angegebene Objekt als String zurück.
Object
 Inherited
Gibt den Grundwert des angegebenen Objekts zurück.
Object
Öffentliche Konstanten
 KonstanteDefiniert von
  PLUGIN_MEDIAFACTORY_NAMESPACE : String = "http://www.osmf.org/plugin/mediaFactory/1.0"
[statisch] Metadaten-Namespace-URL für eine MediaFactory, die vom Player an das Plugin übergeben wird.
PluginInfo
Eigenschaftendetails

frameworkVersion

Eigenschaft
frameworkVersion:String  [schreibgeschützt]

Sprachversion: ActionScript 3.0
Produktversion: OSMF 1.0
Laufzeitversionen: Flash Player 10, AIR 1.5

Die Version des Frameworks, unter der dieses Plugin kompiliert wurde. Die aktuelle Version kann aus org.osmf.utils.Version.version bezogen werden.



Implementierung
    public function get frameworkVersion():String

mediaElementCreationNotificationFunction

Eigenschaft 
mediaElementCreationNotificationFunction:Function  [schreibgeschützt]

Sprachversion: ActionScript 3.0
Produktversion: OSMF 1.0
Laufzeitversionen: Flash Player 10, AIR 1.5

Optionale Funktion, die für jedes MediaElement aufgerufen wird, das aus der MediaFactory erstellt wird, der die MediaFactoryItem-Objekte dieses Plugins hinzugefügt werden. Die Funktion muss einen Parameter vom Typ MediaElement annehmen und „void“ zurückgeben. Diese Callbackfunktion ist für Plugins nützlich, die benachrichtigt werden müssen, wenn andere MediaElements erstellt werden (damit sie auf sie warten oder sie steuern können).



Implementierung
    public function get mediaElementCreationNotificationFunction():Function

mediaFactoryItems

Eigenschaft 
mediaFactoryItems:Vector.<MediaFactoryItem>

Die MediaFactoryItem-Objekte, die diese PluginInfo bereitstellt.



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

numMediaFactoryItems

Eigenschaft 
numMediaFactoryItems:int  [schreibgeschützt]

Sprachversion: ActionScript 3.0
Produktversion: OSMF 1.0
Laufzeitversionen: Flash Player 10, AIR 1.5

Die Anzahl der MediaFactoryItem-Objekte, die das Plugin für die ladende Anwendung bereitstellt.



Implementierung
    public function get numMediaFactoryItems():int
Konstruktordetails

PluginInfo

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

Sprachversion: ActionScript 3.0
Produktversion: OSMF 1.0
Laufzeitversionen: Flash Player 10, AIR 1.5

Konstruktor.

Parameter
mediaFactoryItems:Vector.<MediaFactoryItem> (default = null) — Vektor der MediaFactoryItem-Objekte, die dieses Plugin bereitstellt.
 
mediaElementCreationNotificationFunction:Function (default = null) — Optionale Funktion. Sofern angegeben, wird sie für jedes MediaElement aufgerufen, das aus der MediaFactory erstellt wird, der dieses MediaFactoryItem hinzugefügt wird. Wenn angegeben, muss die Funktion einen Parameter vom Typ MediaElement annehmen und „void“ zurückgeben. Diese Callback-Funktion ist für MediaFactoryItems nützlich, die benachrichtigt werden müssen, wenn andere MediaElements erstellt werden (damit sie auf sie warten oder sie steuern können).
Methodendetails

getMediaFactoryItemAt

()Methode
public function getMediaFactoryItemAt(index:int):MediaFactoryItem

Sprachversion: ActionScript 3.0
Produktversion: OSMF 1.0
Laufzeitversionen: Flash Player 10, AIR 1.5

Gibt das MediaFactoryItem-Objekt an der angegebenen Indexposition zurück.

Gibt einen RangeError aus, wenn die Indexposition außerhalb des gültigen Bereichs liegt.

Parameter

index:int — Nullbasierte Indexposition des angeforderten MediaFactoryItem.

Rückgabewerte
MediaFactoryItem — Ein MediaFactoryItem-Objekt, das zu ladende Medien repräsentiert.

Verwandte API-Elemente

initializePlugin

()Methode 
public function initializePlugin(resource:MediaResourceBase):void

Sprachversion: ActionScript 3.0
Produktversion: OSMF 1.0
Laufzeitversionen: Flash Player 10, AIR 1.5

Initialisierungsmethode, die vom Media Framework aufgerufen wird, wenn dieses Plugin initialisiert wird. Es stellt für das Plugin die Ressource bereit, mit der das Plugin angefordert wurde. Hat standardmäßig keine Auswirkungen, jedoch können Plugins diese Methode überschreiben, um ihre eigene Initialisierungslogik anzugeben.

Beachten Sie, dass eine Instanz von PluginInfo instantiiert werden kann, bevor das Framework bestimmt hat, dass dieses Plugin tatsächlich verwendet wird. Deshalb wird nachdrücklich empfohlen, eine doppelte Initialisierung zu vermeiden und die Initialisierungslogik in einer Überschreibung dieser Methode zu platzieren.

Diese Methode wird vor getMediaFactoryItemAt oder get numMediaFactoryItems aufgerufen.

Parameter

resource:MediaResourceBase

isFrameworkVersionSupported

()Methode 
public function isFrameworkVersionSupported(version:String):Boolean

Sprachversion: ActionScript 3.0
Produktversion: OSMF 1.0
Laufzeitversionen: Flash Player 10, AIR 1.5

Gibt true zurück, wenn das Plugin die angegebene Version des Frameworks unterstützt. In diesem Fall lädt die ladende Anwendung das Plugin. Gibt false zurück, wenn das Plugin die angegebene Version des Frameworks nicht unterstützt. In diesem Fall lädt die ladende Anwendung das Plugin nicht.

Parameter

version:String — Versionsstring der Open Source Media Framework-Version.

Rückgabewerte
Boolean — Gibt true zurück, wenn die Version unterstützt wird.
Konstantendetails

PLUGIN_MEDIAFACTORY_NAMESPACE

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

Metadaten-Namespace-URL für eine MediaFactory, die vom Player an das Plugin übergeben wird.

Der Clientcode kann sie in der MediaResourceBase setzen, die an MediaFactory.loadPlugin übergeben wird. Sie wird dem Plugin in der MediaResourceBase angezeigt, die an PluginInfo.initializePlugin übergeben wird.





[ X ]Warum auf Englisch?
Inhalt des ActionScript 3.0-Referenzhandbuchs wird in englischer Sprache angezeigt

Nicht alle Teile des ActionScript 3.0-Referenzhandbuchs wurden in alle Sprachen übersetzt. Wenn der Text zu einem Sprachelement nicht übersetzt wurde, wird er auf Englisch angezeigt. Zum Beispiel wurden die Informationen zur ga.controls.HelpBox-Klasse nicht in andere Sprachen übersetzt. In der deutschen Version des Referenzhandbuchs erscheint der Abschnitt zur ga.controls.HelpBox-Klasse deshalb auf Englisch.