All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class quicktime.std.image.DataRateParams 

java.lang.Object
   |
   +----quicktime.util.QTByteObject
           |
           +----quicktime.std.image.DataRateParams
public final class DataRateParams
extends QTByteObject
implements PrimitivesLib, Cloneable
The Image Compression Manager provides this object to allow your application to communicate information to compressors that can constrain compressed data to a specific data rate.

QuickTime:DataRateParams

Variable Index

o kNativeSize
This is the size (the number of bytes) that are required for this class

Constructor Index

o DataRateParams()
Creates a DataRateParams object with no values set.
o DataRateParams(int, int, int, int, int, int)
Create a DataRateParams object and set the relevant values.

Method Index

o clone()
Returns a copy of this class.
o getDataOverrun()
Gets the current number of bytes above or below the desired rate.
o getDataRate()
Gets the bytes per second to which the data rate is constrained.
o getFrameDuration()
Gets the duration of the current frame in milliseconds.
o getKeyFrameRate()
Gets the frequence of key frames.
o getMinSpatialQuality()
Gets the minimum spatial quality the compressor should use to meet the requested data rate.
o getMinTemporalQuality()
Gets the minimum temporal quality the compressor should use to meet the requested data rate.
o setDataOverrun(int)
Sets the number of bytes above or below the desired data rate.
o setDataRate(int)
Sets the bytes per second to which the data rate must be constrained.
o setFrameDuration(int)
Sets the duration of the frame in milliseconds.
o setKeyFrameRate(int)
Sets the frequence of key frames.
o setMinSpatialQuality(int)
Sets the minimum spatial quality the compressor should use to meet the requested data rate.
o setMinTemporalQuality(int)
Sets the minimum temporal quality the compressor should use to meet the requested data rate.

Variables

o kNativeSize 
 public static final int kNativeSize
This is the size (the number of bytes) that are required for this class

Constructors

o DataRateParams 
 public DataRateParams()
Creates a DataRateParams object with no values set.

o DataRateParams 
 public DataRateParams(int dataRate,
                       int dataOverrun,
                       int frameDuration,
                       int keyFrameRate,
                       int minSpatialQuality,
                       int minTemporalQuality)
Create a DataRateParams object and set the relevant values.

Parameters:
dataRate - the bytes/second to which the data rate must be constrained
dataOverrun - number of bytes above or below the desired rate, if your application does not know the data overrun, this value should be zero.
frameDuration - in milliseconds
keyFrameRate - the frequency of key frames
minSpatialQuality - the minimum spatial quality the compressor should use to meet the requested data rate
minTemporalQuality - the minimum temporal quality the compressor should use to meet the requested data rate

Methods

o getDataRate 
 public int getDataRate()
Gets the bytes per second to which the data rate is constrained.

Returns:
s the data rate in bytes/second
o getDataOverrun 
 public int getDataOverrun()
Gets the current number of bytes above or below the desired rate. A value of zero means that the data rate is being met exactly.

Returns:
the data overrun in bytes
o getFrameDuration 
 public int getFrameDuration()
Gets the duration of the current frame in milliseconds.

Returns:
the current frame duration in milliseconds
o getKeyFrameRate 
 public int getKeyFrameRate()
Gets the frequence of key frames. This frequency is normally identical to the key frame rate passed to the compressBegin method.

Returns:
the key frame rate
o getMinSpatialQuality 
 public int getMinSpatialQuality()
Gets the minimum spatial quality the compressor should use to meet the requested data rate.

Returns:
the minimum spatial quality
o getMinTemporalQuality 
 public int getMinTemporalQuality()
Gets the minimum temporal quality the compressor should use to meet the requested data rate.

Returns:
the minimum temporal quality
o setDataRate 
 public void setDataRate(int dataRate)
Sets the bytes per second to which the data rate must be constrained.

Parameters:
dataRate - in bytes/second
o setDataOverrun 
 public void setDataOverrun(int dataOverrun)
Sets the number of bytes above or below the desired data rate. If your application does not know the data overrun, this value should be set to zero.

Parameters:
dataOverrun - number of bytes
o setFrameDuration 
 public void setFrameDuration(int frameDuration)
Sets the duration of the frame in milliseconds.

Parameters:
frameDuration - in milliseconds
o setKeyFrameRate 
 public void setKeyFrameRate(int keyFrameRate)
Sets the frequence of key frames. This frequency is normally identical to the key frame rate passed to the compressBegin method.

Parameters:
keyFrameRate - the frequency
o setMinSpatialQuality 
 public void setMinSpatialQuality(int minSpatialQuality)
Sets the minimum spatial quality the compressor should use to meet the requested data rate.

Parameters:
minSpatialQuality - an int
o setMinTemporalQuality 
 public void setMinTemporalQuality(int minTemporalQuality)
Sets the minimum temporal quality the compressor should use to meet the requested data rate.

Parameters:
minTemporalQuality - an int
o clone 
 public Object clone()
Returns a copy of this class.

Overrides:
clone in class Object 
All Packages  Class Hierarchy  This Package  Previous  Next  Index