Adobe® Flash® Platform 用 ActionScript® 3.0 リファレンスガイド
ホーム  |  パッケージおよびクラスリストの非表示 |  パッケージ  |  クラス  |  新機能  |  索引  |  付録  |  英語で表示される理由
フィルター: サーバーからデータを取得しています...
サーバーからデータを取得しています...
org.osmf.media 

MediaFactory  - AS3 OSMF

パッケージorg.osmf.media
クラスpublic class MediaFactory
継承MediaFactory Inheritance EventDispatcher Inheritance Object
サブクラス DefaultMediaFactory

言語バージョン: ActionScript 3.0
製品バージョン: OSMF 1.0
ランタイムバージョン: Flash Player 10, AIR 1.5

MediaFactory は、メディアエレメントのファクトリクラスを表します。

ファクトリの操作では、MediaResourceBase を入力して伴い、MediaElement を出力として生成します。

MediaFactory は、MediaFactoryItem オブジェクトのリストを保持します。各 MediaFactoryItem オブジェクトは、特定の MediaElement の作成に必要なすべての情報をカプセル化します。MediaFactory は、各 MediaFactoryItem の canHandleResourceFunction メソッドに依存して、指定された MediaResourceBase を処理可能な MediaFactoryItem オブジェクトを探します。

また、ファクトリインターフェイスは、特定の MediaFactoryItem オブジェクトに対してクエリを実行するメソッドや、(MediaFactoryItem オブジェクトを保持する)プラグインをロードするメソッドを公開します。

例を表示

関連する API エレメント



パブリックプロパティ
 プロパティ定義元
 Inheritedconstructor : Object
指定されたオブジェクトインスタンスのクラスオブジェクトまたはコンストラクター関数への参照です。
Object
  numItems : int
[読み取り専用] ファクトリが管理している MediaFactoryItem の数です。
MediaFactory
パブリックメソッド
 メソッド定義元
  
コンストラクターです。
MediaFactory
 Inherited
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
イベントリスナーオブジェクトを EventDispatcher オブジェクトに登録し、リスナーがイベントの通知を受け取るようにします。
EventDispatcher
  
指定された MediaFactoryItem をファクトリに追加します。
MediaFactory
  
指定された MediaResourceBase に基づいて作成可能な MediaElement を返します。
MediaFactory
 Inherited
イベントをイベントフローに送出します。
EventDispatcher
  
指定されたインデックス位置にある MediaFactoryItem を取得します。
MediaFactory
  
指定された ID の MediaFactoryItem を返します。このファクトリ内に指定された MediaFactoryItem が存在しない場合は null になります。
MediaFactory
 Inherited
EventDispatcher オブジェクトに、特定のイベントタイプに対して登録されたリスナーがあるかどうかを確認します。
EventDispatcher
 Inherited
オブジェクトに指定されたプロパティが定義されているかどうかを示します。
Object
 Inherited
Object クラスのインスタンスが、パラメーターとして指定されたオブジェクトのプロトタイプチェーン内にあるかどうかを示します。
Object
  
指定されたリソースで特定されるプラグインをロードします。
MediaFactory
 Inherited
指定されたプロパティが存在し、列挙できるかどうかを示します。
Object
 Inherited
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
EventDispatcher オブジェクトからリスナーを削除します。
EventDispatcher
  
指定された MediaFactoryItem をファクトリから削除します。
MediaFactory
 Inherited
ループ処理に対するダイナミックプロパティの可用性を設定します。
Object
 Inherited
ロケール固有の規則に従って書式設定された、このオブジェクトのストリング表現を返します。
Object
 Inherited
指定されたオブジェクトのストリング表現を返します。
Object
 Inherited
指定されたオブジェクトのプリミティブな値を返します。
Object
 Inherited
指定されたイベントタイプについて、この EventDispatcher オブジェクトまたはその祖先にイベントリスナーが登録されているかどうかを確認します。
EventDispatcher
プロテクトメソッド
 メソッド定義元
  
指定されたリストの MediaFactoryItem の範囲外で、指定されたリソースに最適な MediaFactoryItem を返します。
MediaFactory
イベント
 イベント 概要 定義元
 Inherited[ブロードキャストイベント] Flash Player または AIR アプリケーションがオペレーティングシステムのフォーカスを取得して、アクティブになったときに送出されます。EventDispatcher
 Inherited[ブロードキャストイベント] Flash Player または AIR アプリケーションがオペレーティングシステムのフォーカスを失って、非アクティブになったときに送出されます。EventDispatcher
  MediaFactory が MediaElement を作成したときに送出されます。MediaFactory
  MediaFactory がプラグインを正常にロードしたときに送出されます。MediaFactory
  エラーにより、MediaFactory がプラグインのロードに失敗したときに送出されます。MediaFactory
プロパティの詳細

numItems

プロパティ
numItems:int  [読み取り専用]

言語バージョン: ActionScript 3.0
製品バージョン: OSMF 1.0
ランタイムバージョン: Flash Player 10, AIR 1.5

ファクトリが管理している MediaFactoryItem の数です。



実装
    public function get numItems():int
コンストラクターの詳細

MediaFactory

()コンストラクター
public function MediaFactory()

言語バージョン: ActionScript 3.0
製品バージョン: OSMF 1.0
ランタイムバージョン: Flash Player 10, AIR 1.5

コンストラクターです。

メソッドの詳細

addItem

()メソッド
public function addItem(item:MediaFactoryItem):void

言語バージョン: ActionScript 3.0
製品バージョン: OSMF 1.0
ランタイムバージョン: Flash Player 10, AIR 1.5

指定された MediaFactoryItem をファクトリに追加します。MediaFactoryItem が追加されると、この MediaFactoryItem で処理できる MediaResourceBase の場合に、ファクトリが対応するメディアエレメントを作成できるようになります。このファクトリに同じ ID の MediaFactoryItem が既に存在する場合、既存のオブジェクトは新しい MediaFactoryItem オブジェクトで置き換えられます。

パラメーター

item:MediaFactoryItem — 追加する MediaFactoryItem です。


例外
ArgumentError — 引数が null である場合、または引数が null の ID フィールドを持つ場合。

createMediaElement

()メソッド 
public function createMediaElement(resource:MediaResourceBase):MediaElement

言語バージョン: ActionScript 3.0
製品バージョン: OSMF 1.0
ランタイムバージョン: Flash Player 10, AIR 1.5

指定された MediaResourceBase に基づいて作成可能な MediaElement を返します。

このファクトリ内にそのような MediaElement を作成可能な MediaFactoryItem オブジェクトが見つからない場合は、null を返します。

パラメーター

resource:MediaResourceBase — 対応する MediaElement が作成される MediaResourceBase です。

戻り値
MediaElement — 作成された MediaElement です。そのような MediaElement をリソースから作成できなかった場合は null になります。

getItemAt

()メソッド 
public function getItemAt(index:int):MediaFactoryItem

言語バージョン: ActionScript 3.0
製品バージョン: OSMF 1.0
ランタイムバージョン: Flash Player 10, AIR 1.5

指定されたインデックス位置にある MediaFactoryItem を取得します。

パラメーター

index:int — MediaFactoryItem を取得するリストのインデックスです。

戻り値
MediaFactoryItem — そのインデックス位置にある MediaFactoryItem です。MediaFactoryItem がない場合は null です。

getItemById

()メソッド 
public function getItemById(id:String):MediaFactoryItem

言語バージョン: ActionScript 3.0
製品バージョン: OSMF 1.0
ランタイムバージョン: Flash Player 10, AIR 1.5

指定された ID の MediaFactoryItem を返します。このファクトリ内に指定された MediaFactoryItem が存在しない場合は null になります。

パラメーター

id:String — 取得する MediaFactoryItem の ID です。

戻り値
MediaFactoryItem — 指定された ID の MediaFactoryItem です。このファクトリ内に指定された MediaFactoryItem が存在しない場合は null になります。

loadPlugin

()メソッド 
public function loadPlugin(resource:MediaResourceBase):void

言語バージョン: ActionScript 3.0
製品バージョン: OSMF 1.0
ランタイムバージョン: Flash Player 10, AIR 1.5

指定されたリソースで特定されるプラグインをロードします。プラグインが既にロードされている場合、MediaFactory はプラグインを再ロードしません。正常なロード時には、プラグインの PluginInfo プロパティ内の MediaFactoryItem がこの MediaFactory に追加され、MediaFactoryEvent.PLUGIN_LOAD イベントが送出されます。それ以外の場合(ロードに失敗した場合)、MediaFactoryEvent.PLUGIN_LOAD_ERROR イベントが送出されます。

パラメーター

resource:MediaResourceBase — プラグインを表す MediaResourceBase です。リモート(動的)プラグインの場合、ロードするリモート SWF を示す URLResource を使用します。ローカル(静的)プラグインの場合、PluginInfoResource を使用します。


例外
ArgumentError — resource が null である場合、または resource が URLResource と PluginInfoResource のいずれでもない場合。

removeItem

()メソッド 
public function removeItem(item:MediaFactoryItem):void

言語バージョン: ActionScript 3.0
製品バージョン: OSMF 1.0
ランタイムバージョン: Flash Player 10, AIR 1.5

指定された MediaFactoryItem をファクトリから削除します。このファクトリにそのような MediaFactoryItem が存在しない場合は、何も実行されません。

パラメーター

item:MediaFactoryItem — 削除する MediaFactoryItem です。


例外
ArgumentError — 引数が null である場合、または引数が null の ID フィールドを持つ場合。

resolveItems

()メソッド 
protected function resolveItems(resource:MediaResourceBase, items:Vector.<MediaFactoryItem>):MediaFactoryItem

指定されたリストの MediaFactoryItem の範囲外で、指定されたリソースに最適な MediaFactoryItem を返します。複数の MediaFactoryItem が処理可能なリソースで createMediaElement が呼び出された場合、このメソッドが呼び出されます。サブクラスでオーバーライドして、最適なものを選択できます。デフォルトの動作では、プラグインは主要なメディアタイプよりも優先されるべきであるという理論から、フレームワークに「ネイティブ」でない最初のアイテムが選択されます。この決定は、「org.osmf」で始まる ID 値の有無に基づいて行われます。

パラメーター

resource:MediaResourceBase
 
items:Vector.<MediaFactoryItem>

戻り値
MediaFactoryItem
イベントの詳細

mediaElementCreate

イベント
イベントオブジェクトの型: org.osmf.events.MediaFactoryEvent
プロパティ MediaFactoryEvent.type = org.osmf.events.MediaFactoryEvent.MEDIA_ELEMENT_CREATE

言語バージョン: ActionScript 3.0
製品バージョン: OSMF 1.0
ランタイムバージョン: Flash Player 10, AIR 1.5

MediaFactory が MediaElement を作成したときに送出されます。

MediaFactoryEvent.MEDIA_ELEMENT_CREATE 定数により、イベントオブジェクトの type プロパティ値が mediaElementCreate イベント用に定義されます。

pluginLoad

イベント  
イベントオブジェクトの型: org.osmf.events.MediaFactoryEvent
プロパティ MediaFactoryEvent.type = org.osmf.events.MediaFactoryEvent.PLUGIN_LOAD

言語バージョン: ActionScript 3.0
製品バージョン: OSMF 1.0
ランタイムバージョン: Flash Player 10, AIR 1.5

MediaFactory がプラグインを正常にロードしたときに送出されます。

MediaFactoryEvent.PLUGIN_LOAD 定数により、イベントオブジェクトの type プロパティ値が pluginLoad イベント用に定義されます。

pluginLoadError

イベント  
イベントオブジェクトの型: org.osmf.events.MediaFactoryEvent
プロパティ MediaFactoryEvent.type = org.osmf.events.MediaFactoryEvent.PLUGIN_LOAD_ERROR

言語バージョン: ActionScript 3.0
製品バージョン: OSMF 1.0
ランタイムバージョン: Flash Player 10, AIR 1.5

エラーにより、MediaFactory がプラグインのロードに失敗したときに送出されます。

MediaFactoryEvent.PLUGIN_LOAD_ERROR 定数により、イベントオブジェクトの type プロパティ値が pluginLoadError イベント用に定義されます。
MediaFactoryExample.as

この例は、MediaFactory を使用してプラグインをロードする方法を示しています。サンプルでは、モックアップのプラグインが URL で使用されていることに注意してください。
package org.osmf.media
{
    import flash.display.Sprite;
    
    import org.osmf.events.MediaFactoryEvent;

    public class MediaFactoryExample extends Sprite
    {
        public function MediaFactoryExample()
        {
            // Construct a media factory, and listen to its plug-in related events:
            var factory:MediaFactory = new MediaFactory();
            factory.addEventListener(MediaFactoryEvent.PLUGIN_LOAD, onPluginLoaded);
            factory.addEventListener(MediaFactoryEvent.PLUGIN_LOAD_ERROR, onPluginLoadError);
            
            // Instruct the factory to load the plug-in at the given url:
            factory.loadPlugin(new URLResource("http://myinvalidurl.com/foo.swf"));        
        }
    
        private function onPluginLoaded(event:MediaFactoryEvent):void
        {
            // Use the factory to create a media-element related to the plugin:
            var factory:MediaFactory = event.target as MediaFactory;
            factory.createMediaElement(new URLResource("http://myinvalidurl.com/content"));
        }
        
        private function onPluginLoadError(event:MediaFactoryEvent):void
        {
            // Handle plug-in loading failure:
            trace("Plugin failed to load.");    
        }    
    }
}




[ X ]英語で表示される理由
ActionScript 3.0 リファレンスガイドのコンテンツが英語で表示されます。

ActionScript 3.0 リファレンスガイドのすべての部分がすべての言語に翻訳されているわけではありません。言語エレメントが翻訳されていない場合、そのエレメントは英語で表示されます。例えば、ga.controls.HelpBox クラスはどの言語にも訳されていません。このため、リファレンスガイドの日本語バージョンでは、ga.controls.HelpBox クラスは英語で表示されます。