| Package | org.osmf.net.rules |
| Class | public class RuleBase |
| Inheritance | RuleBase  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
Hide Inherited Public Properties
Show Inherited Public Properties| Property | Defined By | ||
|---|---|---|---|
 | constructor : 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
| Property | Defined By | ||
|---|---|---|---|
| _metricRepository : MetricRepository | RuleBase | ||
Public Methods
| Method | Defined By | ||
|---|---|---|---|
RuleBase(metricRepository:MetricRepository)
Constructor. | RuleBase | ||
Returns the recommendation of this rule
(ideal bitrate, confidence, weight)
Subclasses must implement this method. | RuleBase | ||
|
Indicates whether an object has a specified property defined. | Object | |
|
Indicates whether an instance of the Object class is in the prototype chain of the object specified
as the parameter. | Object | |
|
Indicates whether the specified property exists and is enumerable. | Object | |
|
Sets the availability of a dynamic property for loop operations. | Object | |
|
Returns the string representation of this object, formatted according to locale-specific conventions. | Object | |
|
Returns the string representation of the specified object. | Object | |
|
Returns the primitive value of the specified object. | Object | |
Property Detail
_metricRepository | property |
protected var _metricRepository:MetricRepositorymetricRepository | 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():MetricRepositoryConstructor 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.
ParametersmetricRepository: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.
ReturnsRecommendation |
Mon Apr 10 2017, 12:28 PM -07:00