Functions
peak_access_status	peak_AutoBrightness_GetAccessStatus (peak_camera_handle hCam)
	Query the auto brightness access status.

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

peak_status	peak_AutoBrightness_Target_Set (peak_camera_handle hCam, uint32_t autoBrightnessTarget)
	Set the auto brightness target value.

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

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

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

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

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

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

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

peak_status	peak_AutoBrightness_ROI_Mode_Set (peak_camera_handle hCam, peak_auto_feature_roi_mode autoBrightnessROIMode)
	Set the auto brightness ROI mode.

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

peak_status	peak_AutoBrightness_ROI_Offset_GetRange (peak_camera_handle hCam, peak_position minAutoBrightnessROIOffset, peak_position maxAutoBrightnessROIOffset, peak_position *incAutoBrightnessROIOffset)
	Get the current range of valid auto brightness ROI offsets.

peak_status	peak_AutoBrightness_ROI_Size_GetRange (peak_camera_handle hCam, peak_size minAutoBrightnessROISize, peak_size maxAutoBrightnessROISize, peak_size *incAutoBrightnessROISize)
	Get the current range of valid auto brightness ROI sizes.

peak_status	peak_AutoBrightness_ROI_Set (peak_camera_handle hCam, peak_roi autoBrightnessROI)
	Set the auto brightness ROI.

peak_status	peak_AutoBrightness_ROI_Get (peak_camera_handle hCam, peak_roi *autoBrightnessROI)
	Get the auto brightness ROI.

peak_access_status	peak_AutoBrightness_Exposure_GetAccessStatus (peak_camera_handle hCam)
	Query the auto exposure control access status.

peak_status	peak_AutoBrightness_Exposure_Mode_Set (peak_camera_handle hCam, peak_auto_feature_mode autoExposureMode)
	Set the auto exposure control mode.

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

peak_access_status	peak_AutoBrightness_Gain_GetAccessStatus (peak_camera_handle hCam)
	Query the auto gain control access status.

peak_status	peak_AutoBrightness_Gain_Mode_Set (peak_camera_handle hCam, peak_auto_feature_mode autoGainMode)
	Set the auto gain control mode.

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

Detailed Description

Auto brightness control related functions and types.

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

Function Documentation

◆ peak_AutoBrightness_Exposure_GetAccessStatus()

peak_access_status peak_AutoBrightness_Exposure_GetAccessStatus ( peak_camera_handle hCam )

Query the auto exposure control access status.

Provides the current access status for the auto exposure control feature.

This function implements the Access Status Query principle.

Parameters

[in] hCam The camera handle.

Returns: PEAK_ACCESS_READWRITE The auto exposure control feature is readable and writeable.; PEAK_ACCESS_READONLY The auto exposure control feature is readable only.; PEAK_ACCESS_GFA_LOCK The auto exposure control feature is not accessible because the GFA write access is enabled.; PEAK_ACCESS_NONE The auto exposure control feature is not accessible.; PEAK_ACCESS_NOT_SUPPORTED The auto exposure control feature is not supported.; PEAK_ACCESS_INVALID The function failed. Call peak_Library_GetLastError to get the error code and description.

If the function indicates an error by returning PEAK_ACCESS_INVALID, these are the possible errors:

PEAK_STATUS_INVALID_HANDLE hCam is an invalid camera handle.
PEAK_STATUS_ACCESS_DENIED The auto brightness feature is not accessible. Check the access status via peak_AutoBrightness_GetAccessStatus.
PEAK_STATUS_NOT_INITIALIZED The library is not initialized.
PEAK_STATUS_ERROR An unexpected internal error occurred.

◆ peak_AutoBrightness_Exposure_Mode_Get()

peak_status peak_AutoBrightness_Exposure_Mode_Get	(	peak_camera_handle	hCam,
		peak_auto_feature_mode *	autoExposureMode
	)

Get the auto exposure control mode.

Reads the current 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_ACCESS_DENIED The auto exposure control feature is not available for read access. Check the access status via peak_AutoBrightness_Exposure_GetAccessStatus.; 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_AutoBrightness_Exposure_Mode_Set()

peak_status peak_AutoBrightness_Exposure_Mode_Set	(	peak_camera_handle	hCam,
		peak_auto_feature_mode	autoExposureMode
	)

Set the auto exposure control mode.

Writes the desired 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_ACCESS_DENIED The auto exposure control feature is not available for write access. Check the access status via peak_AutoBrightness_Exposure_GetAccessStatus.; 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_AutoBrightness_Gain_GetAccessStatus()

peak_access_status peak_AutoBrightness_Gain_GetAccessStatus ( peak_camera_handle hCam )

Query the auto gain control access status.

Provides the current access status for the auto gain control feature.

This function implements the Access Status Query principle.

Parameters

[in] hCam The camera handle.

Returns: PEAK_ACCESS_READWRITE The auto gain control feature is readable and writeable.; PEAK_ACCESS_READONLY The auto gain control feature is readable only.; PEAK_ACCESS_GFA_LOCK The auto gain control feature is not accessible because the GFA write access is enabled.; PEAK_ACCESS_NONE The auto gain control feature is not accessible.; PEAK_ACCESS_NOT_SUPPORTED The auto gain control feature is not supported.; PEAK_ACCESS_INVALID The function failed. Call peak_Library_GetLastError to get the error code and description.

If the function indicates an error by returning PEAK_ACCESS_INVALID, these are the possible errors:

PEAK_STATUS_INVALID_HANDLE hCam is an invalid camera handle.
PEAK_STATUS_ACCESS_DENIED The auto brightness feature is not accessible. Check the access status via peak_AutoBrightness_GetAccessStatus.
PEAK_STATUS_NOT_INITIALIZED The library is not initialized.
PEAK_STATUS_ERROR An unexpected internal error occurred.

◆ peak_AutoBrightness_Gain_Mode_Get()

peak_status peak_AutoBrightness_Gain_Mode_Get	(	peak_camera_handle	hCam,
		peak_auto_feature_mode *	autoGainMode
	)

Get the auto gain control mode.

Reads the current 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_ACCESS_DENIED The auto gain control feature is not available for read access. Check the access status via peak_AutoBrightness_Gain_GetAccessStatus.; 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_AutoBrightness_Gain_Mode_Set()

peak_status peak_AutoBrightness_Gain_Mode_Set	(	peak_camera_handle	hCam,
		peak_auto_feature_mode	autoGainMode
	)

Set the auto gain control mode.

Writes the desired 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_ACCESS_DENIED The auto gain control feature is not available for write access. Check the access status via peak_AutoBrightness_Gain_GetAccessStatus.; 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_AutoBrightness_GetAccessStatus()

peak_access_status peak_AutoBrightness_GetAccessStatus ( peak_camera_handle hCam )

Query the auto brightness access status.

Provides the current access status for the auto brightness feature.

This function implements the Access Status Query principle.

Parameters

[in] hCam The camera handle.

Returns: PEAK_ACCESS_READWRITE The auto brightness feature is readable and writeable.; PEAK_ACCESS_READONLY The auto brightness feature is readable only.; PEAK_ACCESS_GFA_LOCK The auto brightness feature is not accessible because the GFA write access is enabled.; PEAK_ACCESS_NONE The auto brightness feature is not accessible.; PEAK_ACCESS_NOT_SUPPORTED The auto brightness feature is not supported.; PEAK_ACCESS_INVALID The function failed. Call peak_Library_GetLastError to get the error code and description.

If the function indicates an error by returning PEAK_ACCESS_INVALID, these are the possible errors:

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_AutoBrightness_ROI_Get()

peak_status peak_AutoBrightness_ROI_Get	(	peak_camera_handle	hCam,
		peak_roi *	autoBrightnessROI
	)

Get the auto brightness ROI.

Reads the current 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_ACCESS_DENIED The auto brightness feature is not available for read access. Check the access status via peak_AutoBrightness_GetAccessStatus.; 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_AutoBrightness_ROI_Mode_Get()

peak_status peak_AutoBrightness_ROI_Mode_Get	(	peak_camera_handle	hCam,
		peak_auto_feature_roi_mode *	autoBrightnessROIMode
	)

Get the auto brightness ROI mode.

Reads the current 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_ACCESS_DENIED The auto brightness feature is not available for read access. Check the access status via peak_AutoBrightness_GetAccessStatus.; 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_AutoBrightness_ROI_Mode_Set()

peak_status peak_AutoBrightness_ROI_Mode_Set	(	peak_camera_handle	hCam,
		peak_auto_feature_roi_mode	autoBrightnessROIMode
	)

Set the auto brightness ROI mode.

Writes the desired 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_ACCESS_DENIED The auto brightness feature is not available for write access. Check the access status via peak_AutoBrightness_GetAccessStatus.; 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_AutoBrightness_ROI_Offset_GetRange()

peak_status peak_AutoBrightness_ROI_Offset_GetRange	(	peak_camera_handle	hCam,
		peak_position *	minAutoBrightnessROIOffset,
		peak_position *	maxAutoBrightnessROIOffset,
		peak_position *	incAutoBrightnessROIOffset
	)

Get the current range of valid auto brightness ROI offsets.

Queries the current range of valid values for the auto brightness ROI offset.

The range of valid auto brightness ROI offset values may depend on the camera configuration and the camera status.
In special the current setting of the image ROI and the current setting of the auto brightness ROI size has an impact on the range of valid auto brightness ROI offset values.

Parameters

[in]	hCam	The camera handle.
[out]	minAutoBrightnessROIOffset	The minimum auto brightness ROI offset values.
[out]	maxAutoBrightnessROIOffset	The maximum auto brightness ROI offset values.
[out]	incAutoBrightnessROIOffset	The auto brightness ROI offset values increments.

Returns: PEAK_STATUS_SUCCESS Operation was successful; no error occurred.; PEAK_STATUS_ACCESS_DENIED The auto brightness feature is not accessible. Check the access status via peak_AutoBrightness_GetAccessStatus.; PEAK_STATUS_INVALID_PARAMETER At least one of minROIOffset, maxROIOffset, and incROIOffset 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_AutoBrightness_ROI_Set()

peak_status peak_AutoBrightness_ROI_Set	(	peak_camera_handle	hCam,
		peak_roi	autoBrightnessROI
	)

Set the auto brightness ROI.

Writes the desired 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.

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_AutoBrightness_ROI_Offset_GetRange and peak_AutoBrightness_ROI_Size_GetRange.; PEAK_STATUS_ACCESS_DENIED The auto brightness feature is not available for write access or the auto brightness ROI mode is not set to PEAK_AUTO_FEATURE_ROI_MODE_MANUAL. Check the access status via peak_AutoBrightness_GetAccessStatus. Check the auto brightness ROI mode via peak_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_AutoBrightness_ROI_Size_GetRange()

peak_status peak_AutoBrightness_ROI_Size_GetRange	(	peak_camera_handle	hCam,
		peak_size *	minAutoBrightnessROISize,
		peak_size *	maxAutoBrightnessROISize,
		peak_size *	incAutoBrightnessROISize
	)

Get the current range of valid auto brightness ROI sizes.

Queries the current range of valid values for the auto brightness ROI dimensions.

The range of valid auto brightness ROI size values may depend on the camera configuration and the camera status.
In special the current setting of the image ROI and the current setting of the auto brightness ROI offset has an impact on the range of valid auto brightness ROI size values.

Parameters

[in]	hCam	The camera handle.
[out]	minAutoBrightnessROISize	The minimum auto brightness ROI size values.
[out]	maxAutoBrightnessROISize	The maximum auto brightness ROI size values.
[out]	incAutoBrightnessROISize	The auto brightness ROI size values increments.

Returns: PEAK_STATUS_SUCCESS Operation was successful; no error occurred.; PEAK_STATUS_ACCESS_DENIED The auto brightness feature is not accessible. Check the access status via peak_AutoBrightness_GetAccessStatus.; PEAK_STATUS_INVALID_PARAMETER At least one of minAutoBrightnessROISize, maxAutoBrightnessROISize, and incAutoBrightnessROISize 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_AutoBrightness_Target_Get()

peak_status peak_AutoBrightness_Target_Get	(	peak_camera_handle	hCam,
		uint32_t *	autoBrightnessTarget
	)

Get the auto brightness target value.

Reads the current 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_ACCESS_DENIED The auto brightness feature is not available for read access. Check the access status via peak_AutoBrightness_GetAccessStatus.; 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_AutoBrightness_Target_GetRange()

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

Get the current range of valid auto brightness target values.

Queries the current range of valid values for the 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_ACCESS_DENIED The auto brightness feature is not accessible. Check the access status via peak_AutoBrightness_GetAccessStatus.; 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_AutoBrightness_Target_Set()

peak_status peak_AutoBrightness_Target_Set	(	peak_camera_handle	hCam,
		uint32_t	autoBrightnessTarget
	)

Set the auto brightness target value.

Writes the desired 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_AutoBrightness_Target_GetRange.; PEAK_STATUS_ACCESS_DENIED The auto brightness feature is not available for write access. Check the access status via peak_AutoBrightness_GetAccessStatus.; 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_AutoBrightness_TargetPercentile_Get()

peak_status peak_AutoBrightness_TargetPercentile_Get	(	peak_camera_handle	hCam,
		double *	autoBrightnessTargetPercentile
	)

Get the auto brightness target percentile value.

Reads the current 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_ACCESS_DENIED The auto brightness feature is not available for read access. Check the access status via peak_AutoBrightness_GetAccessStatus.; 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_AutoBrightness_TargetPercentile_GetRange()

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

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

Queries the current range of valid values for the 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_ACCESS_DENIED The auto brightness feature is not accessible. Check the access status via peak_AutoBrightness_GetAccessStatus.; 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_AutoBrightness_TargetPercentile_Set()

peak_status peak_AutoBrightness_TargetPercentile_Set	(	peak_camera_handle	hCam,
		double	autoBrightnessTargetPercentile
	)

Set the auto brightness target percentile value.

Writes the desired 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_AutoBrightness_TargetPercentile_GetRange.; PEAK_STATUS_ACCESS_DENIED The auto brightness feature is not available for write access. Check the access status via peak_AutoBrightness_GetAccessStatus.; 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_AutoBrightness_TargetTolerance_Get()

peak_status peak_AutoBrightness_TargetTolerance_Get	(	peak_camera_handle	hCam,
		uint32_t *	autoBrightnessTargetTolerance
	)

Get the auto brightness target tolerance value.

Reads the current 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_ACCESS_DENIED The auto brightness feature is not available for read access. Check the access status via peak_AutoBrightness_GetAccessStatus.; 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_AutoBrightness_TargetTolerance_GetRange()

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

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

Queries the current range of valid values for the 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_ACCESS_DENIED The auto brightness feature is not accessible. Check the access status via peak_AutoBrightness_GetAccessStatus.; 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_AutoBrightness_TargetTolerance_Set()

peak_status peak_AutoBrightness_TargetTolerance_Set	(	peak_camera_handle	hCam,
		uint32_t	autoBrightnessTargetTolerance
	)

Set the auto brightness target tolerance value.

Writes the desired 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_AutoBrightness_TargetTolerance_GetRange.; PEAK_STATUS_ACCESS_DENIED The auto brightness feature is not available for write access. Check the access status via peak_AutoBrightness_GetAccessStatus.; 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_AutoBrightness_Exposure_GetAccessStatus()

◆ peak_AutoBrightness_Exposure_Mode_Get()

◆ peak_AutoBrightness_Exposure_Mode_Set()

◆ peak_AutoBrightness_Gain_GetAccessStatus()

◆ peak_AutoBrightness_Gain_Mode_Get()

◆ peak_AutoBrightness_Gain_Mode_Set()

◆ peak_AutoBrightness_GetAccessStatus()

◆ peak_AutoBrightness_ROI_Get()

◆ peak_AutoBrightness_ROI_Mode_Get()

◆ peak_AutoBrightness_ROI_Mode_Set()

◆ peak_AutoBrightness_ROI_Offset_GetRange()

◆ peak_AutoBrightness_ROI_Set()

◆ peak_AutoBrightness_ROI_Size_GetRange()

◆ peak_AutoBrightness_Target_Get()

◆ peak_AutoBrightness_Target_GetRange()

◆ peak_AutoBrightness_Target_Set()

◆ peak_AutoBrightness_TargetPercentile_Get()

◆ peak_AutoBrightness_TargetPercentile_GetRange()

◆ peak_AutoBrightness_TargetPercentile_Set()

◆ peak_AutoBrightness_TargetTolerance_Get()

◆ peak_AutoBrightness_TargetTolerance_GetRange()

◆ peak_AutoBrightness_TargetTolerance_Set()