| Package | org.osmf.media |
| Classe | public class PluginInfo |
| Héritage | PluginInfo  Object |
| Version du langage: | ActionScript 3.0 |
| Version du produit: | OSMF 1.0 |
| Versions du moteur d’exécution: | Flash Player 10, AIR 1.5 |
Du point de vue du Media Framework Open Source, l’objectif du module externe est d’exposer les objets MediaFactoryItem qui représentent le média que le module externe gère. Ces objets MediaFactoryItem peuvent décrire des types de média standard, par exemple des vidéos, des sons ou des images qui peuvent être représentés par les MediaElements du Media Framework Open Source : VideoElement, AudioElement ou ImageElement. Il est plus probable qu’un module externe fournisse un type de traitement spécialisé, notamment un objet loader personnalisé ou un élément multimédia à fonctionnalité spécifique avec des implémentations personnalisées des traits. Par exemple, un module externe qui assure le suivi peut implémenter un TrackingCompositeElement qui inclut un objet loader personnalisé et une implémentation personnalisée de PlayTrait qui démarre et arrête le suivi ainsi que la vidéo.
Un PluginInfo donne également au module externe la possibilité d’accepter ou de rejeter une version spécifique de Media Framework Open Source via sa méthode isFrameworkVersionSupported().
Un module externe dynamique est chargé au moment de l’exécution à partir d’un fichier SWF. Un module externe statique est compilé comme faisant partie de l’application Media Framework Open Source. Une application tentant de charger un module externe dynamique accède à la classe qui étend le PluginInfo via la propriété pluginInfo à la racine du module externe SWF. Si cette classe est introuvable, le module externe n’est pas chargé. Une application tentant de charger un module externe statique accède au PluginInfo exposé par l’objet PluginInfoResource.
Eléments de l’API associés
Masquer les propriétés publiques héritées
Afficher les propriétés publiques héritées| Propriété | Défini par | ||
|---|---|---|---|
 | constructor : Object
Référence à l’objet de classe ou à la fonction constructeur d’une occurrence donnée d’un objet. | Object | |
| frameworkVersion : String [lecture seule]
Version de la structure par rapport à laquelle le module externe a été compilé. | PluginInfo | ||
| mediaElementCreationNotificationFunction : Function [lecture seule]
Fonction facultative qui est appelée pour chaque MediaElement créé à partir du MediaFactory auquel les objets de ce MediaFactoryItem sont ajoutés. | PluginInfo | ||
| numMediaFactoryItems : int [lecture seule]
Nombre d’objets MediaFactoryItem que le module externe expose à l’application de chargement. | PluginInfo | ||
| Propriété | Défini par | ||
|---|---|---|---|
| mediaFactoryItems : Vector.<MediaFactoryItem>
Objets MediaFactoryItem que ce PluginInfo expose. | PluginInfo | ||
| Méthode | Défini par | ||
|---|---|---|---|
PluginInfo(mediaFactoryItems:Vector.<MediaFactoryItem> = null, mediaElementCreationNotificationFunction:Function = null)
Constructeur. | PluginInfo | ||
Renvoie l’objet MediaFactoryItem situé à l’index spécifié. | PluginInfo | ||
|
Indique si la propriété spécifiée d’un objet est définie. | Object | |
Méthode d’initialisation appelée par le Media Framework lorsque ce module externe est en cours d’initialisation et qui fournit au module externe la ressource utilisée pour demander le module externe. | PluginInfo | ||
Renvoie true si le module externe prend en charge la version de la structure, auquel cas l’application de chargement charge le module externe. | PluginInfo | ||
|
Indique si une occurrence de la classe Object figure dans la chaîne de prototype de l’objet spécifié en tant que paramètre. | Object | |
|
Indique si la propriété spécifiée existe et est énumérable. | Object | |
|
Définit la disponibilité d’une propriété dynamique pour les opérations en boucle. | Object | |
|
Renvoie la représentation de chaîne de cet objet, formatée selon les paramètres régionaux en vigueur. | Object | |
|
Renvoie la représentation sous forme de chaîne de l’objet spécifié. | Object | |
|
Renvoie la valeur primitive de l’objet spécifié. | Object | |
| Constante | Défini par | ||
|---|---|---|---|
| PLUGIN_MEDIAFACTORY_NAMESPACE : String = "http://www.osmf.org/plugin/mediaFactory/1.0" [statique]
URL d’espace de noms Metadata pour un MediaFactory qui est transmis du lecteur au module externe. | PluginInfo | ||
frameworkVersion | propriété |
frameworkVersion:String [lecture seule] | Version du langage: | ActionScript 3.0 |
| Version du produit: | OSMF 1.0 |
| Versions du moteur d’exécution: | Flash Player 10, AIR 1.5 |
Version de la structure par rapport à laquelle le module externe a été compilé. La version actuelle peut être obtenue depuis org.osmf.utils.Version.version.
Implémentation
public function get frameworkVersion():StringmediaElementCreationNotificationFunction | propriété |
mediaElementCreationNotificationFunction:Function [lecture seule] | Version du langage: | ActionScript 3.0 |
| Version du produit: | OSMF 1.0 |
| Versions du moteur d’exécution: | Flash Player 10, AIR 1.5 |
Fonction facultative qui est appelée pour chaque MediaElement créé à partir du MediaFactory auquel les objets de ce MediaFactoryItem sont ajoutés. La fonction doit prendre un paramètre de type MediaElement et le renvoyer vide. Cette fonction de rappel est utile pour les modules externes qui veulent être avertis lorsque d’autres MediaElements sont créés (notamment, pour les écouter ou les contrôler).
Implémentation
public function get mediaElementCreationNotificationFunction():FunctionmediaFactoryItems | propriété |
mediaFactoryItems:Vector.<MediaFactoryItem>Objets MediaFactoryItem que ce PluginInfo expose.
Implémentation
protected function get mediaFactoryItems():Vector.<MediaFactoryItem> protected function set mediaFactoryItems(value:Vector.<MediaFactoryItem>):voidnumMediaFactoryItems | propriété |
numMediaFactoryItems:int [lecture seule] | Version du langage: | ActionScript 3.0 |
| Version du produit: | OSMF 1.0 |
| Versions du moteur d’exécution: | Flash Player 10, AIR 1.5 |
Nombre d’objets MediaFactoryItem que le module externe expose à l’application de chargement.
Implémentation
public function get numMediaFactoryItems():intPluginInfo | () | Constructeur |
public function PluginInfo(mediaFactoryItems:Vector.<MediaFactoryItem> = null, mediaElementCreationNotificationFunction:Function = null)| Version du langage: | ActionScript 3.0 |
| Version du produit: | OSMF 1.0 |
| Versions du moteur d’exécution: | Flash Player 10, AIR 1.5 |
Constructeur.
ParamètresmediaFactoryItems:Vector.<MediaFactoryItem> (default = null) | |
mediaElementCreationNotificationFunction:Function (default = null) |
getMediaFactoryItemAt | () | méthode |
public function getMediaFactoryItemAt(index:int):MediaFactoryItem| Version du langage: | ActionScript 3.0 |
| Version du produit: | OSMF 1.0 |
| Versions du moteur d’exécution: | Flash Player 10, AIR 1.5 |
Renvoie l’objet MediaFactoryItem situé à l’index spécifié.
Si l’index est hors limites, renvoie une exception RangeError.
Paramètres
index:int — Position d’index basée sur zéro du MediaFactoryItem demandé.
|
MediaFactoryItem — Un objet MediaFactoryItem représentant un média à charger.
|
Eléments de l’API associés
initializePlugin | () | méthode |
public function initializePlugin(resource:MediaResourceBase):void| Version du langage: | ActionScript 3.0 |
| Version du produit: | OSMF 1.0 |
| Versions du moteur d’exécution: | Flash Player 10, AIR 1.5 |
Méthode d’initialisation appelée par le Media Framework lorsque ce module externe est en cours d’initialisation et qui fournit au module externe la ressource utilisée pour demander le module externe. Par défaut, n’a aucun effet, mais les modules externes peuvent annuler cette méthode pour utiliser leur propre logique d’initialisation.
Notez que l’instance du PluginInfo peut être instanciée avant que la structure n’ait déterminé que ce module externe va réellement être utilisé. Il est donc fortement recommandé que les logiques d’initialisation soient placées dans un remplacement de la méthode pour éviter une initialisation en double.
Cette méthode est appelée avant getMediaFactoryItemAt ou getnumMediaFactoryItems.
Paramètres
resource:MediaResourceBase |
isFrameworkVersionSupported | () | méthode |
public function isFrameworkVersionSupported(version:String):Boolean| Version du langage: | ActionScript 3.0 |
| Version du produit: | OSMF 1.0 |
| Versions du moteur d’exécution: | Flash Player 10, AIR 1.5 |
Renvoie true si le module externe prend en charge la version de la structure, auquel cas l’application de chargement charge le module externe. Renvoie false si le module externe ne prend pas en charge la version de la structure, auquel cas l’application de chargement ne charge pas le module externe.
Paramètres
version:String — Chaîne de version de la version Media Framework Open Source.
|
Boolean — Renvoie true si la version est prise en charge.
|
PLUGIN_MEDIAFACTORY_NAMESPACE | Constante |
public static const PLUGIN_MEDIAFACTORY_NAMESPACE:String = "http://www.osmf.org/plugin/mediaFactory/1.0"URL d’espace de noms Metadata pour un MediaFactory qui est transmis du lecteur au module externe.
Le code client peut le définir sur le MediaResourceBase qui est transmis au MediaFactory.loadPlugin et il sera exposé au module externe sur le MediaResourceBase qui est transmis au PluginInfo.initializePlugin.
Tue Jun 12 2018, 09:30 AM Z