com.adobe.mediacore
Class ABRControlParameters

java.lang.Object
  extended by com.adobe.mediacore.ABRControlParameters

public final class ABRControlParameters
extends Object

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


Nested Class Summary
static class ABRControlParameters.ABRPolicy
          Enumeration for the supported bit-rate switching policies: - ABR_CONSERVATIVE - Starts at lowest BW, steps up automatically when available BW is 50% more than required BW for step-up.
 
Constructor Summary
ABRControlParameters(int initialBitRate, int minBitRate, int maxBitRate, ABRControlParameters.ABRPolicy abrPolicy)
          Constructor method.
 
Method Summary
 ABRControlParameters.ABRPolicy getABRPolicy()
          Getter method: returns the value of the initial bit-rate control parameter.
 int getInitialBitRate()
          Getter method: returns the value of the initial bit-rate control parameter.
 int getMaxBitRate()
          Getter method: returns the value of the maximum bit-rate control parameter.
 int getMinBitRate()
          Getter method: returns the value of the minimum bit-rate control parameter.
 String toString()
          Returns a String representation of the current adaptive bit rate parameters.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

ABRControlParameters

public ABRControlParameters(int initialBitRate,
                            int minBitRate,
                            int maxBitRate,
                            ABRControlParameters.ABRPolicy abrPolicy)
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:
initialBitRate - 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 - 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 - 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.
abrPolicy - the policy that dictates the behavior of the bit-switching algorithm.
See Also:
ABRPolicy.
Method Detail

getInitialBitRate

public int getInitialBitRate()
Getter method: returns the value of the initial bit-rate control parameter.


getMinBitRate

public int getMinBitRate()
Getter method: returns the value of the minimum bit-rate control parameter.


getMaxBitRate

public int getMaxBitRate()
Getter method: returns the value of the maximum bit-rate control parameter.


getABRPolicy

public ABRControlParameters.ABRPolicy getABRPolicy()
Getter method: returns the value of the initial bit-rate control parameter.


toString

public String toString()
Returns a String representation of the current adaptive bit rate parameters.

Overrides:
toString in class Object
Returns:
a string containing the url and the type of the resource