Determines if an autmatic id created from the file name. If true, when adding and item and NOT specifing an "id" props for its properties, an id with the file name will be created altomatically.

          bulkLoader.allowsAutoIDFromFileName = false;
          var item : LoadingItem = bulkLoader.add("background.jpg")
          trace(item.id) //  outputs: null
          // now if allowsAutoIDFromFileName is set to true:
          bulkLoader.allowsAutoIDFromFileName = true;
          var item : LoadingItem = bulkLoader.add("background.jpg")
          trace(item.id) //  outputs: background
          // if you pass an id on the props, it will take precedence over auto created ids:
          bulkLoader.allowsAutoIDFromFileName = id;
          var item : LoadingItem = bulkLoader.add("background.jpg", {id:"small-bg"})
          trace(item.id) //  outputs: small-bg
          

List of all file extensions that the BulkLoader knows how to guess. Availabe types: swf, jpg, jpeg, gif, png.

The average latency (in miliseconds) for the entire loading.

The sum of all bytesLoaded for each item.

The total bytes to load. If the number of items to load is larger than the number of simultaneous connections, bytesTotal will be 0 untill all connections are opened and the number of bytes for all items is known.

See also

The sum of all bytes loaded so far. If itemsTotal is less than the number of connections, this will be the same as bytesTotal. Else, bytesTotalCurrent will be available as each loading is started.

See also

Returns an object where the urls are the keys(as strings) and the loaded contents are the value for that key. Each value is typed as an the client must check for the right typing.

Returns the highest priority for all items in this BulkLoader instance. This will check all items, including cancelled items and already downloaded items.

The id of this bulkLoader instance

List of file extensions that will be automagically use a Loader object for loading. Availabe types: swf, jpg, jpeg, gif, png, image.

A boolean indicating if the instace has started and has not finished loading all items

Returns a copy of all LoadingItem in this intance. This function makes a copy to avoid users messing with _items (removing items and so forth). Those can be done through functions in BulkLoader.

Number of items alrealdy loaded. Failed or canceled items are not taken into consideration

Total number of items to load.

The ratio (0->1) of items to load / items total. This number is always reliable.

The function to be used in logging. By default it's the same as the global function trace. The log function signature is:

          public function myLogFunction(msg : String) : void{}
          

The name by which this loader instance can be identified. This property is used so you can get a reference to this instance from other classes in your code without having to save and pass it yourself, throught the static method BulkLoader.getLoader(name) .

Each name should be unique, as instantiating a BulkLoader with a name already taken will throw an error.

See also

The number of simultaneous connections to use. This is per BulkLoader instance.

See also

The percentage (0->1) of bytes loaded. Until all connections are opened this number is not reliable . If you are downloading more items than the number of simultaneous connections, use loadedRatio or weightPercent instead.

See also

List of file extensions that will be automagically treated as sound for loading. Availabe types: mp3, f4a, f4b.

The average speed (in kb/s) for the entire loading.

The object, used as a hashed to substitute variables specified on the url used in add. Allows to keep common part of urls on one spot only. If later the server path changes, you can change only the stringSubstitutions object to update all items. This has to be set before the add calls are made, or else strings won't be expanded.

See also

          // All webservices will be at a common path:
          bulkLoader.stringSubstitutions = {
              "web_services": "http://somesite.com/webservices"
          }
          bulkLoader.add("{web_services}/getTime");
          // this will be expanded to http://somesite.com/webservices/getTime
          
          

List of file extensions that will be automagically treated as text for loading. Availabe types: txt, js, xml, php, asp .

Time in seconds for the whole loading. Only available after everything is laoded

The sum of weights in all items to load. Each item's weight default to 1

List of file extensions that will be automagically treated as video for loading. Availabe types: flv, f4v, f4p.

The weighted percent of items loaded(0->1). This always returns a reliable value.

Creates a new BulkLoader object identifiable by the name parameter. The name parameter must be unique, else an Error will be thrown.

See also

Adds a new assets to be loaded. The BulkLoader object will manage diferent assets type. If the right type cannot be infered from the url termination (e.g. the url ends with ".swf") the BulkLoader will relly on the type property of the props parameter. If both are set, the type property of the props object will overrite the one defined in the url. In case none is specified and the url won't hint at it, the type TYPE_TEXT will be used.

See also

import br.stimuli.loaded.BulkLoader;
var bulkLoader : BulkLoader = new BulkLoader("main");
// simple item:
bulkLoader.add("config.xml");
// use an id that can be retirved latterL
bulkLoader.add("background.jpg", {id:"bg"});
// or use a static var to have auto-complete and static checks on your ide:
bulkLoader.add("background.jpg", {BulkLoader.ID:"bg"});
// loads the languages.xml file first and parses before all items are done:
public function parseLanguages() : void{
   var theLangXML : XML = bulkLoader.getXML("langs");
   // do something wih the xml:
   doSomething(theLangXML);
}
bulkLoader.add("languages.xml", {priority:10, onComplete:parseLanguages, id:"langs"});
// Start the loading operation with only 3 simultaneous connections:
bulkLoader.start(3)
   

Updates the priority of item identified by key with a new value, the queue will be re resorted right away. Changing priorities will not stop currently opened connections.

Removes this instance from the static Register of instances. After a clear method has been called for a given instance, nothing else should work

Creates a BulkLoader instance with an unique name. This is useful for situations where you might be creating many BulkLoader instances and it gets tricky to garantee that no other instance is using that name.

Used to fetch an item with a given key. The returned LoadingItem can be used to attach event listeners for the individual items (Event.COMPLETE, ProgressEvent.PROGRESS, Event.START).

Returns a AVM1Movie object with the downloaded asset for the given key.

Returns a Bitmap object with the downloaded asset for the given key.

Returns an BitmapData object with the downloaded asset for the given key.

Returns an untyped object with the downloaded asset for the given key.

Gets the http status code for the loading item identified by key.

Fetched a BulkLoader object created with the name parameter. This is usefull if you must access loades assets from another scope, without having to pass direct references to this loader.

Returns a MovieClip object with the downloaded asset for the given key.

Returns a NetStream object with the downloaded asset for the given key.

Returns a Object with meta data information for a given NetStream key.

Returns items that haven't been fully loaded.

Calculates the progress for a specific set of items.

See also

Returns a Sound object with the downloaded asset for the given key.

If the logLevel if lower that LOG_ERRORS(3). Outputs a host of statistics about the loading operation

See also

Returns a String object with the downloaded asset for the given key.

Returns an XML object with the downloaded asset for the given key.

Checks if there is loaded item in this BulkLoader.

Forces the item specified by key to be loaded right away. This will stop any open connection as needed. If needed, the connection to be closed will be the one with the lower priority. In case of a tie, the one that has more bytes to complete will be removed. The item to load now will be automatically be set the highest priority value in this BulkLoader instance.

Stop loading the item identified by key. This will not remove the item from the BulkLoader. Note that progress notification will jump around, as the stopped item will still count as something to load, but it's byte count will be 0.

Stops loading all items of this BulkLoader instance. This does not clear or remove items from the qeue.

Stops loading all items from all BulkLoader instances.

See also

Register a new file extension to be loaded as a given type. This is used both in the guessing of types from the url and affects how loading is done for each type. If you are adding an extension to be of a type you are creating, you must pass the withClass parameter, which should be a class that extends LoadingItem.

See also

Forces the item specified by key to be reloaded right away. This will stop any open connection as needed.

This will delete this item from memory. It's content will be inaccessible after that.

Deletes all loading and loaded objects. This will stop all connections and delete from the cache all of it's items (no content will be accessible if removeAll is executed).

Deletes all content from all instances of BulkLoader class. This will stop any pending loading operations as well as free memory.

See also

Removes all items that have not succesfully loaded. After removing, it will try to restart loading if there are still items to load.

Removes all items that have been stopped. After removing, it will try to restart loading if there are still items to load.

Resumes loading of the item. Depending on the environment the player is running, resumed items will be able to use partialy downloaded content.

Resumes all loading operations that were stopped.

Updates the priority queue

Start loading all items added previously

See also

Returns a string identifing this loaded instace.

Checks which BulkLoader has an item by the given key.

Dispatched when all items have been downloaded and parsed.

Dispatched on download progress by any of the items to download.

The name of the event

The name of the event

An object definig the loading context for this load operario. If this item is of TYPE_SOUND, a SoundLoaderContext is expected. If it's a TYPE_IMAGE a LoaderContext should be passed. Checked when adding a new item to load.

See also

The logging level BulkLoader will use.

See also

The name of the event

An array of RequestHeader objects to be used when contructing the URLRequest object. If the url parameter is passed as a URLRequest object it will be ignored. Checked when adding a new item to load.

See also

The name of the event

A String to be used to identify an item to load, can be used in any method that fetches content (as the key parameters), stops, removes and resume items. Checked when adding a new item to load.

See also

Will only trace errors. Defaut level

Ouputs noteworthy events such as when an item is started / finished loading.

Nothing will be logged

LogLevel: Outputs everything that is happening. Usefull for debugging.

Ouputs noteworthy events such as when an item is started / finished loading.

The number, as an int, to retry downloading an item in case it fails. Checked when adding a new item to load.

The default value is 3.

See also

The name of the event

If true a random query (or post data parameter) will be added to prevent caching. Checked when adding a new item to load.

See also

An int that controls which items are loaded first. Items with a higher PRIORITY will load first. If more than one item has the same PRIORITY number, the order in which they are added will be taken into consideration. Checked when adding a new item to load.

See also

The name of the event

Tells this class to use a Loader object to load the item.

Tells this class to use a Loader object to load the item.

Tells this class to use a Sound object to load the item.

Tells this class to use a URLRequest object to load the item.

Tells this class to use a NetStream object to load the item.

Tells this class to use a XML object to load the item.

Version. Useful for debugging.