Individual brightness control components for granular parameter adjustment. More...

Topics
	Mode
	Operation mode configuration for brightness control components.
	Callback
	Event notification callbacks for brightness control component operations.

Enumerations
enum	peak_afl_controller_brightness_component { PEAK_AFL_CONTROLLER_BRIGHTNESS_COMPONENT_INVALID , PEAK_AFL_CONTROLLER_BRIGHTNESS_COMPONENT_EXPOSURE , PEAK_AFL_CONTROLLER_BRIGHTNESS_COMPONENT_GAIN , PEAK_AFL_CONTROLLER_BRIGHTNESS_COMPONENT_ANALOG_GAIN , PEAK_AFL_CONTROLLER_BRIGHTNESS_COMPONENT_DIGITAL_GAIN , PEAK_AFL_CONTROLLER_BRIGHTNESS_COMPONENT_COMBINED_GAIN , PEAK_AFL_CONTROLLER_BRIGHTNESS_COMPONENT_HOST_GAIN }
	Brightness control components. More...

Functions
PEAK_AFL_API_STATUS	peak_afl_AutoController_BrightnessComponent_Unit_IsSupported (peak_afl_controller_handle controller, peak_afl_controller_brightness_component unit, peak_afl_BOOL8 *supported)
	Check if a specific brightness component unit is supported for a controller.
PEAK_AFL_API_STATUS	peak_afl_AutoController_BrightnessComponent_Status (peak_afl_controller_handle controller, peak_afl_controller_brightness_component component, peak_afl_controller_status *status)
	Get the operational status for a specific brightness component.

Detailed Description

Individual brightness control components for granular parameter adjustment.

Enumeration Type Documentation

◆ peak_afl_controller_brightness_component

enum peak_afl_controller_brightness_component

Brightness control components.

Defines the different camera parameters that can be adjusted by the brightness controller to achieve target brightness levels. Each component affects image brightness differently and may have different performance characteristics.

Note: Component availability depends on camera capabilities

See also: peak_afl_AutoController_BrightnessComponent_IsSupported()

Enumerator
PEAK_AFL_CONTROLLER_BRIGHTNESS_COMPONENT_INVALID	Invalid or uninitialized component. This value indicates an invalid component type and should not be used for component operations.
PEAK_AFL_CONTROLLER_BRIGHTNESS_COMPONENT_EXPOSURE	Camera exposure time control. Adjusts the camera's exposure time (shutter speed) to control brightness. Longer exposures increase brightness but may introduce motion blur. Generally the preferred method for brightness control when motion is not critical. Note May affect motion blur and frame rate See also Exposure limit
PEAK_AFL_CONTROLLER_BRIGHTNESS_COMPONENT_GAIN	Generic gain control. Adjusts the camera's gain setting using the default gain control. The specific type of gain (analog/digital/combined/host) depends on camera implementation or support. Deprecated Use specific gain types for better control
PEAK_AFL_CONTROLLER_BRIGHTNESS_COMPONENT_ANALOG_GAIN	Analog gain control. Adjusts the sensor's analog gain before digitization. Provides good signal-to-noise ratio but may be limited in range. Preferred over digital gain when available. Note Better noise characteristics than digital gain See also Gain analog limit
PEAK_AFL_CONTROLLER_BRIGHTNESS_COMPONENT_DIGITAL_GAIN	Digital gain control. Adjusts gain in the digital domain after sensor readout. Wider range than analog gain but may amplify noise. Use when analog gain is insufficient or unavailable. Note May amplify sensor noise See also Gain digital limit
PEAK_AFL_CONTROLLER_BRIGHTNESS_COMPONENT_COMBINED_GAIN	Combined analog and digital gain. Automatically manages both analog and digital gain (combined) for optimal signal-to-noise ratio. Typically uses analog gain first, then digital gain for extended range. Note Recommended for best overall performance See also Gain combined limit
PEAK_AFL_CONTROLLER_BRIGHTNESS_COMPONENT_HOST_GAIN	Host-based software gain. Applies gain in software on the host computer after image acquisition. Provides unlimited range but processes images after capture, potentially affecting real-time performance. Note Applied in software, may affect performance See also Gain host limit

Function Documentation

◆ peak_afl_AutoController_BrightnessComponent_Status()

PEAK_AFL_API_STATUS peak_afl_AutoController_BrightnessComponent_Status	(	peak_afl_controller_handle	controller,
		peak_afl_controller_brightness_component	component,
		peak_afl_controller_status *	status )

Get the operational status for a specific brightness component.

Retrieves the current operational status of an individual brightness component within a brightness controller. The status indicates the component's current state, such as whether it is actively processing, has converged to target values, encountered errors, or is idle. This information is valuable for monitoring controller performance and diagnosing issues with specific brightness adjustment mechanisms.

Parameters

[in]	controller	Controller handle to query for brightness component status
[in]	component	Brightness component to query. Available components include exposure time, analog gain, digital gain, and other brightness adjustment mechanisms. See peak_afl_controller_brightness_component for available options.
[out]	status	Pointer to receive the current operational status of the component. Status values indicate processing state, convergence, errors, etc. See peak_afl_controller_status for possible values and meanings.

Returns: PEAK_AFL_STATUS_SUCCESS Brightness component status retrieved successfully; PEAK_AFL_STATUS_NOT_INITIALIZED The library is not initialized; PEAK_AFL_STATUS_INVALID_PARAMETER Invalid controller handle, component, or NULL status pointer; PEAK_AFL_STATUS_NOT_SUPPORTED Component status monitoring is not supported; PEAK_AFL_STATUS_ERROR An unexpected internal error occurred

Note: Component status is updated during image processing operations; Different components can have different statuses within the same controller; Use this function to monitor individual component performance and convergence; Status information is useful for debugging brightness control issues

See also: peak_afl_AutoController_BrightnessComponent_Mode_Set(); peak_afl_AutoController_BrightnessComponent_Mode_Get(); peak_afl_controller_brightness_component; peak_afl_controller_status

Since: 1.2

◆ peak_afl_AutoController_BrightnessComponent_Unit_IsSupported()

PEAK_AFL_API_STATUS peak_afl_AutoController_BrightnessComponent_Unit_IsSupported	(	peak_afl_controller_handle	controller,
		peak_afl_controller_brightness_component	unit,
		peak_afl_BOOL8 *	supported )

Check if a specific brightness component unit is supported for a controller.

Determines whether the specified brightness controller supports a particular brightness component unit. Brightness controllers can use different mechanisms to adjust image brightness, such as exposure time, analog gain, digital gain, or combined gain settings. This function allows checking which specific brightness adjustment mechanisms are available for independent configuration and control.