Zivid C++ API 2.14.0+e4a0c4a9-1
Zivid::CaptureAssistant Namespace Reference

Classes

class  SuggestSettingsParameters
 Used to specify a constraint on the total capture time for the settings suggested by the Capture Assistant, and optionally specify the ambient light frequency. More...
 

Functions

ZIVID_CORE_EXPORT Settings suggestSettings (Camera &camera, const SuggestSettingsParameters &suggestSettingsParameters)
 Finds suggested settings for the current scene based on the SuggestSettingsParameters.
 

Function Documentation

◆ suggestSettings()

ZIVID_CORE_EXPORT Settings Zivid::CaptureAssistant::suggestSettings ( Camera & camera,
const SuggestSettingsParameters & suggestSettingsParameters )

Finds suggested settings for the current scene based on the SuggestSettingsParameters.

The suggested settings returned from this function should be passed into Camera::capture to perform the actual capture. This tool suggests the optimal settings given the capabilities of the current SDK version. There is no guarantee that running this tool on the same scene with a different SDK version will suggest the same settings.

Parameters
cameraReference to camera instance.
suggestSettingsParametersProvides parameters (e.g., max capture time constraint) to the suggestSettings algorithm.
Returns
Settings. Capture with Camera::capture.