IDS peak AFL v1.8.0
Loading...
Searching...
No Matches

Exposure time range limits for brightness control. More...

Functions

PEAK_AFL_API_STATUS peak_afl_AutoController_ExposureLimit_IsSupported (peak_afl_controller_handle controller, peak_afl_BOOL8 *supported)
 Check if exposure limit configuration is supported for a controller.
 
PEAK_AFL_API_STATUS peak_afl_AutoController_ExposureLimit_Set (peak_afl_controller_handle controller, peak_afl_double_limit limit)
 Set exposure time limits for automatic exposure control.
 
PEAK_AFL_API_STATUS peak_afl_AutoController_ExposureLimit_Get (peak_afl_controller_handle controller, peak_afl_double_limit *limit)
 Get the current exposure time limits for a controller.
 

Detailed Description

Exposure time range limits for brightness control.

With this feature it is possible to define precisely the allowed range of the exposure time or gains for automatic adjustments, when auto brightness is enabled.

Function Documentation

◆ peak_afl_AutoController_ExposureLimit_Get()

PEAK_AFL_API_STATUS peak_afl_AutoController_ExposureLimit_Get ( peak_afl_controller_handle controller,
peak_afl_double_limit * limit )

Get the current exposure time limits for a controller.

Retrieves the current exposure time limit configuration for the specified controller. The limits define the minimum and maximum exposure times that constrain automatic exposure adjustments. This information is useful for understanding the controller's operational constraints and for verifying limit configurations.

Parameters
[in]controllerController handle to query for exposure limits
[out]limitPointer to receive the current exposure time limits structure containing minimum and maximum exposure times in seconds. If no limits have been set, default values may be returned.
Returns
PEAK_AFL_STATUS_SUCCESS Exposure limits retrieved successfully
PEAK_AFL_STATUS_NOT_INITIALIZED The library is not initialized
PEAK_AFL_STATUS_INVALID_PARAMETER Invalid controller handle or NULL limit pointer
PEAK_AFL_STATUS_NOT_SUPPORTED Exposure limit configuration is not supported
PEAK_AFL_STATUS_ERROR An unexpected internal error occurred
Note
Check support with peak_afl_AutoController_ExposureLimit_IsSupported() before calling
The returned limits reflect the current active configuration
Limit values are in seconds and represent actual camera capabilities
Use this function to verify limit settings after configuration
Default limits may correspond to camera hardware capabilities
See also
peak_afl_AutoController_ExposureLimit_IsSupported()
peak_afl_AutoController_ExposureLimit_Set()
peak_afl_double_limit
Since
1.4

◆ peak_afl_AutoController_ExposureLimit_IsSupported()

PEAK_AFL_API_STATUS peak_afl_AutoController_ExposureLimit_IsSupported ( peak_afl_controller_handle controller,
peak_afl_BOOL8 * supported )

Check if exposure limit configuration is supported for a controller.

Determines whether the specified controller supports exposure limit configuration. Exposure limits allow constraining the automatic exposure adjustments to a specific range, preventing the controller from setting exposure times that are too short (causing underexposure) or too long (causing motion blur or overexposure). This feature is particularly useful in applications with specific timing requirements or motion sensitivity.

Parameters
[in]controllerController handle to check for exposure limit support
[out]supportedPointer to receive support status:
  • PEAK_AFL_TRUE: Exposure limit configuration is supported
  • PEAK_AFL_FALSE: Exposure limit configuration is not supported
Returns
PEAK_AFL_STATUS_SUCCESS Operation completed successfully
PEAK_AFL_STATUS_NOT_INITIALIZED The library is not initialized
PEAK_AFL_STATUS_INVALID_PARAMETER Invalid controller handle or NULL supported pointer
PEAK_AFL_STATUS_ERROR An unexpected internal error occurred
Note
Check this function before attempting to configure exposure limits
Exposure limit support is typically available for brightness controllers
Limits help prevent inappropriate exposure settings in automatic mode
This feature is useful for applications with motion or timing constraints
See also
peak_afl_AutoController_ExposureLimit_Set()
peak_afl_AutoController_ExposureLimit_Get()
peak_afl_double_limit
Since
1.4

◆ peak_afl_AutoController_ExposureLimit_Set()

PEAK_AFL_API_STATUS peak_afl_AutoController_ExposureLimit_Set ( peak_afl_controller_handle controller,
peak_afl_double_limit limit )

Set exposure time limits for automatic exposure control.

Configures the minimum and maximum exposure time limits that constrain the automatic exposure adjustments performed by the controller. The controller will only adjust exposure times within the specified range, preventing exposure settings that could cause underexposure (too short) or motion blur/overexposure (too long). This is essential for applications with specific timing requirements or motion sensitivity.

Parameters
[in]controllerController handle for which to set exposure limits
[in]limitExposure time limit structure containing minimum and maximum exposure times in seconds. The controller will constrain all automatic exposure adjustments to this range. Both min and max values must be positive, and min must be less than or equal to max.
Returns
PEAK_AFL_STATUS_SUCCESS Exposure limits configured successfully
PEAK_AFL_STATUS_NOT_INITIALIZED The library is not initialized
PEAK_AFL_STATUS_INVALID_PARAMETER Invalid controller handle or limit values
PEAK_AFL_STATUS_NOT_SUPPORTED Exposure limit configuration is not supported
PEAK_AFL_STATUS_ERROR An unexpected internal error occurred
Note
Check support with peak_afl_AutoController_ExposureLimit_IsSupported() before using
Limit values are in seconds and must be within camera hardware capabilities
Setting limits too narrow may prevent the controller from achieving target brightness
Changes take effect for subsequent image processing operations
The controller will prioritize staying within limits over achieving exact target brightness
See also
peak_afl_AutoController_ExposureLimit_IsSupported()
peak_afl_AutoController_ExposureLimit_Get()
peak_afl_double_limit
Since
1.4