javax.media.control
Interface KeyFrameControl

All Superinterfaces:

Control

public interface KeyFrameControl

extends Control

This interface is a Control for specifying the parameters for key frame interval.

Since:

2.0

Method Summary

int	getKeyFrameInterval() Returns the current value of the keyFrameInterval.
int	getPreferredKeyFrameInterval() Returns the keyFrameInterval value preferred by the encoder.
int	setKeyFrameInterval(int frames) Set the desired interval between key frames, if such a parameter is relevant to the encoder.

Methods inherited from interface javax.media.Control

getControlComponent

Method Detail

setKeyFrameInterval

public int setKeyFrameInterval(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.

Parameters:

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.

Returns:

the actual key frame interval set.

getKeyFrameInterval

public int getKeyFrameInterval()

Returns the current value of the keyFrameInterval. The key frame interval is specified in output frames.

Returns:

the current value of the keyFrameInterval.

getPreferredKeyFrameInterval

public int getPreferredKeyFrameInterval()

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

Returns:

the keyFrameInterval value preferred by the encoder.