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 

DroppedFPSMetric  - AS3 OSMF

Packageorg.osmf.net.metrics
Classpublic class DroppedFPSMetric
InheritanceDroppedFPSMetric Inheritance MetricBase Inheritance Object

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

Dropped frames per second metric Measurement unit: frames / second



Public Properties
 PropertyDefined By
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
  desiredSampleLength : Number
The desired length of the content (in seconds) on which the metric is computed
DroppedFPSMetric
 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
  
DroppedFPSMetric(qosInfoHistory:QoSInfoHistory, desiredSampleLength:Number = 10)
Constructor.
DroppedFPSMetric
 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 dropped FPS (no caching)
DroppedFPSMetric
Property Detail

desiredSampleLength

property
desiredSampleLength:Number

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

The desired length of the content (in seconds) on which the metric is computed



Implementation
    public function get desiredSampleLength():Number
    public function set desiredSampleLength(value:Number):void
Constructor Detail

DroppedFPSMetric

()Constructor
public function DroppedFPSMetric(qosInfoHistory:QoSInfoHistory, desiredSampleLength:Number = 10)

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
 
desiredSampleLength:Number (default = 10) — The desired length of the content (in seconds) on which the metric is computed
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 dropped FPS (no caching)

Returns
MetricValue — The value of the dropped FPS