javax.media.control
Interface BufferControl

public interface BufferControl

extends Control

Field Summary

static long	DEFAULT_VALUE
static long	MAX_VALUE

Method Summary

long	getBufferLength() Retrieves the buffer length set on the object exporting this control.
boolean	getEnabledThreshold() Returns true if threshold calculations are enabled, false otherwise
long	getMinimumThreshold() Retrieve the minimum threshold value in milliseconds of the buffer maintained by this control.
long	setBufferLength(long time) Sets the buffer length of the buffer maintained by this object in milliseconds.
void	setEnabledThreshold(boolean b) If false, the set minimum threshold value will not be used by this control in any of its buffer calculations.
long	setMinimumThreshold(long time) Sets the minimum threshold value in milliseconds for the buffer maintained by this control.

Methods inherited from interface javax.media.Control

getControlComponent

Field Detail

DEFAULT_VALUE

public static final long DEFAULT_VALUE

MAX_VALUE

public static final long MAX_VALUE

Method Detail

getBufferLength

public long getBufferLength()

Retrieves the buffer length set on the object exporting this control. The buffer length is in millisecs. The actual size of the buffer will be calculated depending on the format of the stream.

Returns:

the buffer length in millisecs.

setBufferLength

public long setBufferLength(long time)

Sets the buffer length of the buffer maintained by this object in milliseconds. Returns the actual buffer length set. A value of MAX_VALUE indicates that the buffer length should be set to a large enough value so as not to drop any packets. i.e. the limit is only to prevent abnormal usage of memory, but would indicate buffering of all data is to be done and no packet dropping is to be implemented. DEFAULT_VALUE indicates that the buffer length should be restored to its default value.

Returns:

the actual buffer length set on this control

getMinimumThreshold

public long getMinimumThreshold()

Retrieve the minimum threshold value in milliseconds of the buffer maintained by this control. The minimum threshold is used to siginify the minimum amount of data that is to be buffered by the control before pushing data out or allowing data to be pulled out (jitter buffer). Data will only be available from this object when this minimum threshold has been reached. In case the amount of data in the buffer reduces below this value, data will again be buffered until this minimum threshold is reached.

Returns:

The minimum threshold set on this control

setMinimumThreshold

public long setMinimumThreshold(long time)

Sets the minimum threshold value in milliseconds for the buffer maintained by this control. Returns the actual minimum threshold value set.A value of MAX_VALUE indicates the minimum threshold should be set to the maximum value as maintained by this cotrol. A value of DEFAULT_VALUE indicates that the threshold should be restored to its original length.

Returns:

the actual minimum threshold set on this control

setEnabledThreshold

public void setEnabledThreshold(boolean b)

If false, the set minimum threshold value will not be used by this control in any of its buffer calculations. If true, data is not available until the threshold condition is satisifed. The default is that the threshold is enabled.

getEnabledThreshold

public boolean getEnabledThreshold()

Returns true if threshold calculations are enabled, false otherwise

Returns:

true if threshold is enabled, false otherwise