javax.media.control
Interface FrameRateControl

All Superinterfaces:
Control

public interface FrameRateControl
extends Control

This interface is a Control for specifying the parameters for frame rate.

Since:
JMF 2.0

Method Summary
 float getFrameRate()
          Returns the current output frame rate.
 float getMaxSupportedFrameRate()
          Returns the maximum output frame rate.
 float getPreferredFrameRate()
          Returns the default output frame rate.
 float setFrameRate(float newFrameRate)
          Sets the frame rate.
 
Methods inherited from interface javax.media.Control
getControlComponent
 

Method Detail

getFrameRate

public float getFrameRate()
Returns the current output frame rate. Returns -1 if it is unknown.

Returns:
the output output frame rate in frames per second.

setFrameRate

public float setFrameRate(float newFrameRate)
Sets the frame rate. Returns -1 if it is unknown or it is not controllable.

Parameters:
newFrameRate - the requested new frame rate
Returns:
the actual frame rate in frames per second.

getMaxSupportedFrameRate

public float getMaxSupportedFrameRate()
Returns the maximum output frame rate. Returns -1 if it is unknown.

Returns:
the maximum output frame rate in frames per second.

getPreferredFrameRate

public float getPreferredFrameRate()
Returns the default output frame rate. Returns -1 if it is unknown.

Returns:
the default output frame rate in frames per second.