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 

BandwidthRule  - AS3 OSMF

Packageorg.osmf.net.rules
Classpublic class BandwidthRule
InheritanceBandwidthRule Inheritance RuleBase Inheritance Object
Subclasses BufferBandwidthRule

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

BandwidthRule recommends the value of the BandwidthMetric



Public Properties
 PropertyDefined By
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
 InheritedmetricRepository : MetricRepository
[read-only] The metric repository.
RuleBase
  weights : Vector.<Number>
[read-only] The weights of the fragments (first values are the weights of the most recent fragments
BandwidthRule
Protected Properties
 PropertyDefined By
 Inherited_metricRepository : MetricRepository
RuleBase
Public Methods
 MethodDefined By
  
BandwidthRule(metricRepository:MetricRepository, weights:Vector.<Number>)
Constructor.
BandwidthRule
  
[override] The recommendation: Bitrate: The value of the BandwidthMetric Confidence: Scaled according to the weights and the number of available fragments
BandwidthRule
 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
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 (first values are the weights of the most recent fragments



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

BandwidthRule

()Constructor
public function BandwidthRule(metricRepository:MetricRepository, weights:Vector.<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
 
weights:Vector.<Number> — The weights of the fragments (first values are the weights of the most recent fragments)
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:

  • Bitrate: The value of the BandwidthMetric
  • Confidence: Scaled according to the weights and the number of available fragments

Returns
Recommendation