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.rules 

DroppedFPSRule  - AS3 OSMF
Packageorg.osmf.net.rules
Classpublic class DroppedFPSRule
InheritanceDroppedFPSRule Inheritance RuleBase Inheritance Object

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

DroppedFPSRule is an emergency rule that recommends a bitrate that would cause an acceptable number of dropped frames per 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 to compute the dropped FPS metric
DroppedFPSRule
  maximumDroppedFPSRatio : Number
The maximum acceptable ratio of dropped FPS (droppedFPS / FPS)
DroppedFPSRule
 InheritedmetricRepository : MetricRepository
[read-only] The metric repository.
RuleBase
Protected Properties
 PropertyDefined By
 Inherited_metricRepository : MetricRepository
RuleBase
Public Methods
 MethodDefined By
  
DroppedFPSRule(metricRepository:MetricRepository, desiredSampleLength:Number, maximumDroppedFPSRatio:Number)
Constructor.
DroppedFPSRule
  
getRecommendation():Recommendation
[override] The recommendation
DroppedFPSRule
 Inherited
hasOwnProperty(name:String):Boolean
Indicates whether an object has a specified property defined.
Object
 Inherited
isPrototypeOf(theClass:Object):Boolean
Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.
Object
 Inherited
propertyIsEnumerable(name:String):Boolean
Indicates whether the specified property exists and is enumerable.
Object
 Inherited
setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void
Sets the availability of a dynamic property for loop operations.
Object
 Inherited
toLocaleString():String
Returns the string representation of this object, formatted according to locale-specific conventions.
Object
 Inherited
toString():String
Returns the string representation of the specified object.
Object
 Inherited
valueOf():Object
Returns the primitive value of the specified object.
Object
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 to compute the dropped FPS metric



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

Throws
ArgumentError — If the desiredSampleLength is set to NaN, zero or a negative number

maximumDroppedFPSRatio

property 
maximumDroppedFPSRatio:Number

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

The maximum acceptable ratio of dropped FPS (droppedFPS / FPS)



Implementation
    public function get maximumDroppedFPSRatio():Number
    public function set maximumDroppedFPSRatio(value:Number):void

Throws
ArgumentError — If the maximumDroppedFramesRatio is set to a value outside the [0, 1] interval (inclusive)
Constructor Detail

DroppedFPSRule

()Constructor
public function DroppedFPSRule(metricRepository:MetricRepository, desiredSampleLength:Number, maximumDroppedFPSRatio:Number)

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

Constructor.

Parameters
metricRepository:MetricRepository — The metric repository from which to retrieve the necessary metrics
 
desiredSampleLength:Number — The desired length of the content (in seconds) on which to compute the dropped FPS metric
 
maximumDroppedFPSRatio:Number — The maximum acceptable ratio of dropped FPS (droppedFPS / FPS)
Method Detail

getRecommendation

()method
override public function getRecommendation():Recommendation

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

The recommendation

Returns
Recommendation



© 2014 Adobe Systems Incorporated. All rights reserved.
Thu Dec 4 2014, 05:50 PM -08:00
 

 

Legal Notices | Online Privacy Policy