com.bourre.load.StreamLoader

	Property	Defined by
		_sPrefixURL : String	AbstractLoader
		_sURL : String	AbstractLoader

Public Methods

	Method		Defined by
		StreamLoader() Creates new `StreamLoader` instance.	StreamLoader
		addASyncCommandListener(listener:ASyncCommandListener, ... rest):Boolean Adds the passed-in command listener object as listener for this command events.	AbstractLoader
		addEventListener(type:String, listener:Object, ... rest):Boolean Adds an event listener for the specified event type.	AbstractLoader
		addListener(listener:LoaderListener):Boolean Adds the passed-in listener as listener for all events dispatched by this event broadcaster.	AbstractLoader
		execute(e:Event = null):void Execute the request according to the current command data.	AbstractLoader
		fireCommandEndEvent():void Fires the `onCommandEnd` event to the listeners of this command.	AbstractLoader
		fireOnLoadErrorEvent(message:String = ""):void Dispatches event when an error occur.	AbstractLoader
		fireOnLoadInitEvent():void Dispatches event when the loading is finished.	AbstractLoader
		fireOnLoadProgressEvent():void Dispatches event during loading progression.	AbstractLoader
		fireOnLoadStartEvent():void Dispatches event when the loading starts.	AbstractLoader
		fireOnLoadTimeOut():void	AbstractLoader
		getBytesLoaded():uint Returns the number of bytes loaded.	AbstractLoader
		getBytesTotal():uint Returns the total number of bytes to load.	AbstractLoader
		getContent():Object Returns loaded content.	AbstractLoader
		getName():String Returns the loader identifier.	AbstractLoader
		getPerCent():Number Returns a percentage of bytes loaded and total bytes to load.	AbstractLoader
		getStrategy():LoadStrategy Returns loading strategy used by the loader.	AbstractLoader
		getStream():URLStream Returns URLStream content.	StreamLoader
		getTimeOut():Number Returns the loading timeout limit	AbstractLoader
		getURL():URLRequest Returns the URL used by this loader.	AbstractLoader
		isAntiCache():Boolean Returns `true` if 'anticache' system is on.	AbstractLoader
		isLoaded():Boolean Returns `true` if all bytes are loaded.	AbstractLoader
		isRunning():Boolean Returns `true` if this object is running.	AbstractLoader
		load(url:URLRequest = null, context:LoaderContext = null):void Loads content.	AbstractLoader
		prefixURL(sURL:String):void Adds prefix to URL passed to the loader instance.	AbstractLoader
		release():void Releases instance and all registered listeners.	AbstractLoader
		removeASyncCommandListener(listener:ASyncCommandListener):Boolean Removes the passed-in command listener object as listener for this command events.	AbstractLoader
		removeEventListener(type:String, listener:Object):Boolean Removes the passed-in listener for listening the specified event.	AbstractLoader
		removeListener(listener:LoaderListener):Boolean Removes the passed-in listener object from this event broadcaster.	AbstractLoader
		run():void Starts the asynchronous process of this runnable object.	AbstractLoader
		setAntiCache(b:Boolean):void Sets the 'anticache' system to `true` to add timestamp value to the loaded URL.	AbstractLoader
		setContent(content:Object):void Uses to replace this loader content.	AbstractLoader
		setName(sName:String):void Sets the loader identifier.	AbstractLoader
		setTimeOut(n:Number):void Sets a loading timeout limit.	AbstractLoader
		setURL(url:URLRequest):void Defined from which the URL will be loaded.	AbstractLoader

	Method	Defined by
		fireEvent(e:Event):void Dispatched passed-in event to all registered listeners.	AbstractLoader
		fireEventType(type:String, errorMessage:String = ""):void Dispatches event using passed-in type and optional error message.	AbstractLoader
		getLoaderEvent(type:String, errorMessage:String = ""):LoaderEvent Returns a loader event for current loader instance.	StreamLoader
		onInitialize():void	AbstractLoader
		setListenerType(type:Class):void Defines the type of listeners this event broadcaster support.	AbstractLoader

Summary	Defined by
onLoadError	Dispatched when an error occurs during loading.	StreamLoader
onLoadError	Dispatched when an error occurs during loading.	AbstractLoader
onLoadInit	Dispatched when loading is finished.	StreamLoader
onLoadInit	Dispatched when loading is finished.	AbstractLoader
onLoadProgress	Dispatched during loading progression.	StreamLoader
onLoadProgress	Dispatched during loading progression.	AbstractLoader
onLoadStart	Dispatched when loader starts loading.	StreamLoader
onLoadStart	Dispatched when loader starts loading.	AbstractLoader
onLoadTimeOut	Dispatched when a timeout occurs during loading.	StreamLoader
onLoadTimeOut	Dispatched when a timeout occurs during loading.	AbstractLoader

Constructor detail

StreamLoader

()

constructor

public function StreamLoader()

Player version:	Flash Player 9.0
Language version:	ActionScript 3.0

Creates new StreamLoader instance.

Method detail

getLoaderEvent

()

method

protected override function getLoaderEvent(type:String, errorMessage:String = ""):LoaderEvent

Player version:	Flash Player 9.0
Language version:	ActionScript 3.0

Returns a loader event for current loader instance.

Parameters

	`type:String` — Event type to dispatch

	`errorMessage:String` (default = "")

Returns

LoaderEvent — A loader event for current loader instance.

getStream

()

method

public function getStream():URLStream

Player version:	Flash Player 9.0
Language version:	ActionScript 3.0

Returns URLStream content.

Returns

URLStream — The URLStream content

Event detail

onLoadError

event

Event object type: com.bourre.load.StreamLoaderEvent
StreamLoaderEvent.type property = com.bourre.load.StreamLoaderEvent.onLoadErrorEVENT

Player version:	Flash Player 9.0
Language version:	ActionScript 3.0

Dispatched when an error occurs during loading.

Defines the value of the type property of the event object for a onLoadError event.

The properties of the event object have the following values:

Property	Value
`type`	Dispatched event type
Method	Value
`getStreamLoader()`	The loader object
`getErrorMessage()`	The loader error message

onLoadInit

event

Event object type: com.bourre.load.StreamLoaderEvent
StreamLoaderEvent.type property = com.bourre.load.StreamLoaderEvent.onLoadInitEVENT

Player version:	Flash Player 9.0
Language version:	ActionScript 3.0

Dispatched when loading is finished.

Defines the value of the type property of the event object for a onLoadInit event.

The properties of the event object have the following values:

Property	Value
`type`	Dispatched event type
Method	Value
`getStreamLoader()`	The loader object
`getStream()`	The loaded file content

onLoadProgress

event

Event object type: com.bourre.load.StreamLoaderEvent
StreamLoaderEvent.type property = com.bourre.load.StreamLoaderEvent.onLoadProgressEVENT

Player version:	Flash Player 9.0
Language version:	ActionScript 3.0

Dispatched during loading progression.

Defines the value of the type property of the event object for a onLoadProgress event.

The properties of the event object have the following values:

Property	Value
`type`	Dispatched event type
Method	Value
`getStreamLoader()`	The loader object

onLoadStart

event

Event object type: com.bourre.load.StreamLoaderEvent
StreamLoaderEvent.type property = com.bourre.load.StreamLoaderEvent.onLoadStartEVENT

Player version:	Flash Player 9.0
Language version:	ActionScript 3.0

Dispatched when loader starts loading.

Defines the value of the type property of the event object for a onLoadStart event.

The properties of the event object have the following values:

Property	Value
`type`	Dispatched event type
Method	Value
`getStreamLoader()`	The loader object

onLoadTimeOut

event

Event object type: com.bourre.load.StreamLoaderEvent
StreamLoaderEvent.type property = com.bourre.load.StreamLoaderEvent.onLoadTimeOutEVENT

Player version:	Flash Player 9.0
Language version:	ActionScript 3.0

Dispatched when a timeout occurs during loading.

Defines the value of the type property of the event object for a onLoadTimeOut event.

The properties of the event object have the following values:

Property	Value
`type`	Dispatched event type
Method	Value
`getStreamLoader()`	The loader object

Examples

package com.bourre.load 
{
    import com.bourre.log.PixlibDebug;
    
    import flash.net.URLRequest;        

    public class StreamLoaderSample 
    {
        public function StreamLoaderSample()
        {
            var loader : StreamLoader = new StreamLoader( );
            loader.addEventListener( StreamLoaderEvent.onLoadStartEVENT, this );
            loader.addEventListener( StreamLoaderEvent.onLoadProgressEVENT, this );
            loader.addEventListener( StreamLoaderEvent.onLoadInitEVENT, this );
            loader.load( new URLRequest( "archive.zip" ) );
        }
        
        public function onLoadStart( event : StreamLoaderEvent ) : void
        {
            PixlibDebug.INFO( "Stream starts loading from " + event.getLoader().getURL().url );
        }

        public function onLoadProgress( event : StreamLoaderEvent ) : void
        {
            PixlibDebug.INFO( "Stream progression " + event.getLoader().getPerCent() );
        }
        
        public function onLoadInit( event : StreamLoaderEvent ) : void
        {
            PixlibDebug.INFO( "Stream loading complete " + event.getStream() );
        }
    }
}

Submit Feedback

LowRA API documentation 2008- 2009
Licensed under the MOZILLA PUBLIC LICENSE, Version 1.1
mer. févr. 25 2009, 9:22 AM GMT+01:00

LowRA API Documentation	Annexes \| All Packages \| All Classes \| Index \| Frames No Frames
Class StreamLoader	Properties \| Methods \| Events \| Examples

Package	com.bourre.load
Class	public class StreamLoader
Inheritance	StreamLoader AbstractLoader