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 

RuleBase  - AS3 OSMF
Packageorg.osmf.net.rules
Classpublic class RuleBase
InheritanceRuleBase Inheritance Object
Subclasses BandwidthRule, DroppedFPSRule, EmptyBufferRule

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

RuleBase is a base class for rules used for Adaptive Bitrate. A rule recommends a bitrate to the switch manager and a confidence in the recommended bitrate. A rule's value is computed based on the values of the metrics.

Related API Elements

org.osmf.net.abr.Recommendation

Public Properties
 PropertyDefined By
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
  metricRepository : MetricRepository
[read-only] The metric repository.
RuleBase
Protected Properties
 PropertyDefined By
  _metricRepository : MetricRepository
RuleBase
Public Methods
 MethodDefined By
  
RuleBase(metricRepository:MetricRepository)
Constructor.
RuleBase
  
getRecommendation():Recommendation
Returns the recommendation of this rule (ideal bitrate, confidence, weight) Subclasses must implement this method.
RuleBase
 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

_metricRepository

property
protected var _metricRepository:MetricRepository

metricRepository

property 
metricRepository:MetricRepository  [read-only]

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

The metric repository. Required metrics are obtained from it.



Implementation
    public function get metricRepository():MetricRepository
Constructor Detail

RuleBase

()Constructor
public function RuleBase(metricRepository:MetricRepository)

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
Method Detail

getRecommendation

()method
public function getRecommendation():Recommendation

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

Returns the recommendation of this rule (ideal bitrate, confidence, weight) Subclasses must implement this method.

Returns
Recommendation



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

 

Legal Notices | Online Privacy Policy