RSLPreloader  - AS3 Flash

Set this value to the number of milliseconds to wait before downloading the first RSL file. This is one way to simulate the end-user experience and test the preload loop. It is especially useful in testing signed cache RSLs (SWZ files), to build in a loading delay without flushing the SWZ cache. Disable any code that sets this value to greater than 0 before deploying. Use a debug config constant (such as CONFIG::DEBUG) to call the code. Another suggestion is to set the delay to a relatively LARGE value, such as 5000 (equivalent to 5 seconds), as a reminder to remove the debug code. For RSLLoader instances that are automatically generated by authoring, the dalay can be set by defining a setRSLPreloader(value:RSLPreloader):void method in the loading animation SWF or in the main timeline code.

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

The default value is 0.

The number of RSLInfo instances added via 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]);
            }
         }
         

Related API Elements

Constructor. When authoring outputs code automatically to preload SWZ files, it passes in the main timeline class as an argument. This is not generally useful for end-user written code.

Adds a descriptive RSLInfo record to the SWF or SWZ file being downloaded.

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

Parameters

Gets the RSLInfo record added via addRSLInfo() at the specified index. The index corresponds to the order in which the records were added via 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]);
            }
         }
         

Parameters

Related API Elements

The loadContent method is called from frame 2 of the wrapper SWF when a content class name is supplied to the start() method. It is not generally used with end-user written code.

Related API Elements

Starts downloading the RSL files. This function should not be called until all RSLInfo records have been added via addRSLInfo(). Two optional arguments may be used when authoring outputs code automatically. The first is a ByteArray subclass to load a preloader SWF animation. The second is the name of a ByteArray subclass for the content SWF, These arguments are not generally used in end-user written code.

Parameters

Related API Elements

Dispatched by RSLPreloader when all RSLs have completed loading.

This event has the following properties:

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

Dispatched by RSLPreloader when all RSLs have finished downloading and one or more have failed.

This event has the following properties:

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

Dispatched by RSLPreloader to indicate progress in downloading RSL files.

This event has the following properties:

         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);
         }