WhiteBalance Property

Description

Returns or sets the white balance value available within the Source. This is a runtime property.

ActiveX Edition	Plug-in Edition	Mac Edition
Since V8.0	Since V8.0	Not Supported

Data type

Long.

Syntax

ObjectName. WhiteBalance

Remarks

Using this property after calling OpenSource() method and before calling AcquireImage().

When an error occurs and IfThrowException property is TRUE, an exception will be thrown. Check ErrorCode property and ErrorString property for error information.

See also

WhiteBalanceMinValue property, WhiteBalanceMaxValue property, WhiteBalanceStepDelta property, WhiteBalanceDefaultValue property, IfAutoWhiteBalance property

Sample

A JavaScript sample is provided.

<script language="javascript">

	function btnManageWhiteBalance_onclick() {

            Webcam.OpenSource(); 

            WhiteBalance = Webcam.WhiteBalance;	//get the WhiteBalance value
            WhiteBalanceMinValue = Webcam.WhiteBalanceMinValue;//get the minimum WhiteBalance value
            WhiteBalanceMaxValue = Webcam.WhiteBalanceMaxValue;//get the maximum WhiteBalance value
            WhiteBalanceDefaultValue = Webcam.WhiteBalanceDefaultValue;//get the default WhiteBalance value
            WhiteBalanceStepDelta = Webcam.WhiteBalanceStepDelta;//get the WhiteBalance step delta
	
            Webcam.WhiteBalance = 1;//change the WhiteBalance value to 1
            WhiteBalance = Webcam.WhiteBalance;	//get the WhiteBalance value

	}

</script>