com.adobe.mediacore
Class BufferControlParameters

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

public final class BufferControlParameters
extends Object

Encapsulates all buffer control parameters. Currently parameters are: - initial buffer time - play buffer time


Method Summary
static BufferControlParameters createDual(long initialBuffer, long bufferTime)
          Factory method.
static BufferControlParameters createSimple(long bufferTime)
          Factory method.
 long getInitialBufferTime()
           
 long getPlayBufferTime()
           
 String toString()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Method Detail

createSimple

public static BufferControlParameters createSimple(long bufferTime)
Factory method. Sets the values for the buffer control parameters. NOTE: The values for the buffer parameters are read-only.

Parameters:
bufferTime - the value of the player buffer time and the initial buffer time (expressed in ms).
Returns:
an instance of the BufferControlParameters

createDual

public static BufferControlParameters createDual(long initialBuffer,
                                                 long bufferTime)
Factory method. Sets the values for the buffer control parameters. NOTE: The values for the buffer parameters are read-only.

Parameters:
initialBuffer - the value of the initial buffer time (expressed in ms). Once the player buffer reaches this threshold, playback can begin. This allows a fast start experience.
bufferTime - the value of the player buffer time (expressed in ms). The player will buffer fragments until it reaches this value. The buffer length can exceed this value, since this is the Low Water Mark. There is also a High Water Mark in place, that depends on the LWM, above which the buffer
Returns:
an instance of the BufferControlParameters

getInitialBufferTime

public long getInitialBufferTime()
Returns:
the initial buffer time value.

getPlayBufferTime

public long getPlayBufferTime()
Returns:
the player buffer time.

toString

public String toString()
Overrides:
toString in class Object
Returns:
a String representation of the current buffer control parameters.