IDS peak comfortC v1.10.0
Loading...
Searching...
No Matches

Functions

PEAK_API_STATUS peak_IPL_AutoBrightness_Exposure_Mode_Set (peak_camera_handle hCam, peak_auto_feature_mode autoExposureMode)
 Set the host auto exposure control mode.
 
PEAK_API_STATUS peak_IPL_AutoBrightness_Exposure_Mode_Get (peak_camera_handle hCam, peak_auto_feature_mode *autoExposureMode)
 Get the host auto exposure control mode.
 
PEAK_API_STATUS peak_IPL_AutoBrightness_ExposureLimit_Get (peak_camera_handle hCam, peak_double_limit *exposureLimit)
 Get the host auto exposure limit.
 
PEAK_API_STATUS peak_IPL_AutoBrightness_ExposureLimit_Set (peak_camera_handle hCam, peak_double_limit exposureLimit)
 Set the host auto exposure limit.
 

Detailed Description

Auto brightness exposure 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_API_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]hCamThe camera handle.
[out]autoExposureModeThe 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_API_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]hCamThe camera handle.
[in]autoExposureModeThe 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_ExposureLimit_Get()

PEAK_API_STATUS peak_IPL_AutoBrightness_ExposureLimit_Get ( peak_camera_handle  hCam,
peak_double_limit *  exposureLimit 
)

Get the host auto exposure limit.

Parameters
[in]hCamThe camera handle.
[out]exposureLimitThe current exposure limit.
Returns
PEAK_STATUS_SUCCESS Operation was successful; no error occurred.
PEAK_STATUS_INVALID_PARAMETER exposureLimit 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_ExposureLimit_Set()

PEAK_API_STATUS peak_IPL_AutoBrightness_ExposureLimit_Set ( peak_camera_handle  hCam,
peak_double_limit  exposureLimit 
)

Set the host auto exposure limit.

Parameters
[in]hCamThe camera handle.
[in]exposureLimitThe exposure limit to set.
Returns
PEAK_STATUS_SUCCESS Operation was successful; no error occurred.
PEAK_STATUS_INVALID_PARAMETER exposureLimit 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.