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 

ActualBitrateMetric  - AS3 OSMF

Packageorg.osmf.net.metrics
Classpublic class ActualBitrateMetric
InheritanceActualBitrateMetric Inheritance MetricBase Inheritance Object

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

Metric computing the actual bitrate of the currently downloading quality level. This metric's type is MetricType.ACTUAL_BITRATE (org.osmf.net.abr.metrics.actualBitrate)



Public Properties
 PropertyDefined By
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
  maxFragments : uint
The maximum number of fragments on which to compute the metric.
ActualBitrateMetric
 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
Protected Properties
 PropertyDefined By
 InheritedqosInfoHistory : QoSInfoHistory
[read-only] The QoSInfoHistory object used to compute the metric.
MetricBase
Public Methods
 MethodDefined By
  
ActualBitrateMetric(qosInfoHistory:QoSInfoHistory, maxFragments:uint = 5)
Constructor.
ActualBitrateMetric
 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 actual bitrate (in kbps) of the currently downloading quality level
ActualBitrateMetric
Property Detail

maxFragments

property
maxFragments:uint

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

The maximum number of fragments on which to compute the metric. The metric will be computed on a lower number of fragments, if less than maxFragments fragments are available in the QoSInfoHistory.



Implementation
    public function get maxFragments():uint
    public function set maxFragments(value:uint):void
Constructor Detail

ActualBitrateMetric

()Constructor
public function ActualBitrateMetric(qosInfoHistory:QoSInfoHistory, maxFragments:uint = 5)

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
 
maxFragments:uint (default = 5) — The maximum number of fragments on which to compute the metric. The metric will be computed on a lower number of fragments, if less than maxFragments fragments are available in the QoSInfoHistory.
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 actual bitrate (in kbps) of the currently downloading quality level

Returns
MetricValue