All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class javax.media.protocol.RateRange

java.lang.Object
   |
   +----javax.media.protocol.RateRange

public class RateRange
extends Object
Describes the speed at which data flows.

Version:
1.6, 97/08/23.

Constructor Index

 o RateRange(float, float, float, boolean)
Constructor using required values.
 o RateRange(RateRange)
Copy constructor.

Method Index

 o getCurrentRate()
Get the current rate.
 o getMaximumRate()
Get the maximum rate supported by this range.
 o getMinimumRate()
Get the minimum rate supported by this range.
 o isExact()
Determine whether or not the source will maintain a constant speed when using this rate.
 o setCurrentRate(float)
Set the current rate.

Constructors

 o RateRange
 public RateRange(RateRange r)
Copy constructor.

 o RateRange
 public RateRange(float init,
                  float min,
                  float max,
                  boolean isExact)
Constructor using required values.

Parameters:
init - The initial value for this rate.
min - The minimum value that this rate can take.
max - The maximum value that this rate can take.
isExact - Set to true if the source rate does not vary when using this rate range.

Methods

 o setCurrentRate
 public float setCurrentRate(float rate)
Set the current rate. Returns the rate that was actually set. This implementation just returns the specified rate, subclasses should return the rate that was actually set.

Parameters:
rate - The new rate.
 o getCurrentRate
 public float getCurrentRate()
Get the current rate.

Returns:
The current rate.
 o getMinimumRate
 public float getMinimumRate()
Get the minimum rate supported by this range.

Returns:
The minimum rate.
 o getMaximumRate
 public float getMaximumRate()
Get the maximum rate supported by this range.

Returns:
The maximum rate.
 o isExact
 public boolean isExact()
Determine whether or not the source will maintain a constant speed when using this rate. If the rate varies, synchronization is usually impractical.

Returns:
Returns true if the source will maintain a constant speed at this rate.

All Packages  Class Hierarchy  This Package  Previous  Next  Index