ActionScript® 3.0 Reference for the Adobe® Flash® Platform
Home  |  Show Packages and Classes List |  Packages  |  Classes  |  What's New  |  Index  |  Appendixes
org.osmf.net.metrics 

BandwidthMetric  - AS3 OSMF

Packageorg.osmf.net.metrics
Classpublic class BandwidthMetric
InheritanceBandwidthMetric Inheritance MetricBase Inheritance Object

Language Version: ActionScript 3.0
Product Version: OSMF 2.0
Runtime Versions: Flash Player 10, AIR 1.5

Bandwidth metric Measurement unit: bytes / seconds



Public Properties
 PropertyDefined By
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
 Inheritedtype : String
[read-only] The type of the metric
MetricBase
 Inheritedvalue : MetricValue
[read-only] The value of this metric If the value has already been computed for the most recent QoSInfo, return the cached result.
MetricBase
  weights : Vector.<Number>
[read-only] The weights of the fragments (starting with the most recent)
BandwidthMetric
Protected Properties
 PropertyDefined By
 InheritedqosInfoHistory : QoSInfoHistory
[read-only] The QoSInfoHistory object used to compute the metric.
MetricBase
Public Methods
 MethodDefined By
  
BandwidthMetric(qosInfoHistory:QoSInfoHistory, weights:Vector.<Number>)
Constructor.
BandwidthMetric
 Inherited
The value of this metric If the value has already been computed for the most recent QoSInfo, return the cached result. This method is internal so it can be overriden by metric mockers, for testing purposes
MetricBase
 Inherited
Indicates whether an object has a specified property defined.
Object
 Inherited
Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.
Object
 Inherited
Indicates whether the specified property exists and is enumerable.
Object
 Inherited
Sets the availability of a dynamic property for loop operations.
Object
 Inherited
Returns the string representation of this object, formatted according to locale-specific conventions.
Object
 Inherited
Returns the string representation of the specified object.
Object
 Inherited
Returns the primitive value of the specified object.
Object
Protected Methods
 MethodDefined By
  
[override] Computes the value of the bandwidth (in bytes/second)
BandwidthMetric
Property Detail

weights

property
weights:Vector.<Number>  [read-only]

Language Version: ActionScript 3.0
Product Version: OSMF 2.0
Runtime Versions: Flash Player 10, AIR 1.5

The weights of the fragments (starting with the most recent)



Implementation
    public function get weights():Vector.<Number>
Constructor Detail

BandwidthMetric

()Constructor
public function BandwidthMetric(qosInfoHistory:QoSInfoHistory, weights:Vector.<Number>)

Language Version: ActionScript 3.0
Product Version: OSMF 2.0
Runtime Versions: Flash Player 10, AIR 1.5

Constructor.

Parameters
qosInfoHistory:QoSInfoHistory — The QoSInfoHistory to be used for computing the metric
 
weights:Vector.<Number> — The weights of the fragments (first values are the weights of the most recent fragments)
Method Detail

getValueForced

()method
override protected function getValueForced():MetricValue

Language Version: ActionScript 3.0
Product Version: OSMF 2.0
Runtime Versions: Flash Player 10, AIR 1.5

Computes the value of the bandwidth (in bytes/second)

Returns
MetricValue