FileDocCategorySizeDatePackage
KeyFrameControl.javaAPI DocJMF 2.1.1e1500Mon May 12 12:20:36 BST 2003javax.media.control

KeyFrameControl

public interface KeyFrameControl implements Control
This interface is a Control for specifying the parameters for key frame interval.
since
2.0

Fields Summary
Constructors Summary
Methods Summary
public intgetKeyFrameInterval()
Returns the current value of the keyFrameInterval. The key frame interval is specified in output frames.

return
the current value of the keyFrameInterval.

public intgetPreferredKeyFrameInterval()
Returns the keyFrameInterval value preferred by the encoder. The key frame interval is specified in output frames.

return
the keyFrameInterval value preferred by the encoder.

public intsetKeyFrameInterval(int frames)
Set the desired interval between key frames, if such a parameter is relevant to the encoder. frames-1 indicates the number of non-key frames that are encoded between key frames. This value is only a hint, and the encoder may choose to override this value if needed.

param
frames key frame interval. It should be greater than or equals to 1. The key frame interval is specified in output frames. getPreferredKeyFrameInterval returns the default.
return
the actual key frame interval set.