GetCamera

GetCamera [/DEF/Q /W=winName /Z ] keyword=value

The GetCamera operation provides information about cameras connected to your computer, their current settings, and the options they support.

Except for the availableCameras keyword, you must either include the /DEF flag or specify the name (e.g., Camera0) of the camera window of interest using the /W flag.

GetCamera was added in Igor Pro 7.00, and deprecated in Igor Pro 10.00.

Use MMI_GetCamera instead.

Flags

/DEF	Applies the GetCamera operation to the computer's default camera. Note that the default camera does not have to be represented by an open viewfinder window but it must be connected to the computer.
/W=winName	Specifies the camera window to target. Use the name of the camera window, e.g., camera0, not the name/description of the camera.
	If the camera window is embedded in a graph the name would have the form e.g., graph0#CM0.
/Q	Quiet mode, do not print diagnostics to the history area of the command window.
/Z	Suppress errors. Sets V_Flag to zero or to a non-zero error code.

Keywords

aperture	Returns the current aperture setting or -1 if the aperture setting is not supported by the camera's driver.
	The value is returned in the S_info output variable as a keyword/value pair: "aperture:<value>". Use NumberByKey to get the value.
availableCameras	Returns the description of each available camera in the semicolon-separated string S_cameraNames.
	If you omit the /Q flag, the operation prints a list of available cameras to the history area of the command window.
	The availableCameras keyword is different from all others in that it does not require that you specify a camera via /W or /DEF flags and it can't be used in combination with any other keyword.
colorFilter	Returns the current color filter.
	The value is returned in the S_info output variable as a keyword/value pair: "colorFilter:<value>". Use NumberByKey to get the value.
	Supported filters include:
	Value Filter 0 None 1 Grayscale 2 Negative 3 Solarize 4 Sepia 5 Posterize 6 Whiteboard 7 Blackboard 8 Aqua 1000 Start of vendor-specific color filters
contrast	Returns the contrast level in the range [-1,1].
	Return -1 if contrast control is not supported by the camera's driver.
	The value is returned in the S_info output variable as a keyword/value pair: "contrast:<value>". Use NumberByKey to get the value.
customFocusPoint	Returns the custom focus point as a pair of values (left,top) in the range [0,1] as fractions of the image measured from the top-left corner.
	The value is returned in the S_info output variable as a keyword/value pair: "customFocusPoint:(<value>,<value>)". Use StringByKey to get the text after the colon and then sscanf to parse the result into numeric variables.
denoisingLevel	Returns the denoising level in the range [-1,1].
	Return s-1 if denoising level is not supported by the camera's driver.
	The value is returned in the S_info output variable as a keyword/value pair: "denoisingLevel:<value>". Use NumberByKey to get the value.
description	Returns the description of the current camera.
	The value is returned in the S_info output variable as a keyword/value pair: "Description:<value>". Use StringByKey to get the value.
deviceName	Returns the device name for the specified camera. This is usually a hex number.
	The value is returned in the S_info output variable as a keyword/value pair: "DeviceName:<value>". Use StringByKey to get the value.
digitalZoom	Returns the current digital zoom level.
	The value is returned in the S_info output variable as a keyword/value pair: "digitalZoom:<value>". Use NumberByKey to get the value.
exposureCompensation	Returns the current exposure compensation.
	The value is returned in the S_info output variable as a keyword/value pair: "exposureCompensation:<value>". Use NumberByKey to get the value.
focusMode	Returns the current focus mode.
	The value is returned in the S_info output variable as a keyword/value pair: "focusMode:<value>". Use NumberByKey to get the value.
	Supported focus modes are:
	Value Focus Mode 1 Manual 2 Hyperfocal 4 Infinity 8 Auto focus 16 Continuous 32 Macro
isColorFilterSupported=cf
	Returns true or false for the specified color filter.
	See the colorFilter keyword for supported color filter codes.
	The value is returned in the S_info output variable as a keyword/value pair: "isColorFilterSupported:<value>" where <value> is true or false. Use StringByKey to get the value.
isFlashModeSupported=fm
	Returns true or false for the specified flash mode.
	The value is returned in the S_info output variable as a keyword/value pair: "isFlashModeSupported:<value>" where <value> is true or false. Use StringByKey to get the value.
	Supported flash modes are:
	Value Flash Mode 1 Auto 2 Off 4 On 8 Redeye reduction 16 Fill 32 Torch 64 Video light 128 Front curtain 256 Rear curtain 512 Manual
isFlashReady	Returns the readiness state of the camera flash.
	The value is returned in the S_info output variable as a keyword/value pair: "isFlashReady:<value>" where <value> is true or false. Use StringByKey to get the value.
isFocusModeSupported=fm
	Returns true or false for the specified focus mode.
	See the focusMode keyword for supported focus mode codes.
	The value is returned in the S_info output variable as a keyword/value pair: "isFocusModeSupported:<value>" where <value> is true or false. Use StringByKey to get the value.
isFocusPointModeSupported=fpm
	Returns true or false for the specified focus point mode.
	The value is returned in the S_info output variable as a keyword/value pair: "isFocusPointModeSupported:<value>" where <value> is true or false. Use StringByKey to get the value.
	Supported focus point modes are:
	Value Focus Point Mode 0 Auto 1 Center 2 Face detection 3 Custom point
isIPAvailable	Returns the availability of the image processing. Image processing provides control over white balance, contrast, saturation, sharpening and denoising.
	The value is returned in the S_info output variable as a keyword/value pair: "isIPAvailable:<value>" where <value> is true or false. Use StringByKey to get the value.
isMeteringModeSupported=mm
	Returns true or false for the specified metering mode.
	The value is returned in the S_info output variable as a keyword/value pair: "isMeteringModeSupported:<value>" where <value> is true or false. Use StringByKey to get the value.
	Supported metering modes are:
	Value Metering Mode 1 Matrix 2 Average 3 Spot
isWBModeSupported=wbm
	Returns true or false for the specified white balance mode.
	The value is returned in the S_info output variable as a keyword/value pair: "isWBModeSupported:<value>" where <value> is true or false. Use StringByKey to get the value.
	See the whiteBalanceMode keyword for supported white balance modes.
manualWhiteBalance	Returns the current color temperature in degrees Kelvin.
	The value is returned in the S_info output variable as a keyword/value pair: "manualWhiteBalance:<value>". Use NumberByKey to get the value.
maximumDigitalZoom	Returns the maximum value of digital zoom.
	The value is returned in the S_info output variable as a keyword/value pair: "maximumDigitalZoom:<value>". Use NumberByKey to get the value.
maximumOpticalZoom	Returns the maximum value of optical zoom
	The value is returned in the S_info output variable as a keyword/value pair: "maximumOpticalZoom:<value>". Use NumberByKey to get the value.
opticalZoom	Returns the current optical zoom level.
	The value is returned in the S_info output variable as a keyword/value pair: "opticalZoom:<value>". Use NumberByKey to get the value.
orientation	Returns the angle of the camera sensor relative to its natural orientation in steps of 90 degrees.
	The value is returned in the S_info output variable as a keyword/value pair: "orientation:<value>". Use NumberByKey to get the value.
position	Returns the position of the camera.
	The value is returned in the S_info output variable as a keyword/value pair: "position:<value>" where <value> is true or false. Use StringByKey to get the value.
	Supported positions are:
	Value Position 0 UnspecifiedPosition 1 BackFace 2 FrontFace
saturation	Returns the saturation level in the range [-1,1].
	Return -1 if saturation control is not supported by the driver.
	The value is returned in the S_info output variable as a keyword/value pair: "saturation:<value>". Use NumberByKey to get the value.
sharpeningLevel	Returns the sharpening level in the range [-1,1].
	Returns -1 if the driver does not support sharperningLevel control
	The value is returned in the S_info output variable as a keyword/value pair: "sharpeningLevel:<value>". Use NumberByKey to get the value.
spotMeteringPoint	Returns a pair of values (left,top) defining a spot metering point measured in fractions of the image from the top-left corner.
	The value is returned in the S_info output variable as a keyword/value pair: "spotMeteringPoint:(<value>,<value>)". Use StringByKey to get the text after the colon and then sscanf to parse the result into numeric variables.
supportedApertures	Returns a comma-separated list of floating point numbers representing supported apertures. The list will be empty if the driver does not support changing apertures.
	The value is returned in the S_info output variable as a keyword/value pair: "supportedApertures:<list>". Use StringByKey to get the list.
supportedISOSensitivities
	Returns a comma-separated list of integers representing ISO values. The will be empty if the driver does not provide ISO sensitivities control.
	The value is returned in the S_info output variable as a keyword/value pair: "supportedApertures:<list>". Use StringByKey to get the list.
supportedShutterSpeeds
	Returns a comma-separated list of floating point numbers representing supprted shutter speeds (in seconds). The list will be empty if the driver does not provide shutter speed control.
	The value is returned in the S_info output variable as a keyword/value pair: "supportedShutterSpeeds:<list>". Use StringByKey to get the list.
shutterSpeed	Returns the current shutter speed in seconds.
	Returns -1 if the driver does not support shutter speed control.
	The value is returned in the S_info output variable as a keyword/value pair: "shutterSpeed:<value>". Use NumberByKey to get the value.
viewfinderPixelFormats
	Returns a comma-separated list of floating numbers representing supprted viewfinder pixel formats.
	The value is returned in the S_info output variable as a keyword/value pair: "viewfinderPixelFormats:<list>". Use StringByKey to get the list.
	The following pixel format values are defined:
	Value Pixel Format 1 ARGB32 2 ARGB32_Premultiplied 3 RGB32 4 RGB24 5 RGB565 6 RGB555 7 ARGB8565_Premultiplied 8 BGRA32 9 BGRA32_Premultiplied 10 BGR32 11 BGR24 12 BGR565 13 BGR555 14 BGRA5658_Premultiplied 15 AYUV444 16 Format_AYUV444_Premultiplied 17 YUV444 18 YUV420P 19 YV12 20 UYVY
viewfinderFrameRateRanges
	Returns comma-separated list of floating point pairs of form "(minFrameRate,maxFrameRate)".
	The list is returned in the S_info output variable. It is not a keyword/value pair. Use StringByKey to get the list.
	See ModifyCamera with the keyword setFrameRate for further information.
viewfinderResolutions	Returns comma-separated list of number pairs of form "(width,height)".
	The value is returned in the S_info output variable as a keyword/value pair: "viewfinderResolutions:<list>". Use StringByKey to get the list.
whiteBalanceMode	Returns the current white balance mode.
	The value is returned in the S_info output variable as a keyword/value pair: "whiteBalanceMode:<value>". Use NumberByKey to get the value.
	Supported white balance modes are:
	Value White Balance Mode 0 Auto 1 Manual 2 Sunlight 3 Cloudy 4 Shade 5 Tungsten 6 Fluorescent 7 Flash 8 Sunset 1000 Start of vendor-specific white balance modes

Details

The GetCamera operation includes a broad range of options that may not be supported in practice by either the operating system or the camera driver. Some results are undefined when the driver does not support the corresponding feature.

Except for the availableCameras keyword, you must either include the /DEF flag or specify the name (e.g., Camera0) of the camera window of interest using the /W flag.

Output Variables

The availableCameras keyword returns a semicolon-separated list for camera descriptions in S_cameraNames.

All other keywords return their results in S_info as a string list with keyword:value pairs separated by semicolons. When the result for any keyword consists of multiple possible values they are separated by commas.

Output Variables

GetCamera sets the following output variables:

V_flag	0 if the operation succeeded or a non-zero error code.
S_cameraNames	Set by the availableCameras keyword only to a semicolon-separated list of camera descriptions.
S_info	Set by all keywords except availableCameras to a keyword:value pair terminated by a semicolon. When the result for any keyword consists of multiple possible values they are separated by commas.

See Also

ModifyCamera, NewCamera, MMI - Overview