GetOption

Description

Obtains the value of a specific option for a camera device.

Applies to

Camera objects

Syntax

objectname.GetOption ( Opt )

Argument	Description
objectname	The name of the camera object that you want to inquire about
Opt	A value of the CameraOption enumerated variable that specifies the name of the option that you want to want to inquire about. For a list of options, see Usage

Returns

Integer. Returns the value of the option or 0 if the option is not supported on the device.

Usage

Use the GetOption function to obtain the value of a specific option. Camera options are settings available on various devices. Not all options are available on all devices. Most options are cached and used only when applicable. Some options, such as CamOptPowerUp, are acted on immediately.

The following table lists the available options and their settings. The third column in the table lists some of the devices that support each option. Note that support for devices is limited in this release, and not all listed devices are supported.

Option	Setting	Example of supported device
CamOptAEMetering!	Automatic Exposure Metering points. Values are: 0 = full picture averaging 1 = center weighted 2 = center spot	HP PhotoSmart VEO 130S
CamOptBrightness!	Brightness of the image. Values are: 0 = low exposure 1000 = high exposure	Hitachi G1000 LifeView FlyCam CF
CamOptCaptureFormat!	Format of captured image. On some devices, JPEG is the only format supported. Values are: 1 = JPEG (default) 2 = MPEG4
CamOptCaptureMode!	Capture mode. Values are: 1 = static image (default) 2 = video
CamOptColorMode!	Color of the picture. Values are: 0 = full color 1 = black and white 2 = negative 4 = “cool” colors	HP PhotoSmart VEO 130S
CamOptContrast!	Image contrast for adjacent areas of the image. The value is an integer in the range 0 to 1000.	LifeView FlyCam CF
CamOptFlash!	Whether the flash should be fired when capturing the image.Values are: 0 = clear flash mode 1 = set flash mode	LifeView FlyCam CF
CamOptFlashDistance!	The distance from the flash to the subject. Values are: Flash_50cm, Flash_100cm, Flash_150cm, or Flash_300cm	LifeView FlyCam CF
CamOptFlickerFrequency!	Sets the flicker filter frequency. Values are: 0 = Automatic (not supported on all devices) 50 = 50Hz 60 = 60Hz (default)	LifeView FlyCam CF
CamOptGamma!	Amount of gamma correction applied to the luminance values of the picture. The value is an integer in the range 0 to 1000.
CamOptHue!	The quality of a color as determined by its dominant wavelength. The value is an integer in the range -180 to 180 with a default of 0.	LifeView FlyCam CF
CamOptLuminosity!	Adjusts image to compensate for the amount of light emitted by the subject. The value is an integer in the range 0 to 1000.	LifeView FlyCam CF
CamOptMoonLight!	Sets or clears night vision (moonlight) mode. Values are: 0 = clear moonlight mode 1 = set moonlight mode	LifeView FlyCam CF
CamOptPowerDown!	Turns off the device. Set the value to 1 to turn off the device.	HP PhotoSmart VEO 130S Hitachi G1000
CamOptPowerUp!	Turns on the device. Set the value to 1 to turn on the device.	Hitachi G1000
CamOptPreviewPosLeft!	The left-side position of the preview area. The preview area’s size is fixed at 160 x 120 pixels.	Hitachi G1000
CamOptPreviewPosTop!	The top-side position of the preview area. The preview area’s size is fixed at 160 x 120 pixels.	Hitachi G1000
CamOptQuality!	Picture quality. This option determines the level of compression. The greater the compression, the lower the picture quality. Values are: 0 = good 1 = better 2 = best	HP PhotoSmartVEO 130S
CamOptSaturation!	Amount of color saturation (relative purity of color). The value is an integer in the range 0 to 1000.	LifeView FlyCam CF
CamOptSharpen!	Adjusts sharpness of the image. The value is an integer in the range 1 to 100. For example: 0 = soft (blurred) edges 50 = clear (default) 100 = sharp edges	LifeView FlyCam CF
CamOptTimeOut!	Timeout in seconds for any capture process. Used by devices that can capture an image asynchronously to determine how long the capture function waits for a response. This value is ignored for synchronous devices.
CamOptWhiteBalance!	Adjusts the image to the current light conditions. Values are: 0 = Automatic White Balance (AWD) 1 = Sun/Daylight 2 = Tungsten/Incandescent 3 = Fluorescent 4 = “effects” 5 = Dim/Cloudy	HP PhotoSmart VEO 130S LifeView FlyCam CF Hitachi G1000

Examples

Example 1

The following statements get the value of the CamOptWhiteBalance option:

integer li_return
li_return = g_myCamera.GetOption(CamOptWhiteBalance)
if not li_return = 0 then
   sle_opt.text = "White Balance: " + string(li_return)

else
   sle_opt.text = "White Balance: Unsupported option."
end if