Packagecom.adobe.mediacore
Classpublic final class ABRControlParameters
InheritanceABRControlParameters Inheritance Object

Encapsulates all ABR control parameters. Currently supported parameters are: - adaptive bit-rate switch policy - minimum bit-rate - maximum bit-rate - initial bit-rate



Public Properties
 PropertyDefined By
  initialBitRate : int
[read-only] The value of the initial bit-rate control parameter.
ABRControlParameters
  maxBitRate : int
[read-only] The value of the maximum bit-rate control parameter.
ABRControlParameters
  minBitRate : int
[read-only] The value of the minimum bit-rate control parameter.
ABRControlParameters
  policy : String
[read-only] The value of the initial bit-rate control parameter.
ABRControlParameters
Public Methods
 MethodDefined By
  
ABRControlParameters(policy:String, initialBitRate:int, minBitRate:int, maxBitRate:int)
Constructor method.
ABRControlParameters
  
Checks if two ABR control parameters are equal.
ABRControlParameters
  
toString():String
Returns a String representation of the current adaptive bit rate parameters.
ABRControlParameters
Public Constants
 ConstantDefined By
  AGGRESSIVE_POLICY : String = aggressivePolicy
[static] Aggressive policy for ABR switching logic.
ABRControlParameters
  CONSERVATIVE_POLICY : String = conservativePolicy
[static] Conservative policy for ABR switching logic.
ABRControlParameters
  MODERATE_POLICY : String = moderatePolicy
[static] Moderate policy for ABR switching logic.
ABRControlParameters
Property Detail
initialBitRateproperty
initialBitRate:int  [read-only]

The value of the initial bit-rate control parameter.


Implementation
    public function get initialBitRate():int
maxBitRateproperty 
maxBitRate:int  [read-only]

The value of the maximum bit-rate control parameter.


Implementation
    public function get maxBitRate():int
minBitRateproperty 
minBitRate:int  [read-only]

The value of the minimum bit-rate control parameter.


Implementation
    public function get minBitRate():int
policyproperty 
policy:String  [read-only]

The value of the initial bit-rate control parameter.


Implementation
    public function get policy():String
Constructor Detail
ABRControlParameters()Constructor
public function ABRControlParameters(policy:String, initialBitRate:int, minBitRate:int, maxBitRate:int)

Constructor method. Sets the values for the ABR control parameters. NOTE: this is the only place where the values for the ABR parameters can be set (their values are read-only).

Parameters
policy:String — the policy that dictates the behavior of the bit-switching algorithm.
 
initialBitRate:int — the value of the initial bit-rate (expressed in bps). The profile with the closes bit-rate value is selected when playback is started.
 
minBitRate:int — the value of the minimum bit-rate (expressed in bps). All profiles with a bit-rate lower than this value are ignored by the ABR switching algorithm.
 
maxBitRate:int — the value of the maximum bit-rate (expressed in bps). All profiles with a bit-rate grater than this value are ignored by the ABR switching algorithm.
Method Detail
isEqual()method
public function isEqual(other:ABRControlParameters):Boolean

Checks if two ABR control parameters are equal.

Parameters

other:ABRControlParameters — the ABR control parameters to be compared.

Returns
Boolean — true if are equal, false otherwise.
toString()method 
public function toString():String

Returns a String representation of the current adaptive bit rate parameters.

Returns
String
Constant Detail
AGGRESSIVE_POLICYConstant
public static const AGGRESSIVE_POLICY:String = aggressivePolicy

Aggressive policy for ABR switching logic. Starts at the highest BW, steps up automatically whenever possible.

CONSERVATIVE_POLICYConstant 
public static const CONSERVATIVE_POLICY:String = conservativePolicy

Conservative policy for ABR switching logic. Starts at lowest BW, steps up automatically when available BW is 50% more than required BW for step-up.

MODERATE_POLICYConstant 
public static const MODERATE_POLICY:String = moderatePolicy

Moderate policy for ABR switching logic. Starts at the median BW, steps up automatically when available BW is 20% more than required BW for step-up.