Saturation Property

Description

Returns or sets the saturation 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. Saturation

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

SaturationMinValue property, SaturationMaxValue property, SaturationStepDelta property, SaturationDefaultValue property, IfAutoSaturation property

Sample

A JavaScript sample is provided.

<script language="javascript">

	function btnManageSaturation_onclick() {

            Webcam.OpenSource(); 

            Saturation = Webcam.Saturation;	//get the Saturation value
            SaturationMinValue = Webcam.SaturationMinValue;//get the minimum Saturation value
            SaturationMaxValue = Webcam.SaturationMaxValue;//get the maximum Saturation value
            SaturationDefaultValue = Webcam.SaturationDefaultValue;//get the default Saturation value
            SaturationStepDelta = Webcam.SaturationStepDelta;//get the Saturation step delta
	
            Webcam.Saturation = 1;//change the Saturation value to 1
            Saturation = Webcam.Saturation;	//get the Saturation value

	}

</script>