Operation mode configuration for automatic control functionality. More...

Enumerations
enum	peak_afl_controller_automode { PEAK_AFL_CONTROLLER_AUTOMODE_OFF , PEAK_AFL_CONTROLLER_AUTOMODE_CONTINUOUS , PEAK_AFL_CONTROLLER_AUTOMODE_ONCE }
	Auto feature controller operation modes. More...

Functions
PEAK_AFL_API_STATUS	peak_afl_AutoController_Mode_IsSupported (peak_afl_controller_handle controller, peak_afl_BOOL8 *supported)
	Check if automatic mode configuration is supported for a controller.
PEAK_AFL_API_STATUS	peak_afl_AutoController_Mode_Set (peak_afl_controller_handle controller, peak_afl_controller_automode mode)
	Set the automatic processing mode for a controller.
PEAK_AFL_API_STATUS	peak_afl_AutoController_Mode_Get (peak_afl_controller_handle controller, peak_afl_controller_automode *mode)
	Get the current automatic processing mode for a controller.

Detailed Description

Operation mode configuration for automatic control functionality.

For ongoing adaptations the Continuous mode has to be used so that it responds to deviations from the target value. To disable the control functionality automatically once the target value has been reached, (approximately) use the Once mode.

Enumeration Type Documentation

◆ peak_afl_controller_automode

enum peak_afl_controller_automode

Auto feature controller operation modes.

Defines how an auto feature controller operates when processing images. The mode determines when and how often the controller adjusts camera parameters.

See also: peak_afl_AutoController_Mode_Set(); peak_afl_AutoController_Mode_Get()

Enumerator

PEAK_AFL_CONTROLLER_AUTOMODE_OFF

Auto feature disabled.

The controller is disabled and will not process images or adjust camera parameters. Use this mode to temporarily disable auto features without destroying the controller.

PEAK_AFL_CONTROLLER_AUTOMODE_CONTINUOUS

Continuous automatic adjustment.

The controller continuously processes incoming images and adjusts camera parameters as needed. This mode provides real-time adaptation to changing conditions but may cause visible parameter changes during operation.

Note: Best for applications where conditions change frequently

PEAK_AFL_CONTROLLER_AUTOMODE_ONCE

Single adjustment operation.

The controller processes images and adjusts parameters once, then automatically switches to OFF mode. Use this for one-time calibration or when you want manual control over when adjustments occur.

Note: Controller will automatically switch to OFF after completion

Function Documentation

◆ peak_afl_AutoController_Mode_Get()

PEAK_AFL_API_STATUS peak_afl_AutoController_Mode_Get	(	peak_afl_controller_handle	controller,
		peak_afl_controller_automode *	mode )

Get the current automatic processing mode for a controller.

Retrieves the current automatic processing mode configuration for the specified controller. The mode determines how the controller behaves during image processing operations, including whether it actively processes images, performs one-shot adjustments, or remains disabled. This information is useful for understanding the controller's current operational state and for debugging processing behavior.

Parameters

[in]	controller	Controller handle to query for automatic mode
[out]	mode	Pointer to receive the current automatic processing mode: PEAK_AFL_CONTROLLER_AUTOMODE_OFF: Controller is disabled PEAK_AFL_CONTROLLER_AUTOMODE_ONCE: One-shot processing mode PEAK_AFL_CONTROLLER_AUTOMODE_CONTINUOUS: Continuous processing mode See peak_afl_controller_automode for all possible values.

Returns: PEAK_AFL_STATUS_SUCCESS Automatic mode retrieved successfully; PEAK_AFL_STATUS_NOT_INITIALIZED The library is not initialized; PEAK_AFL_STATUS_INVALID_PARAMETER Invalid controller handle or NULL mode pointer; PEAK_AFL_STATUS_NOT_SUPPORTED Mode configuration is not supported by this controller; PEAK_AFL_STATUS_ERROR An unexpected internal error occurred

Note: Check support with peak_afl_AutoController_Mode_IsSupported() before calling; The returned mode reflects the current active configuration; ONCE mode may automatically change to OFF after processing one image; Use this function to verify mode settings after configuration

See also: peak_afl_AutoController_Mode_IsSupported(); peak_afl_AutoController_Mode_Set(); peak_afl_controller_automode

Since: 1.0

◆ peak_afl_AutoController_Mode_IsSupported()

PEAK_AFL_API_STATUS peak_afl_AutoController_Mode_IsSupported	(	peak_afl_controller_handle	controller,
		peak_afl_BOOL8 *	supported )

Check if automatic mode configuration is supported for a controller.

Determines whether the specified controller supports automatic mode configuration. Automatic modes control how and when the controller processes images and adjusts camera parameters. Different modes include continuous processing, one-shot operation, or disabled state. Not all controller types support mode configuration, and available modes may vary between different controller implementations.

Parameters

[in]	controller	Controller handle to check for automatic mode support
[out]	supported	Pointer to receive support status: PEAK_AFL_TRUE: Automatic mode configuration is supported PEAK_AFL_FALSE: Automatic mode 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 controller modes; Mode support may vary between different controller types; Available modes are defined in peak_afl_controller_automode

See also: peak_afl_AutoController_Mode_Set(); peak_afl_AutoController_Mode_Get(); peak_afl_controller_automode

Since: 1.0

◆ peak_afl_AutoController_Mode_Set()

PEAK_AFL_API_STATUS peak_afl_AutoController_Mode_Set	(	peak_afl_controller_handle	controller,
		peak_afl_controller_automode	mode )

Set the automatic processing mode for a controller.

Configures how the controller processes images and adjusts camera parameters. The automatic mode determines the controller's behavior during image processing, such as whether it operates continuously, performs one-shot adjustments, or remains disabled. Different modes provide different levels of automation and control over when parameter adjustments occur.

Parameters

[in]	controller	Controller handle for which to set the automatic mode
[in]	mode	Automatic processing mode to configure. Available modes include: PEAK_AFL_CONTROLLER_AUTOMODE_OFF: Controller is disabled PEAK_AFL_CONTROLLER_AUTOMODE_ONCE: One-shot processing PEAK_AFL_CONTROLLER_AUTOMODE_CONTINUOUS: Continuous processing See peak_afl_controller_automode for complete list.

Returns: PEAK_AFL_STATUS_SUCCESS Automatic mode configured successfully; PEAK_AFL_STATUS_NOT_INITIALIZED The library is not initialized; PEAK_AFL_STATUS_INVALID_PARAMETER Invalid controller handle or unsupported mode value; PEAK_AFL_STATUS_NOT_SUPPORTED Mode configuration is not supported by this controller; PEAK_AFL_STATUS_ERROR An unexpected internal error occurred

Note: Check support with peak_afl_AutoController_Mode_IsSupported() before using; Mode changes take effect for subsequent image processing operations; OFF mode disables all automatic adjustments by the controller; CONTINUOUS mode processes every image (subject to skip frames settings); ONCE mode processes a single image then switches to OFF mode

See also: peak_afl_AutoController_Mode_IsSupported(); peak_afl_AutoController_Mode_Get(); peak_afl_controller_automode

Since: 1.0

Enumerations

Functions

Detailed Description

Enumeration Type Documentation

◆ peak_afl_controller_automode

Function Documentation

◆ peak_afl_AutoController_Mode_Get()

◆ peak_afl_AutoController_Mode_IsSupported()

◆ peak_afl_AutoController_Mode_Set()