Packagech.capi.net
Interfacepublic interface ILoadInfo

Contains a lot of information about a massive loading.



Public Properties
 PropertyDefined By
  averageSpeed : Number
[read-only] Defines the average speed since the loading has begun.
ILoadInfo
  bytesLoaded : uint
[read-only] Defines the bytes that have been loaded.
ILoadInfo
  bytesRemaining : uint
[read-only] Defines the number of bytes to load.
ILoadInfo
  bytesTotal : uint
[read-only] Defines the total bytes to load.
ILoadInfo
  currentSpeed : Number
[read-only] Defines the current speed of the download (kilobytes per seconds).
ILoadInfo
  elapsedTime : uint
[read-only] Defines the elapsed time since the loading as begun.
ILoadInfo
  filesError : Array
[read-only] Defines the files that haven't been successfully loaded.
ILoadInfo
  filesIdle : Array
[read-only] Defines the files that currently not being loaded (waits in the loading queue).
ILoadInfo
  filesLoading : Array
[read-only] Defines the files that are currently being loaded.
ILoadInfo
  filesSuccess : Array
[read-only] Defines the files that have been successfully loaded.
ILoadInfo
  massLoader : IMassLoader
[read-only] Defines the IMassLoader source.
ILoadInfo
  percentLoaded : uint
[read-only] Defines the percent of bytes loaded.
ILoadInfo
  ratioLoaded : Number
[read-only] Defines a Number between 0 and 1 (included) that represents the ratio of the loaded bytes.
ILoadInfo
  remainingTime : int
[read-only] Defines the remaining time, based on the speed and the bytes that left to be loaded.
ILoadInfo
Public Methods
 MethodDefined By
  
reset():void
Reset all the information about the loading.
ILoadInfo
  
toString():String
Represents the data of the ILoadInfo in a String.
ILoadInfo
  
update():void
Update the information about the loading.
ILoadInfo
Property Detail
averageSpeedproperty
averageSpeed:Number  [read-only]

Defines the average speed since the loading has begun.


Implementation
    public function get averageSpeed():Number
bytesLoadedproperty 
bytesLoaded:uint  [read-only]

Defines the bytes that have been loaded.


Implementation
    public function get bytesLoaded():uint
bytesRemainingproperty 
bytesRemaining:uint  [read-only]

Defines the number of bytes to load.


Implementation
    public function get bytesRemaining():uint
bytesTotalproperty 
bytesTotal:uint  [read-only]

Defines the total bytes to load.


Implementation
    public function get bytesTotal():uint
currentSpeedproperty 
currentSpeed:Number  [read-only]

Defines the current speed of the download (kilobytes per seconds).


Implementation
    public function get currentSpeed():Number
elapsedTimeproperty 
elapsedTime:uint  [read-only]

Defines the elapsed time since the loading as begun.


Implementation
    public function get elapsedTime():uint
filesErrorproperty 
filesError:Array  [read-only]

Defines the files that haven't been successfully loaded.


Implementation
    public function get filesError():Array
filesIdleproperty 
filesIdle:Array  [read-only]

Defines the files that currently not being loaded (waits in the loading queue).


Implementation
    public function get filesIdle():Array
filesLoadingproperty 
filesLoading:Array  [read-only]

Defines the files that are currently being loaded.


Implementation
    public function get filesLoading():Array
filesSuccessproperty 
filesSuccess:Array  [read-only]

Defines the files that have been successfully loaded.


Implementation
    public function get filesSuccess():Array
massLoaderproperty 
massLoader:IMassLoader  [read-only]

Defines the IMassLoader source.


Implementation
    public function get massLoader():IMassLoader
percentLoadedproperty 
percentLoaded:uint  [read-only]

Defines the percent of bytes loaded.


Implementation
    public function get percentLoaded():uint

See also

ratioLoadedproperty 
ratioLoaded:Number  [read-only]

Defines a Number between 0 and 1 (included) that represents the ratio of the loaded bytes.


Implementation
    public function get ratioLoaded():Number

See also

remainingTimeproperty 
remainingTime:int  [read-only]

Defines the remaining time, based on the speed and the bytes that left to be loaded. If the current speed is zero, this value will be -1.


Implementation
    public function get remainingTime():int
Method Detail
reset()method
public function reset():void

Reset all the information about the loading.

toString()method 
public function toString():String

Represents the data of the ILoadInfo in a String.

Returns
String — A String with the useful information.
update()method 
public function update():void

Update the information about the loading.