RSLPreloader

パッケージ	fl.rsl
クラス	public class RSLPreloader
継承	RSLPreloader EventDispatcher Object

言語バージョン:

ActionScript 3.0

製品バージョン:

Flash CS5

ランタイムバージョン:

Flash Player 10.1, AIR 2

RSLPreloader クラスは、他のコンテンツを再生する前に、RSL（ランタイム共有ライブラリ）のプリロードを管理します。SWF（符号なし）ファイルと SWZ（符号付き、キャッシュ済み）ファイルの両方を処理します。RSLPreloader は、イベント（RSLEvent.RSL_LOAD_COMPLETE、RSLErrorEvent.RSL_LOAD_FAILED または RSLEvent.RSL_PROGRESS）を送出し、RSL ファイルのロードのステータスを示します。

パブリックプロパティ

継承されるパブリックプロパティを隠す

継承されるパブリックプロパティを表示

	プロパティ		定義元
		constructor : Object 指定されたオブジェクトインスタンスのクラスオブジェクトまたはコンストラクター関数への参照です。	Object
		debugWaitTime : int 最初の RSL ファイルをダウンロードするまで待機するミリ秒数の値を設定します。	RSLPreloader
		numRSLInfos : int [読み取り専用] addRSLInfo() を使用して追加された RSLInfo インスタンスの数です。	RSLPreloader

パブリックメソッド

継承されるパブリックメソッドを隠す

継承されるパブリックメソッドを表示

	メソッド		定義元
		RSLPreloader(mainTimeline:MovieClip = null) コンストラクターです。	RSLPreloader
		addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void イベントリスナーオブジェクトを EventDispatcher オブジェクトに登録し、リスナーがイベントの通知を受け取るようにします。	EventDispatcher
		addRSLInfo(info:RSLInfo):void ダウンロードされる SWF または SWZ ファイルに記述用の RSLInfo レコードを追加します。	RSLPreloader
		dispatchEvent(event:Event):Boolean イベントをイベントフローに送出します。	EventDispatcher
		getRSLInfoAt(index:int):RSLInfo 指定したインデックス位置にある、addRSLInfo() を使用して追加された RSLInfo レコードを取得します。	RSLPreloader
		hasEventListener(type:String):Boolean EventDispatcher オブジェクトに、特定のイベントタイプに対して登録されたリスナーがあるかどうかを確認します。	EventDispatcher
		hasOwnProperty(name:String):Boolean オブジェクトに指定されたプロパティが定義されているかどうかを示します。	Object
		isPrototypeOf(theClass:Object):Boolean Object クラスのインスタンスが、パラメーターとして指定されたオブジェクトのプロトタイプチェーン内にあるかどうかを示します。	Object
		loadContent():void loadContent メソッドは、コンテンツクラス名が start() メソッドに提供されるときに、ラッパー SWF のフレーム 2 から呼び出されます。	RSLPreloader
		propertyIsEnumerable(name:String):Boolean 指定されたプロパティが存在し、列挙できるかどうかを示します。	Object
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void EventDispatcher オブジェクトからリスナーを削除します。	EventDispatcher
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void ループ処理に対するダイナミックプロパティの可用性を設定します。	Object
		start(preloaderAnimClass:Class = null, contentClassName:String = null):void RSL ファイルのダウンロードを開始します。	RSLPreloader
		toLocaleString():String ロケール固有の規則に従って書式設定された、このオブジェクトのストリング表現を返します。	Object
		toString():String 指定されたオブジェクトのストリング表現を返します。	Object
		valueOf():Object 指定されたオブジェクトのプリミティブな値を返します。	Object
		willTrigger(type:String):Boolean 指定されたイベントタイプについて、この EventDispatcher オブジェクトまたはその祖先にイベントリスナーが登録されているかどうかを確認します。	EventDispatcher

イベント

イベントの詳細についてはここをクリックしてください

継承されるイベントを隠す

継承されるイベントを表示

	概要	定義元
activate	[ブロードキャストイベント] Flash Player または AIR アプリケーションがオペレーティングシステムのフォーカスを取得して、アクティブになったときに送出されます。	EventDispatcher
deactivate	[ブロードキャストイベント] Flash Player または AIR アプリケーションがオペレーティングシステムのフォーカスを失って、非アクティブになったときに送出されます。	EventDispatcher
rslLoadComplete	すべての RSL のロード完了時に、RSLPreloader によって送出されます。	RSLPreloader
rslLoadFailed	すべての RSL のダウンロードが終了したとき、失敗したファイルが 1 つ以上ある場合に、RSLPreloader によって送出されます。	RSLPreloader
rslProgress	RSLPreloader によって送出され、RSL ファイルのダウンロードの進捗状況を示します。	RSLPreloader

プロパティの詳細

debugWaitTime

プロパティ

debugWaitTime:int

言語バージョン:

ActionScript 3.0

製品バージョン:

Flash CS5

ランタイムバージョン:

Flash Player 10.1, AIR 2

最初の RSL ファイルをダウンロードするまで待機するミリ秒数の値を設定します。この方法で、エンドユーザーエクスペリエンスをシミュレートしたり、プリロードループをテストしたりできます。この方法は、SWZ キャッシュをフラッシュせずにロードの遅延時間を組み込んで符号付きキャッシュ RSL（SWZ ファイル）をテストする場合に特に有用です。この値を 0 より大きい値に設定するコードがある場合、それらのコードすべてをデプロイする前に無効にしてください。デバッグ構成定数（CONFIG::DEBUG など）を使用してコードを呼び出します。または、デバッグコードを忘れずに削除するために、5000（5 秒に相当）など、比較的大きな値に遅延時間を設定する方法もあります。オーサリングによって自動生成される RSLLoader インスタンスについては、アニメーション SWF のロード機能またはメインタイムラインコードで setRSLPreloader(value:RSLPreloader):void メソッドを定義することで遅延時間を設定できます。

         import fl.rsl.RSLPreloader;
         function setRSLPreloader(preloader:RSLPreloader):void {
         preloader.debugWaitTime = 10000;
         }

デフォルト値： 0。

実装
public function get debugWaitTime():int
public function set debugWaitTime(value:int):void

numRSLInfos

プロパティ

numRSLInfos:int [読み取り専用]

言語バージョン:

ActionScript 3.0

製品バージョン:

Flash CS5

ランタイムバージョン:

Flash Player 10.1, AIR 2

addRSLInfo() を使用して追加された RSLInfo インスタンスの数です。

         for(var i:int = 0; i < myPreloader.numRSLInfos; i++) {
            trace('rsl ' + i);
            var urls:Array = myPreloader.getRSLInfoAt(i).rslURLs;
            for(var j:int = 0; j < urls.length; j++) {
               trace(' url: ' + urls[j]);
            }
         }

実装
public function get numRSLInfos():int

関連する API エレメント

addRSLInfo()

コンストラクターの詳細

()

コンストラクター

public function RSLPreloader(mainTimeline:MovieClip = null)

言語バージョン:

ActionScript 3.0

製品バージョン:

Flash CS5

ランタイムバージョン:

Flash Player 10.1, AIR 2

コンストラクターです。SWZ ファイルをプリロードするために出力コードが自動生成されるときに、メインタイムラインクラスに引数として渡されます。通常、このコンストラクターは、エンドユーザーによって記述されたコードでは使用されません。

パラメーター

mainTimeline:MovieClip (default = null)

メソッドの詳細

addRSLInfo

()

メソッド

public function addRSLInfo(info:RSLInfo):void

言語バージョン:

ActionScript 3.0

製品バージョン:

Flash CS5

ランタイムバージョン:

Flash Player 10.1, AIR 2

ダウンロードされる SWF または SWZ ファイルに記述用の RSLInfo レコードを追加します。

         import fl.rsl.RSLInfo;
         var info:RSLInfo = new RSLInfo();
         info.addEntry('rsl.swf');
         myPreloader.addRSLInfo(info);
         myPreloader.start();

パラメーター

info:RSLInfo

getRSLInfoAt

()

メソッド

public function getRSLInfoAt(index:int):RSLInfo

言語バージョン:

ActionScript 3.0

製品バージョン:

Flash CS5

ランタイムバージョン:

Flash Player 10.1, AIR 2

指定したインデックス位置にある、addRSLInfo() を使用して追加された RSLInfo レコードを取得します。インデックスは、addRSLInfo() を使用してレコードが追加された順番に対応しています。

         for (var i:int = 0; i < myPreloader.numRSLInfos; i++) {
            trace('rsl ' + i);
            var urls:Array = myPreloader.getRSLInfoAt(i).rslURLs;
            for (var j:int = 0; j < urls.length; j++) {
               trace(' url: ' + urls[j]);
            }
         }

パラメーター

index:int

戻り値

RSLInfo

関連する API エレメント

addRSLInfo()

loadContent

()

メソッド

public function loadContent():void

言語バージョン:

ActionScript 3.0

製品バージョン:

Flash CS5

ランタイムバージョン:

Flash Player 10.1, AIR 2

loadContent メソッドは、コンテンツクラス名が start() メソッドに提供されるときに、ラッパー SWF のフレーム 2 から呼び出されます。通常、このメソッドは、エンドユーザーによって記述されたコードでは使用されません。

関連する API エレメント

start

()

メソッド

public function start(preloaderAnimClass:Class = null, contentClassName:String = null):void

言語バージョン:

ActionScript 3.0

製品バージョン:

Flash CS5

ランタイムバージョン:

Flash Player 10.1, AIR 2

RSL ファイルのダウンロードを開始します。addRSLInfo() を使用してすべての RSLInfo レコードが追加されるまで、この関数を呼び出さないでください。出力コードを自動的にオーサリングする場合、2 つの引数をオプションで指定できます。引数の 1 つは、プリローダー SWF アニメーションをロードする ByteArray サブクラスです。もう 1 つの引数は、コンテンツ SWF の ByteArray サブクラス名です。通常、これらの引数は、エンドユーザーによって記述されたコードでは使用されません。

パラメーター

	`preloaderAnimClass:Class` (default = `null`)

	`contentClassName:String` (default = `null`)

関連する API エレメント

addRSLInfo()

イベントの詳細

rslLoadComplete

イベント

イベントオブジェクトの型: fl.events.RSLEvent
プロパティ RSLEvent.type = fl.events.RSLEvent.RSL_LOAD_COMPLETE

言語バージョン:

ActionScript 3.0

製品バージョン:

Flash CS5

ランタイムバージョン:

Flash Player 10.1, AIR 2

すべての RSL のロード完了時に、RSLPreloader によって送出されます。

すべての RSL のダウンロードが正常に完了したときに、RSLPreloader によって送出されるイベントです。このイベントタイプの bytesLoaded プロパティと bytesTotal プロパティは、常に 0 です。カスタムイベントループを使用してプリロードを実行している場合、ユーザーコンテンツはこのイベントをリッスンして、アニメーションループのロードを終了するタイミングを判定する必要があります。

このイベントには、次のプロパティがあります。

プロパティ	値
`bubbles`	`true`
`cancelable`	`false` は、キャンセルするデフォルトの動作がないことを示します。
`currentTarget`	イベントリスナーで Event オブジェクトをアクティブに処理しているオブジェクトです。
`target`	表示リストに追加される DisplayObejct インスタンスです。`target` は、必ずしもイベントリスナーを登録した表示リスト内のオブジェクトとは限りません。現在イベントを処理している表示リスト内のオブジェクトにアクセスするには、`currentTarget` プロパティを使用します。
`rslsLoaded`	ダウンロードに成功したファイル数です。
`rslsFailed`	ダウンロードに失敗したファイル数です。
`rslsTotal`	ダウンロードしたファイルの総数（成功および失敗を含む）です。
`bytesLoaded`	ダウンロードに成功したファイルについて、ダウンロードされたバイトの総数です。
`bytesTotal`	ダウンロードしたファイルについて、ダウンロードされたバイトの総数（成功および失敗を含む）です。

         import fl.events.RSLEvent;
         myPreloader.addEventListener(RSLEvent.RSL_LOAD_COMPLETE, loadComplete);
         function loadComplete(e:RSLEvent) {
         gotoAndPlay('startOfContent');
         }

rslLoadFailed

イベント

イベントオブジェクトの型: fl.events.RSLErrorEvent
プロパティ RSLErrorEvent.type = fl.events.RSLErrorEvent.RSL_LOAD_FAILED

言語バージョン:

ActionScript 3.0

製品バージョン:

Flash CS5

ランタイムバージョン:

Flash Player 10.1, AIR 2

すべての RSL のダウンロードが終了したとき、失敗したファイルが 1 つ以上ある場合に、RSLPreloader によって送出されます。

すべての RSL のダウンロード終了時、失敗したファイルが 1 つ以上ある場合に、RSLPreloader によって送出されるエラーです。カスタムイベントループを使用してプリロードを実行している場合、ユーザーコンテンツはこのイベントをリッスンして、アニメーションループのロードを終了するタイミングを判定する必要があります。

このイベントには、次のプロパティがあります。

プロパティ	値
`bubbles`	`true`
`cancelable`	`false` は、キャンセルするデフォルトの動作がないことを示します。
`currentTarget`	イベントリスナーで Event オブジェクトをアクティブに処理しているオブジェクトです。
`target`	表示リストに追加される DisplayObejct インスタンスです。`target` は、必ずしもイベントリスナーを登録した表示リスト内のオブジェクトとは限りません。現在イベントを処理している表示リスト内のオブジェクトにアクセスするには、`currentTarget` プロパティを使用します。
`rslsLoaded`	ダウンロードに成功したファイル数です。
`rslsFailed`	ダウンロードに失敗したファイル数です。
`rslsTotal`	ダウンロードしたファイルの総数（成功および失敗を含む）です。
`failedURLs`	ダウンロードに失敗したファイルの配列です。

         import fl.events.RSLErrorEvent;
         myPreloader.addEventListener(RSLErrorEvent.RSL_LOAD_FAILED, rslLoadFailedHandler);
         function rslLoadFailedHandler(e:RSLErrorEvent) {
         gotoAndPlay('rslLoadFailure');
         }

rslProgress

イベント

イベントオブジェクトの型: fl.events.RSLEvent
プロパティ RSLEvent.type = fl.events.RSLEvent.RSL_PROGRESS

言語バージョン:

ActionScript 3.0

製品バージョン:

Flash CS5

ランタイムバージョン:

Flash Player 10.1, AIR 2

RSLPreloader によって送出され、RSL ファイルのダウンロードの進捗状況を示します。

RSLPreloader によって送出されるイベントで、RSL ファイルのダウンロードの進捗状況を示します。このイベントタイプは、bytesLoaded プロパティおよび bytesTotal プロパティがゼロ以外の場合にのみ送出されます。

このイベントには、次のプロパティがあります。

プロパティ	値
`bubbles`	`true`
`cancelable`	`false` は、キャンセルするデフォルトの動作がないことを示します。
`currentTarget`	イベントリスナーで Event オブジェクトをアクティブに処理しているオブジェクトです。
`target`	表示リストに追加される DisplayObejct インスタンスです。`target` は、必ずしもイベントリスナーを登録した表示リスト内のオブジェクトとは限りません。現在イベントを処理している表示リスト内のオブジェクトにアクセスするには、`currentTarget` プロパティを使用します。
`rslsLoaded`	ダウンロードに成功したファイル数です。
`rslsFailed`	ダウンロードに失敗したファイル数です。
`rslsTotal`	ダウンロードしたファイルの総数（成功および失敗を含む）です。
`bytesLoaded`	ダウンロードに成功したファイルについて、ダウンロードされたバイトの総数です。
`bytesTotal`	ダウンロードしたファイルについて、ダウンロードされたバイトの総数（成功および失敗を含む）です。

         import fl.events.RSLEvent;
         myPreloader.addEventListener(RSLEvent.RSL_PROGRESS, progressHandler);
         function progressHandler(e:RSLEvent) {
         trace('rslsLoaded = ' + e.rslsLoaded);
         trace('rslsFailed = ' + e.rslsFailed);
         trace('rslsTotal = ' + e.rslsTotal);
         trace('bytesLoaded = ' + e.bytesLoaded);
         trace('bytesTotal = ' + e.bytesTotal);
         }

法律上の注意 | プライバシーポリシー

RSLPreloader - AS3 Flash

クラス x

debugWaitTime

numRSLInfos

RSLPreloader

addRSLInfo

getRSLInfoAt

loadContent

start

rslLoadComplete

rslLoadFailed

rslProgress