Status types and values

Definitions on status types and values. More...

Enumerations
enum	peak_afl_status {   PEAK_AFL_STATUS_SUCCESS , PEAK_AFL_STATUS_ERROR , PEAK_AFL_STATUS_NOT_INITIALIZED , PEAK_AFL_STATUS_INVALID_PARAMETER ,   PEAK_AFL_STATUS_ACCESS_DENIED , PEAK_AFL_STATUS_BUSY , PEAK_AFL_STATUS_BUFFER_TOO_SMALL , PEAK_AFL_STATUS_INVALID_IMAGE_FORMAT ,   PEAK_AFL_STATUS_NOT_SUPPORTED , PEAK_AFL_STATUS_VALUE_ADJUSTED }
	Auto feature library status codes. More...
enum	peak_afl_controller_status {   PEAK_AFL_CONTROLLER_STATUS_UNDEFINED , PEAK_AFL_CONTROLLER_STATUS_OFF , PEAK_AFL_CONTROLLER_STATUS_IN_PROGRESS , PEAK_AFL_CONTROLLER_STATUS_FINISHED ,   PEAK_AFL_CONTROLLER_STATUS_BUSY , PEAK_AFL_CONTROLLER_STATUS_CANCELED , PEAK_AFL_CONTROLLER_STATUS_ERROR , PEAK_AFL_CONTROLLER_STATUS_SKIPPED }
	Controller operational status. More...

Detailed Description

Definitions on status types and values.

Enumeration Type Documentation

peak_afl_controller_status

enum peak_afl_controller_status

Controller operational status.

Defines the current operational state of an auto feature controller. The status indicates what the controller is currently doing and whether it is available for new operations.

See also

peak_afl_AutoController_Status()

peak_afl_AutoFeatureManager_Status()

Enumerator
PEAK_AFL_CONTROLLER_STATUS_UNDEFINED	Controller status undefined.
PEAK_AFL_CONTROLLER_STATUS_OFF	Controller is disabled or inactive. The controller is in OFF mode and not processing images. No automatic adjustments will be made until the controller is set to CONTINUOUS or ONCE mode. Note This is the initial state after controller creation See also PEAK_AFL_CONTROLLER_AUTOMODE_OFF
PEAK_AFL_CONTROLLER_STATUS_IN_PROGRESS	Controller is actively processing. The controller is currently in the middle of processing an image or executing an algorithm. This indicates ongoing work that has not yet completed. Note Different from BUSY - indicates active algorithm execution Processing time varies by algorithm complexity
PEAK_AFL_CONTROLLER_STATUS_FINISHED	Controller completed its operation successfully. The controller has finished processing and reached its target or completed the requested operation. In ONCE mode, the controller automatically transitions to OFF after reaching this state. Note In CONTINUOUS mode, this state is brief before next processing In ONCE mode, controller switches to OFF after finishing
PEAK_AFL_CONTROLLER_STATUS_BUSY	Controller is busy and cannot accept new requests. The controller is currently occupied and cannot process new images or requests. This typically occurs when the controller is already processing an image or waiting for camera parameter adjustments. Note Check this status before submitting new images Different from IN_PROGRESS - indicates resource unavailability
PEAK_AFL_CONTROLLER_STATUS_CANCELED	Controller operation was canceled. The current operation was canceled before completion, either by user request or due to changing conditions. The controller is available for new operations. Note Controller can accept new operations after cancellation May occur when switching modes or stopping operations
PEAK_AFL_CONTROLLER_STATUS_ERROR	Controller encountered an error. An error occurred during processing or parameter adjustment. The controller may need to be reset or reconfigured. Use peak_afl_GetLastError() for detailed error information. Note Controller may remain in this state until error is resolved Check error details with peak_afl_GetLastError() See also peak_afl_GetLastError()
PEAK_AFL_CONTROLLER_STATUS_SKIPPED	Controller skipped processing this frame. The controller deliberately skipped processing the current frame, typically due to skip frames configuration or because the frame did not meet processing criteria. Note This is normal behavior when skip frames is configured Not an error condition - controller remains operational See also peak_afl_AutoController_SkipFrames_Set()

peak_afl_status

enum peak_afl_status

Auto feature library status codes.

All auto feature library functions return one of these status codes to indicate success or the specific type of error that occurred. Applications should always check return values and handle errors appropriately.

Note

Use peak_afl_GetLastError() to get detailed error descriptions

See also

peak_afl_GetLastError()

Enumerator
PEAK_AFL_STATUS_SUCCESS	Operation completed successfully. The function executed without any errors and completed the requested operation.
PEAK_AFL_STATUS_ERROR	General error occurred. An unspecified error occurred during function execution. Use peak_afl_GetLastError() to get detailed information about the specific error. See also peak_afl_GetLastError()
PEAK_AFL_STATUS_NOT_INITIALIZED	Library not initialized. The auto feature library has not been initialized. Call peak_afl_Init() before using any other library functions. See also peak_afl_Init()
PEAK_AFL_STATUS_INVALID_PARAMETER	Invalid parameter provided. One or more function parameters are invalid (e.g., NULL pointers where valid pointers are required, out-of-range values, invalid handles). Note Check parameter documentation for valid ranges and requirements
PEAK_AFL_STATUS_ACCESS_DENIED	Access denied to resource. The requested operation could not be performed due to insufficient permissions or the resource being locked by another process.
PEAK_AFL_STATUS_BUSY	Resource is busy. The requested resource (manager, controller, or device) is currently busy processing another operation. Try again later or check the status. See also peak_afl_AutoFeatureManager_Status()
PEAK_AFL_STATUS_BUFFER_TOO_SMALL	Provided buffer is too small. The buffer provided for output data is smaller than required. Use the two-stage query pattern to determine the required buffer size. See also Two Staged Data Query
PEAK_AFL_STATUS_INVALID_IMAGE_FORMAT	Invalid or unsupported image format. The provided image format is not supported by the auto feature algorithms or the format parameters are invalid. Note Check supported pixel formats in the documentation
PEAK_AFL_STATUS_NOT_SUPPORTED	Feature or operation not supported. The requested feature or operation is not supported by the current device or configuration. Check feature availability before use.
PEAK_AFL_STATUS_VALUE_ADJUSTED	Parameter value was adjusted. The operation succeeded, but one or more parameter values were automatically adjusted to fit within valid ranges. Check current values after the operation. Note This is not an error condition