Component

Topics
	Mode
	Callback

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 }
	controller brightness component 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 unit is supported for a brightness 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 status for a controller component.

Detailed Description

Enumeration Type Documentation

peak_afl_controller_brightness_component

enum peak_afl_controller_brightness_component

controller brightness component

Enumerator
PEAK_AFL_CONTROLLER_BRIGHTNESS_COMPONENT_INVALID	invalid component
PEAK_AFL_CONTROLLER_BRIGHTNESS_COMPONENT_EXPOSURE	exposure
PEAK_AFL_CONTROLLER_BRIGHTNESS_COMPONENT_GAIN	gain
PEAK_AFL_CONTROLLER_BRIGHTNESS_COMPONENT_ANALOG_GAIN	analog gain
PEAK_AFL_CONTROLLER_BRIGHTNESS_COMPONENT_DIGITAL_GAIN	digital gain
PEAK_AFL_CONTROLLER_BRIGHTNESS_COMPONENT_COMBINED_GAIN	combined gain
PEAK_AFL_CONTROLLER_BRIGHTNESS_COMPONENT_HOST_GAIN	host gain

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 status for a controller component.

See peak_afl_controller_status for a list of values.

Parameters

[in]	controller	controller handle
[out]	component	brightness component
[out]	status	controller status

Returns

PEAK_AFL_STATUS_SUCCESS Operation was successful; no error occurred.

PEAK_AFL_STATUS_NOT_INITIALIZED The library is not initialized.

PEAK_AFL_STATUS_INVALID_PARAMETER The argument is invalid.

PEAK_AFL_STATUS_ERROR An unexpected internal error occurred.

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 unit is supported for a brightness controller.

If supported is PEAK_AFL_TRUE if unit is supported, otherwise it is unsupported.

Parameters

[in]	controller	controller handle
[in]	unit	brightness controller unit
[out]	supported	boolean if controller component supports auto mode

Returns

PEAK_AFL_STATUS_SUCCESS Operation was successful; no error occurred.

PEAK_AFL_STATUS_NOT_INITIALIZED The library is not initialized.

PEAK_AFL_STATUS_INVALID_PARAMETER The argument is invalid.

PEAK_AFL_STATUS_ERROR An unexpected internal error occurred.

Since

1.6