Skip to content

GenICam

GenICam - Close

Close camera

IN

Name Type Description
InCameraHandle DynamicEnum Camera handle.This value is based on Acquire settings.Type : string
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
Error ErrorState Gets the execution error message

GenICam - ExecuteCommand

Execute a command from GenICam

IN

Name Type Description
Scope Enum Defines the parameter's scope.
ParameterName GenICamParameter Defines the parameter's name.
InCameraHandle DynamicEnum Camera handle.This value is based on Acquire settings.Type : string
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
Error ErrorState Gets the execution error message

GenICam - GetParameter

Gets a parameter value of specific type from GenICam device.

IN

Name Type Description
CameraHandle DynamicEnum Camera handle.This value is based on Acquire settings.
Scope Enum Defines the parameter's scope.
ParameterName GenICamParameter Defines the parameter's name.
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
OutValue T The obtained parameter value
Error ErrorState Gets the execution error message

GenICam - GrabImage

Grabs image from selected device.If the device is not grabbing, it will start acquisition using 1 as default NumBuffer for StartAcquisition parameter.

IN

Name Type Description
InNumBuffers Int The buffer length used during acquisition.Value must be changed according to aplication requirements.If acquisition has already started using StartAcquisition this value is ignored.
InTimeout Int The timeout to wait for image,in milliseconds.-1 to wait forever.
InCameraHandle DynamicEnum Camera handle.This value is based on Acquire settings.Type : string
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
OutImage ImageNull The grabbed image.
OutFrameID Int64Null Grabbed image's FrameID.
OutTimestamp Int64Null Grabbed image's Timestamp.
Error ErrorState Gets the execution error message

GenICam - LoadFile

Load GenICam parameters from file

IN

Name Type Description
Scope Enum The scope where parameters take effect.
PathFile PathFile The path file.
InCameraHandle DynamicEnum Camera handle.This value is based on Acquire settings.Type : string
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
Error ErrorState Gets the execution error message

GenICam - Open

Open camera

IN

Name Type Description
InCameraHandle DynamicEnum Camera handle.This value is based on Acquire settings.Type : string
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
Error ErrorState Gets the execution error message

GenICam - SetParameter

Sets a parameter value of specific type to GenICam device.

IN

Name Type Description
InValue < T > The value to set.NOTE: Enum values do not include any spaces.
CameraHandle DynamicEnum Camera handle.This value is based on Acquire settings.
Scope Enum Defines the parameter's scope.
ParameterName GenICamParameter Defines the parameter's name.
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
Error ErrorState Gets the execution error message

GenICam - StartAcquisition

Start camera

IN

Name Type Description
NumBuffers Int The buffer length where images are grabbed.
InCameraHandle DynamicEnum Camera handle.This value is based on Acquire settings.Type : string
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
Error ErrorState Gets the execution error message

GenICam - StopAcquisition

Stop camera

IN

Name Type Description
InCameraHandle DynamicEnum Camera handle.This value is based on Acquire settings.Type : string
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
Error ErrorState Gets the execution error message