javax.microedition.amms.control.imageeffect
Interface WhiteBalanceControl

All Superinterfaces:

javax.microedition.media.Control, EffectControl

public interface WhiteBalanceControl

extends EffectControl

WhiteBalanceControl is an image/video effect for altering the white balance.

Preset

These presets might be supported.

• sunlight (normal daylight)
• cloudy (overcast daylight)
• shade
• tungsten (Tungsten filament lighting. Tungsten filament is commonly used in light bulbs.)
• fluorescent (Fluorescent tube lighting.)
• flash (White balance mode optimal for the integrated flash of the device.)

Field Summary

static int	AUTO Automatic setting.
static int	NEXT Moves the setting to the next supported level.
static int	PREVIOUS Moves the setting to the previous supported level.
static int	UNKNOWN Unknown value.

Fields inherited from interface javax.microedition.amms.control.EffectControl

SCOPE_LIVE_AND_RECORD, SCOPE_LIVE_ONLY, SCOPE_RECORD_ONLY

Method Summary

int	getColorTemp() Gets the color temperature.
int	getMaxColorTemp() Gets the maximum supported color temperature.
int	getMinColorTemp() Gets the minimum supported color temperature.
int	getNumberOfSteps() Tells how many steps the white balance has.
int	setColorTemp(int temp) Sets the color temperature.

Methods inherited from interface javax.microedition.amms.control.EffectControl

getPreset, getPresetNames, getScope, isEnabled, isEnforced, setEnabled, setEnforced, setPreset, setScope

Field Detail

AUTO

public static final int AUTO

Automatic setting.

See Also:

Constant Field Values

NEXT

public static final int NEXT

Moves the setting to the next supported level.

See Also:

Constant Field Values

PREVIOUS

public static final int PREVIOUS

Moves the setting to the previous supported level.

See Also:

Constant Field Values

UNKNOWN

public static final int UNKNOWN

Unknown value.

See Also:

Constant Field Values

Method Detail

setColorTemp

public int setColorTemp(int temp)

Sets the color temperature. This method allows an alternative way to specify the white balance settings compared to the presets. The given value might be rounded to the nearest supported value.

Parameters:

temp - the new color temperature in Kelvins or NEXT for the next larger (hotter) supported value or PREVIOUS for previous smaller (colder) supported value or AUTO to use automatic whitebalance adjustment

Returns:

the value that was actually set in Kelvins or AUTO if in the automatic whitebalance adjustment mode

Throws:

java.lang.IllegalArgumentException - if the given value is not [getMinColorTemp(), getMaxColorTemp()], PREVIOUS, NEXT, or AUTO

See Also:

getColorTemp()

getColorTemp

public int getColorTemp()

Gets the color temperature.

Returns:

the current color temperature in Kelvins or UNKNOWN or AUTO

See Also:

setColorTemp(int)

getMinColorTemp

public int getMinColorTemp()

Gets the minimum supported color temperature.

Returns:

the minimum supported color temperature in Kelvins

getMaxColorTemp

public int getMaxColorTemp()

Gets the maximum supported color temperature.

Returns:

the maximum supported color temperature in Kelvins

getNumberOfSteps

public int getNumberOfSteps()

Tells how many steps the white balance has. That is, how many different color temperatures it is possible to set. Preset AUTO is not counted as a step.

Returns:

the amount of steps