Packagecom.adobe.mediacore.qos
Classpublic final class LoadInformation
InheritanceLoadInformation Inheritance Object

Class containing various QoS information about loading process for various resources ( files, manifest or playlist, tracks etc).


Public Properties
 PropertyDefined By
  downloadDuration : Number
[read-only]
LoadInformation
  mediaDuration : Number
[read-only]
LoadInformation
  periodIndex : int
[read-only]
LoadInformation
  size : Number
[read-only]
LoadInformation
  trackIndex : int
[read-only]
LoadInformation
  trackName : String
[read-only]
LoadInformation
  trackType : String
[read-only]
LoadInformation
  type : String
[read-only]
LoadInformation
  url : String
[read-only]
LoadInformation
Public Methods
 MethodDefined By
  
LoadInformation(type:String, url:String, periodIndex:int, resourceSize:Number, mediaDuration:Number, downloadDuration:Number, trackName:String, trackType:String, trackIndex:int)
Default constructor.
LoadInformation
  
createFragmentLoadInformation(url:String, periodIndex:int, resourceSize:Number, mediaDuration:Number, downloadDuration:Number):LoadInformation
[static] Helper method for creating LoadInformation object containing the download information for the specified fragment.
LoadInformation
  
createManifestLoadInformation(url:String):LoadInformation
[static] Helper method for creating LoadInformation object containing download information for the specified url.
LoadInformation
  
createTrackLoadInformation(url:String, periodIndex:int, resourceSize:Number, mediaDuration:Number, downloadDuration:Number, trackName:String, trackType:String, trackIndex:int):LoadInformation
[static] Helper method for creating LoadInformation object containing the download information for the specified track.
LoadInformation
  
toString():String
Returns a string representation of the load information.
LoadInformation
Property Detail
downloadDurationproperty
downloadDuration:Number  [read-only]


Implementation
    public function get downloadDuration():Number
mediaDurationproperty 
mediaDuration:Number  [read-only]


Implementation
    public function get mediaDuration():Number
periodIndexproperty 
periodIndex:int  [read-only]


Implementation
    public function get periodIndex():int
sizeproperty 
size:Number  [read-only]


Implementation
    public function get size():Number
trackIndexproperty 
trackIndex:int  [read-only]


Implementation
    public function get trackIndex():int
trackNameproperty 
trackName:String  [read-only]


Implementation
    public function get trackName():String
trackTypeproperty 
trackType:String  [read-only]


Implementation
    public function get trackType():String
typeproperty 
type:String  [read-only]


Implementation
    public function get type():String
urlproperty 
url:String  [read-only]


Implementation
    public function get url():String
Constructor Detail
LoadInformation()Constructor
public function LoadInformation(type:String, url:String, periodIndex:int, resourceSize:Number, mediaDuration:Number, downloadDuration:Number, trackName:String, trackType:String, trackIndex:int)

Default constructor.

Parameters
type:String — Type of resource.
 
url:String — The url pointing to the resource.
 
periodIndex:int — The timeline period index associated with this resource.
 
resourceSize:Number — The size of resource in bytes.
 
mediaDuration:Number — The media duration in milliseconds.
 
downloadDuration:Number — Tha total download time in milliseconds.
 
trackName:String — Track name if the resource was an alternate track.
 
trackType:String — Track type if the resource was an alternate track.
 
trackIndex:int — Track index if the resource was an alternate track.
Method Detail
createFragmentLoadInformation()method
public static function createFragmentLoadInformation(url:String, periodIndex:int, resourceSize:Number, mediaDuration:Number, downloadDuration:Number):LoadInformation

Helper method for creating LoadInformation object containing the download information for the specified fragment.

Parameters

url:String — The url for fragment being downloaded.
 
periodIndex:int — A number indicating which period is associated with the downloaded fragment.
 
resourceSize:Number — The size in bytes of the downloaded fragment.
 
mediaDuration:Number — The duration in milliseconds of the downloaded fragment.
 
downloadDuration:Number — The duration in milliseconds of the download.

Returns
LoadInformation — a valid LoadInformation object.
createManifestLoadInformation()method 
public static function createManifestLoadInformation(url:String):LoadInformation

Helper method for creating LoadInformation object containing download information for the specified url.

Parameters

url:String — The url for the manifest being downloaded.

Returns
LoadInformation — a valid LoadInformation object.
createTrackLoadInformation()method 
public static function createTrackLoadInformation(url:String, periodIndex:int, resourceSize:Number, mediaDuration:Number, downloadDuration:Number, trackName:String, trackType:String, trackIndex:int):LoadInformation

Helper method for creating LoadInformation object containing the download information for the specified track.

Parameters

url:String — The url for track being downloaded.
 
periodIndex:int — A number indicating which period is associated with the downloaded track.
 
resourceSize:Number — The size in bytes of the downloaded track.
 
mediaDuration:Number — The duration in milliseconds of the downloaded track.
 
downloadDuration:Number — The duration in milliseconds of the download.
 
trackName:String — Track name.
 
trackType:String — Track type.
 
trackIndex:int — Track index.

Returns
LoadInformation — a valid LoadInformation object.
toString()method 
public function toString():String

Returns a string representation of the load information.

Returns
String — a string representation of load information.




Fri Jun 20 2014, 11:19 AM -07:00