Eframing¶

ExecuteEframing¶

Overview: Execute the Eframing by Absolute position.

Definition

CrError ExecuteEframing(CrDeviceHandle deviceHandle, CrEframingInfo* eframingInfo);

Input Parameters

Type	Explanation
CrDeviceHandle	deviceHandle The handle of the connected camera is returned in the variable. This must be set 0 before calling Connect().
CrEframingInfo*	eframingInfo Defined in CrDeviceProperty.h as CrEframingInfo. See: CrEframingInfo

Output parameters: None

Return value

Type	Explanation
CrError	CrError_None on Success Other than errors above, see Status code & Error

Related API

IDeviceCallback::OnWarningExt

Special note (details)

The values specified for horizontal_denominator and vertical_denominator in eframingInfo must be multiplied by 1024.

UpdateEframingArea¶

Overview: Execute the Eframing by Relative position and size.

This API is enabled after ExecuteEframing has been successfully executed. This API alone cannot move or resize framing frames.

Definition

CrError UpdateEframingArea(CrDeviceHandle deviceHandle, CrEframingAreaNumber area, CrEframingAreaGroup group, CrInt16 x, CrInt16 y, CrInt16 width, CrInt16 height);

Input Parameters

Type	Explanation
CrDeviceHandle	deviceHandle The handle of the connected camera is returned in the variable. This must be set 0 before calling Connect().
CrEframingAreaNumber	area Defined in CrDeviceProperty.h as CrEframingAreaNumber.
CrEframingAreaGroup	group Defined in CrDeviceProperty.h as CrEframingAreaGroup.
CrInt16	x To move the position to the left, set a negative value. To move the position to the right, set a positive value.
CrInt16	y To move the position upward, set a negative value. To move the position downward, set a positive value.
CrInt16	width To reduce the size, set a negative value. To increase the size, set a positive value.
CrInt16	height To reduce the size, set a negative value. To increase the size, set a positive value.

Output parameters: None

Return value

Type	Explanation
CrError	CrError_None on Success Other than errors above, see Status code & Error

Related API

Special note (details)

The values specified for the arguments x, y, w, and h must be multiplied by 1024.