Packagecom.adobe.mediacore
Classpublic class BufferControlParameters
InheritanceBufferControlParameters Inheritance Object

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



Public Properties
 PropertyDefined By
  initialBufferTime : uint
[read-only] Initial buffer time expressed in milliseconds.
BufferControlParameters
  playbackBufferTime : uint
[read-only] Playback buffer time expressed in milliseconds.
BufferControlParameters
Public Methods
 MethodDefined By
  
BufferControlParameters(initialBufferTime:uint, playbackBufferTime:uint)
Default constructor.
BufferControlParameters
  
createDual(initialBufferTime:uint, playbackBufferTime:uint):BufferControlParameters
[static] Factory method.
BufferControlParameters
  
[static] Factory method.
BufferControlParameters
  
Checks if this instance is equal with the specified one.
BufferControlParameters
  
toString():String
Returns a String representation of the current adaptive bit rate parameters.
BufferControlParameters
Property Detail
initialBufferTimeproperty
initialBufferTime:uint  [read-only]

Initial buffer time expressed in milliseconds. The player will buffer this much data when starting the playback or when executing a seeking command.


Implementation
    public function get initialBufferTime():uint
playbackBufferTimeproperty 
playbackBufferTime:uint  [read-only]

Playback buffer time expressed in milliseconds. During playback the player will try to buffer this much data.


Implementation
    public function get playbackBufferTime():uint
Constructor Detail
BufferControlParameters()Constructor
public function BufferControlParameters(initialBufferTime:uint, playbackBufferTime:uint)

Default constructor.

Parameters
initialBufferTime:uint — value used for initial playback start-up.
 
playbackBufferTime:uint — value used during playback.
Method Detail
createDual()method
public static function createDual(initialBufferTime:uint, playbackBufferTime:uint):BufferControlParameters

Factory method. Creates a buffer control parameters instance using the specified values for initial buffer and playback buffer.

Parameters

initialBufferTime:uint — 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.
 
playbackBufferTime:uint — 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.

Returns
BufferControlParameters — an instance of the BufferControlParameters
createSimple()method 
public static function createSimple(bufferTime:uint):BufferControlParameters

Factory method. Creates a buffer control parameters instance using the same value both for initial buffer and playback buffer.

Parameters

bufferTime:uint — the value of the player buffer time and the initial buffer time (expressed in ms).

Returns
BufferControlParameters — an instance of the BufferControlParameters
isEqual()method 
public function isEqual(other:BufferControlParameters):Boolean

Checks if this instance is equal with the specified one.

Parameters

other:BufferControlParameters — the instance to be compared to.

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

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

Returns
String — a string representation