Functions
peak_status	peak_IPL_AutoBrightness_Target_GetRange (peak_camera_handle hCam, uint32_t minAutoBrightnessTarget, uint32_t maxAutoBrightnessTarget, uint32_t *incAutoBrightnessTarget)
	Get the current range of valid host auto brightness target values. More...

peak_status	peak_IPL_AutoBrightness_Target_Set (peak_camera_handle hCam, uint32_t autoBrightnessTarget)
	Set the host auto brightness target value. More...

peak_status	peak_IPL_AutoBrightness_Target_Get (peak_camera_handle hCam, uint32_t *autoBrightnessTarget)
	Get the host auto brightness target value. More...

peak_status	peak_IPL_AutoBrightness_TargetTolerance_GetRange (peak_camera_handle hCam, uint32_t minAutoBrightnessTargetTolerance, uint32_t maxAutoBrightnessTargetTolerance, uint32_t *incAutoBrightnessTargetTolerance)
	Get the current range of valid host auto brightness target tolerance values. More...

peak_status	peak_IPL_AutoBrightness_TargetTolerance_Set (peak_camera_handle hCam, uint32_t autoBrightnessTargetTolerance)
	Set the host auto brightness target tolerance value. More...

peak_status	peak_IPL_AutoBrightness_TargetTolerance_Get (peak_camera_handle hCam, uint32_t *autoBrightnessTargetTolerance)
	Get the host auto brightness target tolerance value. More...

peak_status	peak_IPL_AutoBrightness_TargetPercentile_GetRange (peak_camera_handle hCam, double minAutoBrightnessTargetPercentile, double maxAutoBrightnessTargetPercentile, double *incAutoBrightnessTargetPercentile)
	Get the current range of valid host auto brightness target percentile values. More...

peak_status	peak_IPL_AutoBrightness_TargetPercentile_Set (peak_camera_handle hCam, double autoBrightnessTargetPercentile)
	Set the host auto brightness target percentile value. More...

peak_status	peak_IPL_AutoBrightness_TargetPercentile_Get (peak_camera_handle hCam, double *autoBrightnessTargetPercentile)
	Get the host auto brightness target percentile value. More...

peak_status	peak_IPL_AutoBrightness_ROI_Mode_Set (peak_camera_handle hCam, peak_auto_feature_roi_mode autoBrightnessROIMode)
	Set the host auto brightness ROI mode. More...

peak_status	peak_IPL_AutoBrightness_ROI_Mode_Get (peak_camera_handle hCam, peak_auto_feature_roi_mode *autoBrightnessROIMode)
	Get the host auto brightness ROI mode. More...

peak_status	peak_IPL_AutoBrightness_ROI_Set (peak_camera_handle hCam, peak_roi autoBrightnessROI)
	Set the host auto brightness ROI. More...

peak_status	peak_IPL_AutoBrightness_ROI_Get (peak_camera_handle hCam, peak_roi *autoBrightnessROI)
	Get the host auto brightness ROI. More...

peak_status	peak_IPL_AutoBrightness_Exposure_Mode_Set (peak_camera_handle hCam, peak_auto_feature_mode autoExposureMode)
	Set the host auto exposure control mode. More...

peak_status	peak_IPL_AutoBrightness_Exposure_Mode_Get (peak_camera_handle hCam, peak_auto_feature_mode *autoExposureMode)
	Get the host auto exposure control mode. More...

peak_status	peak_IPL_AutoBrightness_Gain_Mode_Set (peak_camera_handle hCam, peak_auto_feature_mode autoGainMode)
	Set the host auto gain control mode. More...

peak_status	peak_IPL_AutoBrightness_Gain_Mode_Get (peak_camera_handle hCam, peak_auto_feature_mode *autoGainMode)
	Get the host auto gain control mode. More...

Detailed Description

Auto brightness control related functions and types.

This feature is applied in the host.
There is also a camera implementation. See Auto brightness control.

Function Documentation

◆ peak_IPL_AutoBrightness_Exposure_Mode_Get()

peak_status peak_IPL_AutoBrightness_Exposure_Mode_Get	(	peak_camera_handle	hCam,
		peak_auto_feature_mode *	autoExposureMode
	)

Get the host auto exposure control mode.

Reads the current host auto exposure control mode.

Parameters

[in]	hCam	The camera handle.
[out]	autoExposureMode	The current auto exposure control mode.

Returns: PEAK_STATUS_SUCCESS Operation was successful; no error occurred.; PEAK_STATUS_INVALID_PARAMETER autoExposureMode is an invalid pointer.; PEAK_STATUS_INVALID_HANDLE hCam is an invalid camera handle.; PEAK_STATUS_NOT_INITIALIZED The library is not initialized.; PEAK_STATUS_ERROR An unexpected internal error occurred.

◆ peak_IPL_AutoBrightness_Exposure_Mode_Set()

peak_status peak_IPL_AutoBrightness_Exposure_Mode_Set	(	peak_camera_handle	hCam,
		peak_auto_feature_mode	autoExposureMode
	)

Set the host auto exposure control mode.

Writes the desired host auto exposure control mode.

Parameters

[in]	hCam	The camera handle.
[in]	autoExposureMode	The auto exposure control mode to set.

Returns: PEAK_STATUS_SUCCESS Operation was successful; no error occurred.; PEAK_STATUS_INVALID_PARAMETER autoExposureMode is an invalid auto feature mode. Check peak_auto_feature_mode.; PEAK_STATUS_INVALID_HANDLE hCam is an invalid camera handle.; PEAK_STATUS_NOT_INITIALIZED The library is not initialized.; PEAK_STATUS_ERROR An unexpected internal error occurred.

◆ peak_IPL_AutoBrightness_Gain_Mode_Get()

peak_status peak_IPL_AutoBrightness_Gain_Mode_Get	(	peak_camera_handle	hCam,
		peak_auto_feature_mode *	autoGainMode
	)

Get the host auto gain control mode.

Reads the current host auto gain control mode.

Parameters

[in]	hCam	The camera handle.
[out]	autoGainMode	The current auto gain control mode.

Returns: PEAK_STATUS_SUCCESS Operation was successful; no error occurred.; PEAK_STATUS_INVALID_PARAMETER autoGainMode is an invalid pointer.; PEAK_STATUS_INVALID_HANDLE hCam is an invalid camera handle.; PEAK_STATUS_NOT_INITIALIZED The library is not initialized.; PEAK_STATUS_ERROR An unexpected internal error occurred.

◆ peak_IPL_AutoBrightness_Gain_Mode_Set()

peak_status peak_IPL_AutoBrightness_Gain_Mode_Set	(	peak_camera_handle	hCam,
		peak_auto_feature_mode	autoGainMode
	)

Set the host auto gain control mode.

Writes the desired host auto gain control mode.

Parameters

[in]	hCam	The camera handle.
[in]	autoGainMode	The auto gain control mode to set.

Returns: PEAK_STATUS_SUCCESS Operation was successful; no error occurred.; PEAK_STATUS_INVALID_PARAMETER autoGainMode is an invalid auto feature mode. Check peak_auto_feature_mode.; PEAK_STATUS_INVALID_HANDLE hCam is an invalid camera handle.; PEAK_STATUS_NOT_INITIALIZED The library is not initialized.; PEAK_STATUS_ERROR An unexpected internal error occurred.

◆ peak_IPL_AutoBrightness_ROI_Get()

peak_status peak_IPL_AutoBrightness_ROI_Get	(	peak_camera_handle	hCam,
		peak_roi *	autoBrightnessROI
	)

Get the host auto brightness ROI.

Reads the current host auto brightness ROI.

Parameters

[in]	hCam	The camera handle.
[out]	autoBrightnessROI	The auto brightness ROI.

Returns: PEAK_STATUS_SUCCESS Operation was successful; no error occurred.; PEAK_STATUS_INVALID_PARAMETER autoBrightnessROI is an invalid pointer.; PEAK_STATUS_INVALID_HANDLE hCam is an invalid camera handle.; PEAK_STATUS_NOT_INITIALIZED The library is not initialized.; PEAK_STATUS_ERROR An unexpected internal error occurred.

◆ peak_IPL_AutoBrightness_ROI_Mode_Get()

peak_status peak_IPL_AutoBrightness_ROI_Mode_Get	(	peak_camera_handle	hCam,
		peak_auto_feature_roi_mode *	autoBrightnessROIMode
	)

Get the host auto brightness ROI mode.

Reads the current host auto brightness ROI mode.

Parameters

[in]	hCam	The camera handle.
[out]	autoBrightnessROIMode	The current auto brightness ROI mode.

Returns: PEAK_STATUS_SUCCESS Operation was successful; no error occurred.; PEAK_STATUS_INVALID_PARAMETER autoBrightnessROIMode is an invalid pointer.; PEAK_STATUS_INVALID_HANDLE hCam is an invalid camera handle.; PEAK_STATUS_NOT_INITIALIZED The library is not initialized.; PEAK_STATUS_ERROR An unexpected internal error occurred.

◆ peak_IPL_AutoBrightness_ROI_Mode_Set()

peak_status peak_IPL_AutoBrightness_ROI_Mode_Set	(	peak_camera_handle	hCam,
		peak_auto_feature_roi_mode	autoBrightnessROIMode
	)

Set the host auto brightness ROI mode.

Writes the desired host auto brightness ROI mode.

Parameters

[in]	hCam	The camera handle.
[in]	autoBrightnessROIMode	The auto brightness ROI mode to set.

Returns: PEAK_STATUS_SUCCESS Operation was successful; no error occurred.; PEAK_STATUS_INVALID_PARAMETER autoBrightnessROIMode is an invalid auto feature ROI mode. Check peak_auto_feature_roi_mode.; PEAK_STATUS_INVALID_HANDLE hCam is an invalid camera handle.; PEAK_STATUS_NOT_INITIALIZED The library is not initialized.; PEAK_STATUS_ERROR An unexpected internal error occurred.

◆ peak_IPL_AutoBrightness_ROI_Set()

peak_status peak_IPL_AutoBrightness_ROI_Set	(	peak_camera_handle	hCam,
		peak_roi	autoBrightnessROI
	)

Set the host auto brightness ROI.

Writes the desired host auto brightness ROI.

Note: Setting the auto brightness ROI is only possible if PEAK_AUTO_FEATURE_ROI_MODE_MANUAL is set for the auto brightness ROI mode..; The range of valid ROIs for the auto brightness feature is the range of valid image ROIs. It can be queried via peak_ROI_Offset_GetRange and peak_ROI_Size_GetRange.

Parameters

[in]	hCam	The camera handle.
[in]	autoBrightnessROI	The auto brightness ROI to set.

Returns: PEAK_STATUS_SUCCESS Operation was successful; no error occurred.; PEAK_STATUS_OUT_OF_RANGE autoBrightnessROI value is out of range. Check the range of valid values via peak_ROI_Offset_GetRange and peak_ROI_Size_GetRange.; PEAK_STATUS_ACCESS_DENIED The auto brightness ROI mode is not set to PEAK_AUTO_FEATURE_ROI_MODE_MANUAL. Check the auto brightness ROI mode via peak_IPL_AutoBrightness_ROI_Mode_Get.; PEAK_STATUS_INVALID_HANDLE hCam is an invalid camera handle.; PEAK_STATUS_NOT_INITIALIZED The library is not initialized.; PEAK_STATUS_ERROR An unexpected internal error occurred.

◆ peak_IPL_AutoBrightness_Target_Get()

peak_status peak_IPL_AutoBrightness_Target_Get	(	peak_camera_handle	hCam,
		uint32_t *	autoBrightnessTarget
	)

Get the host auto brightness target value.

Reads the current host auto brightness target value.

Parameters

[in]	hCam	The camera handle.
[out]	autoBrightnessTarget	The auto brightness target value.

Returns: PEAK_STATUS_SUCCESS Operation was successful; no error occurred.; PEAK_STATUS_INVALID_PARAMETER autoBrightnessTarget is an invalid pointer.; PEAK_STATUS_INVALID_HANDLE hCam is an invalid camera handle.; PEAK_STATUS_NOT_INITIALIZED The library is not initialized.; PEAK_STATUS_ERROR An unexpected internal error occurred.

◆ peak_IPL_AutoBrightness_Target_GetRange()

peak_status peak_IPL_AutoBrightness_Target_GetRange	(	peak_camera_handle	hCam,
		uint32_t *	minAutoBrightnessTarget,
		uint32_t *	maxAutoBrightnessTarget,
		uint32_t *	incAutoBrightnessTarget
	)

Get the current range of valid host auto brightness target values.

Queries the current range of valid values for the host auto brightness target property.

Parameters

[in]	hCam	The camera handle.
[out]	minAutoBrightnessTarget	The minimum auto brightness target value.
[out]	maxAutoBrightnessTarget	The maximum auto brightness target value.
[out]	incAutoBrightnessTarget	The auto brightness target value increment.

Returns: PEAK_STATUS_SUCCESS Operation was successful; no error occurred.; PEAK_STATUS_INVALID_PARAMETER At least one of minAutoBrightnessTarget, maxAutoBrightnessTarget, and incAutoBrightnessTarget is an invalid pointer.; PEAK_STATUS_INVALID_HANDLE hCam is an invalid camera handle.; PEAK_STATUS_NOT_INITIALIZED The library is not initialized.; PEAK_STATUS_ERROR An unexpected internal error occurred.

◆ peak_IPL_AutoBrightness_Target_Set()

peak_status peak_IPL_AutoBrightness_Target_Set	(	peak_camera_handle	hCam,
		uint32_t	autoBrightnessTarget
	)

Set the host auto brightness target value.

Writes the desired host auto brightness target value.

Parameters

[in]	hCam	The camera handle.
[in]	autoBrightnessTarget	The auto brightness target value to set.

Returns: PEAK_STATUS_SUCCESS Operation was successful; no error occurred.; PEAK_STATUS_OUT_OF_RANGE autoBrightnessTarget value is out of range. Check the range of valid values via peak_IPL_AutoBrightness_Target_GetRange.; PEAK_STATUS_INVALID_HANDLE hCam is an invalid camera handle.; PEAK_STATUS_NOT_INITIALIZED The library is not initialized.; PEAK_STATUS_ERROR An unexpected internal error occurred.

◆ peak_IPL_AutoBrightness_TargetPercentile_Get()

peak_status peak_IPL_AutoBrightness_TargetPercentile_Get	(	peak_camera_handle	hCam,
		double *	autoBrightnessTargetPercentile
	)

Get the host auto brightness target percentile value.

Reads the current host auto brightness target percentile value.

Parameters

[in]	hCam	The camera handle.
[out]	autoBrightnessTargetPercentile	The auto brightness target percentile value.

Returns: PEAK_STATUS_SUCCESS Operation was successful; no error occurred.; PEAK_STATUS_INVALID_PARAMETER autoBrightnessTargetPercentile is an invalid pointer.; PEAK_STATUS_INVALID_HANDLE hCam is an invalid camera handle.; PEAK_STATUS_NOT_INITIALIZED The library is not initialized.; PEAK_STATUS_ERROR An unexpected internal error occurred.

◆ peak_IPL_AutoBrightness_TargetPercentile_GetRange()

peak_status peak_IPL_AutoBrightness_TargetPercentile_GetRange	(	peak_camera_handle	hCam,
		double *	minAutoBrightnessTargetPercentile,
		double *	maxAutoBrightnessTargetPercentile,
		double *	incAutoBrightnessTargetPercentile
	)

Get the current range of valid host auto brightness target percentile values.

Queries the current range of valid values for the host auto brightness target percentile property.

Parameters

[in]	hCam	The camera handle.
[out]	minAutoBrightnessTargetPercentile	The minimum auto brightness target percentile value.
[out]	maxAutoBrightnessTargetPercentile	The maximum auto brightness target percentile value.
[out]	incAutoBrightnessTargetPercentile	The auto brightness target percentile value increment.

Returns: PEAK_STATUS_SUCCESS Operation was successful; no error occurred.; PEAK_STATUS_INVALID_PARAMETER At least one of minAutoBrightnessTargetPercentile, maxAutoBrightnessTargetPercentile, and incAutoBrightnessTargetPercentile is an invalid pointer.; PEAK_STATUS_INVALID_HANDLE hCam is an invalid camera handle.; PEAK_STATUS_NOT_INITIALIZED The library is not initialized.; PEAK_STATUS_ERROR An unexpected internal error occurred.

◆ peak_IPL_AutoBrightness_TargetPercentile_Set()

peak_status peak_IPL_AutoBrightness_TargetPercentile_Set	(	peak_camera_handle	hCam,
		double	autoBrightnessTargetPercentile
	)

Set the host auto brightness target percentile value.

Writes the desired host auto brightness target percentile value.

Parameters

[in]	hCam	The camera handle.
[in]	autoBrightnessTargetPercentile	The auto brightness target percentile value to set.

Returns: PEAK_STATUS_SUCCESS Operation was successful; no error occurred.; PEAK_STATUS_OUT_OF_RANGE autoBrightnessTargetPercentile value is out of range. Check the range of valid values via peak_IPL_AutoBrightness_TargetPercentile_GetRange.; PEAK_STATUS_INVALID_HANDLE hCam is an invalid camera handle.; PEAK_STATUS_NOT_INITIALIZED The library is not initialized.; PEAK_STATUS_ERROR An unexpected internal error occurred.

◆ peak_IPL_AutoBrightness_TargetTolerance_Get()

peak_status peak_IPL_AutoBrightness_TargetTolerance_Get	(	peak_camera_handle	hCam,
		uint32_t *	autoBrightnessTargetTolerance
	)

Get the host auto brightness target tolerance value.

Reads the current host auto brightness target tolerance value.

Parameters

[in]	hCam	The camera handle.
[out]	autoBrightnessTargetTolerance	The auto brightness target tolerance value.

Returns: PEAK_STATUS_SUCCESS Operation was successful; no error occurred.; PEAK_STATUS_INVALID_PARAMETER autoBrightnessTargetTolerance is an invalid pointer.; PEAK_STATUS_INVALID_HANDLE hCam is an invalid camera handle.; PEAK_STATUS_NOT_INITIALIZED The library is not initialized.; PEAK_STATUS_ERROR An unexpected internal error occurred.

◆ peak_IPL_AutoBrightness_TargetTolerance_GetRange()

peak_status peak_IPL_AutoBrightness_TargetTolerance_GetRange	(	peak_camera_handle	hCam,
		uint32_t *	minAutoBrightnessTargetTolerance,
		uint32_t *	maxAutoBrightnessTargetTolerance,
		uint32_t *	incAutoBrightnessTargetTolerance
	)

Get the current range of valid host auto brightness target tolerance values.

Queries the current range of valid values for the host auto brightness target tolerance property.

Parameters

[in]	hCam	The camera handle.
[out]	minAutoBrightnessTargetTolerance	The minimum auto brightness target tolerance value.
[out]	maxAutoBrightnessTargetTolerance	The maximum auto brightness target tolerance value.
[out]	incAutoBrightnessTargetTolerance	The auto brightness target tolerance value increment.

Returns: PEAK_STATUS_SUCCESS Operation was successful; no error occurred.; PEAK_STATUS_INVALID_PARAMETER At least one of minAutoBrightnessTargetTolerance, maxAutoBrightnessTargetTolerance, and incAutoBrightnessTargetTolerance is an invalid pointer.; PEAK_STATUS_INVALID_HANDLE hCam is an invalid camera handle.; PEAK_STATUS_NOT_INITIALIZED The library is not initialized.; PEAK_STATUS_ERROR An unexpected internal error occurred.

◆ peak_IPL_AutoBrightness_TargetTolerance_Set()

peak_status peak_IPL_AutoBrightness_TargetTolerance_Set	(	peak_camera_handle	hCam,
		uint32_t	autoBrightnessTargetTolerance
	)

Set the host auto brightness target tolerance value.

Writes the desired host auto brightness target tolerance value.

Parameters

[in]	hCam	The camera handle.
[in]	autoBrightnessTargetTolerance	The auto brightness target tolerance value to set.

Returns: PEAK_STATUS_SUCCESS Operation was successful; no error occurred.; PEAK_STATUS_OUT_OF_RANGE autoBrightnessTargetTolerance value is out of range. Check the range of valid values via peak_IPL_AutoBrightness_TargetTolerance_GetRange.; PEAK_STATUS_INVALID_HANDLE hCam is an invalid camera handle.; PEAK_STATUS_NOT_INITIALIZED The library is not initialized.; PEAK_STATUS_ERROR An unexpected internal error occurred.

Functions

Detailed Description

Function Documentation

◆ peak_IPL_AutoBrightness_Exposure_Mode_Get()

◆ peak_IPL_AutoBrightness_Exposure_Mode_Set()

◆ peak_IPL_AutoBrightness_Gain_Mode_Get()

◆ peak_IPL_AutoBrightness_Gain_Mode_Set()

◆ peak_IPL_AutoBrightness_ROI_Get()

◆ peak_IPL_AutoBrightness_ROI_Mode_Get()

◆ peak_IPL_AutoBrightness_ROI_Mode_Set()

◆ peak_IPL_AutoBrightness_ROI_Set()

◆ peak_IPL_AutoBrightness_Target_Get()

◆ peak_IPL_AutoBrightness_Target_GetRange()

◆ peak_IPL_AutoBrightness_Target_Set()

◆ peak_IPL_AutoBrightness_TargetPercentile_Get()

◆ peak_IPL_AutoBrightness_TargetPercentile_GetRange()

◆ peak_IPL_AutoBrightness_TargetPercentile_Set()

◆ peak_IPL_AutoBrightness_TargetTolerance_Get()

◆ peak_IPL_AutoBrightness_TargetTolerance_GetRange()

◆ peak_IPL_AutoBrightness_TargetTolerance_Set()