| パッケージ | org.osmf.media |
| クラス | public class PluginInfo |
| 継承 | PluginInfo  Object |
| 言語バージョン: | ActionScript 3.0 |
| 製品バージョン: | OSMF 1.0 |
| ランタイムバージョン: | Flash Player 10, AIR 1.5 |
Open Source Media Framework の観点からすると、プラグインの目的は、プラグインで処理するメディアを表す MediaFactoryItem オブジェクトを公開することです。MediaFactoryItem オブジェクトは、標準的なメディアタイプ（ビデオやオーディオ、イメージなど）を記述できました。これらのメディアタイプは、組み込まれている Open Source Media Framework の MediaElement（VideoElement、AudioElement または ImageElement）で表すことができます。さらに、プラグインは、特性のカスタム実装により、カスタムローダーや特殊なメディアエレメントのようなある種の特別な処理を提供します。例えば、トラッキングを提供するプラグインで、TrackingCompositeElement を実装し、これに含まれたカスタマイズローダーやカスタマイズ PlayTrait でビデオと同じようにトラッキングを開始したり終了したりする実装なども考えられます。
また、PluginInfo を使用すると、プラグインで isFrameworkVersionSupported() メソッドを使用して、Open Source Media Framework の特定のバージョンを許可したり拒否したりすることもできます。
動的プラグインは、実行時に SWF からロードされます。静的プラグインは、Open Source Media Framework アプリケーションの一部としてコンパイルされます。動的プラグインのロードを実行するアプリケーションは、プラグイン SWF のルートの pluginInfo プロパティを介して、PluginInfo を拡張するクラスにアクセスします。このクラスが見つからなかった場合、プラグインはロードされません。静的プラグインのロードを実行するアプリケーションは、PluginInfoResource オブジェクトで公開されている PluginInfo にアクセスします。
関連する API エレメント
継承されるパブリックプロパティを隠す
継承されるパブリックプロパティを表示| プロパティ | 定義元 | ||
|---|---|---|---|
 | constructor : Object
指定されたオブジェクトインスタンスのクラスオブジェクトまたはコンストラクター関数への参照です。 | Object | |
| frameworkVersion : String [読み取り専用]
このプラグインがコンパイルされたフレームワークのバージョンです。 | PluginInfo | ||
| mediaElementCreationNotificationFunction : Function [読み取り専用]
オプションの関数です。MediaFactory から作成され、このプラグインの MediaFactoryItem オブジェクトが追加される MediaElement ごとに呼び出されます。 | PluginInfo | ||
| numMediaFactoryItems : int [読み取り専用]
プラグインがロード元のアプリケーションに公開している MediaFactoryItem オブジェクトの数です。 | PluginInfo | ||
| プロパティ | 定義元 | ||
|---|---|---|---|
| mediaFactoryItems : Vector.<MediaFactoryItem>
この PluginInfo で公開されている MediaFactoryItem オブジェクトです。 | PluginInfo | ||
| メソッド | 定義元 | ||
|---|---|---|---|
PluginInfo(mediaFactoryItems:Vector.<MediaFactoryItem> = null, mediaElementCreationNotificationFunction:Function = null)
コンストラクターです。 | PluginInfo | ||
指定されたインデックスにある MediaFactoryItem オブジェクトを返します。 | PluginInfo | ||
|
オブジェクトに指定されたプロパティが定義されているかどうかを示します。 | Object | |
このプラグインが初期化されるときに、メディアフレームワークによって呼び出される初期化メソッドです。このメソッドは、プラグインの要求時に使用されたリソースをプラグインに提供します。 | PluginInfo | ||
指定されたバージョンのフレームワークをプラグインがサポートしている場合は、true を返します。この場合、ロード元のアプリケーションはプラグインをロードします。 | PluginInfo | ||
|
Object クラスのインスタンスが、パラメーターとして指定されたオブジェクトのプロトタイプチェーン内にあるかどうかを示します。 | Object | |
|
指定されたプロパティが存在し、列挙できるかどうかを示します。 | Object | |
|
ループ処理に対するダイナミックプロパティの可用性を設定します。 | Object | |
|
ロケール固有の規則に従って書式設定された、このオブジェクトのストリング表現を返します。 | Object | |
|
指定されたオブジェクトのストリング表現を返します。 | Object | |
|
指定されたオブジェクトのプリミティブな値を返します。 | Object | |
| 定数 | 定義元 | ||
|---|---|---|---|
| PLUGIN_MEDIAFACTORY_NAMESPACE : String = "http://www.osmf.org/plugin/mediaFactory/1.0" [静的]
Player からプラグインに渡される MediaFactory の Metadata の名前空間 URL です。 | PluginInfo | ||
frameworkVersion | プロパティ |
mediaElementCreationNotificationFunction | プロパティ |
mediaElementCreationNotificationFunction:Function [読み取り専用] | 言語バージョン: | ActionScript 3.0 |
| 製品バージョン: | OSMF 1.0 |
| ランタイムバージョン: | Flash Player 10, AIR 1.5 |
オプションの関数です。MediaFactory から作成され、このプラグインの MediaFactoryItem オブジェクトが追加される MediaElement ごとに呼び出されます。この関数は MediaElement 型の 1 つのパラメーターを持ち、void を返す必要があります。このコールバック関数は、他の MediaElement が作成されたときに、（例えば、これらを受け取ったり制御するために）通知したいプラグインにとって便利です。
実装
public function get mediaElementCreationNotificationFunction():FunctionmediaFactoryItems | プロパティ |
mediaFactoryItems:Vector.<MediaFactoryItem>この PluginInfo で公開されている MediaFactoryItem オブジェクトです。
実装
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 |
コンストラクターです。
パラメーター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 |
指定されたインデックスにある MediaFactoryItem オブジェクトを返します。
インデックスが範囲外の場合、RangeError がスローされます。
パラメーター
index:int — 要求された MediaFactoryItem の 0 から始まるインデックス位置です。
|
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"Player からプラグインに渡される MediaFactory の Metadata の名前空間 URL です。
クライアントコードでは、MediaFactory.loadPlugin に渡される MediaResourceBase でこの値を設定できます。クライアントコードは、PluginInfo.initializePlugin に渡される MediaResourceBase でプラグインに公開されます。
Tue Jun 12 2018, 10:34 AM Z