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 

BufferBandwidthRule  - AS3 OSMF

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

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

BufferBandwidthRule is an enhanced version of BandwidthRule The change is that if the BandwidthRule recommends a lower bitrate than the current one, the BufferBandwidthRule overrides that low recommendation with the current bitrate if there are enough fragments in the buffer (we can afford to stick to this bitrate for now, since we have a large enough buffer)



Public Properties
 PropertyDefined By
  bufferFragmentsThreshold : Number
The number of fragments in the buffer above which no lower bitrates are recomended. For example, assume the bandwidth has a value of 3000 kbps and the actual bitrate is 5000 kbps. If the number of fragments in the buffer is below the threshold, the rule will recommend 3000 kbps; otherwise, it will recommend 5000 kbps
BufferBandwidthRule
 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
 Inheritedweights : 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
  
BufferBandwidthRule(metricRepository:MetricRepository, weights:Vector.<Number>, bufferFragmentsThreshold:Number)
Constructor.
BufferBandwidthRule
  
[override] The recommendation
BufferBandwidthRule
 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

bufferFragmentsThreshold

property
bufferFragmentsThreshold:Number

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

The number of fragments in the buffer above which no lower bitrates are recomended. For example, assume the bandwidth has a value of 3000 kbps and the actual bitrate is 5000 kbps. If the number of fragments in the buffer is below the threshold, the rule will recommend 3000 kbps; otherwise, it will recommend 5000 kbps



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

BufferBandwidthRule

()Constructor
public function BufferBandwidthRule(metricRepository:MetricRepository, weights:Vector.<Number>, bufferFragmentsThreshold: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)
 
bufferFragmentsThreshold:Number — The number of fragments in the buffer above which no lower bitrates are recomended. For example, assume the bandwidth has a value of 3000 kbps and the actual bitrate is 5000 kbps. If the number of fragments in the buffer is below the threshold, the rule will recommend 3000 kbps; otherwise, it will recommend 5000 kbps
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