Settings

API Name	Description
`InitSettings`	Loads and initializes a template from a string.
`InitSettingsFromFile`	Loads and initializes a template from a file.
`OutputSettings`	Exports a specific `CaptureVisionTemplate` to a string.
`OutputSettingsToFile`	Exports a specific `CaptureVisionTemplate` to a file.
`GetSimplifiedSettings`	Retrieves a `SimplifiedCaptureVisionSettings` object for a specific `CaptureVisionTemplate`.
`UpdateSettings`	Updates a `CaptureVisionTemplate` with `SimplifiedCaptureVisionSettings` object.
`ResetSettings`	Resets all templates to factory settings.
`GetParameterTemplateCount`	Retrieves the total number of available parameter templates.
`GetParameterTemplateName`	Retrieves the name of a specific parameter template by its index.

InitSettings

Loads and initializes a template from a string.

int InitSettings(const char* content, char errorMsgBuffer[]=NULL, const int errorMsgBufferLen=0)

Parameters

[in] content The string containing the template.

[in] errorMsgBuffer A buffer for error messages.

[in] errorMsgBufferLen The length of the error message buffer.

Return value

Returns an error code. Zero indicates success.

Error Code	Value	Description
EC_JSON_PARSE_FAILED	-10030	Failed to parse the JSON data.
EC_JSON_TYPE_INVALID	-10031	One or more parameters are allocated with wrong data type.
EC_JSON_KEY_INVALID	-10032	There exists invalid key in your JSON data.
EC_JSON_VALUE_INVALID	-10033	There exists invalid parameter value in your JSON data.
EC_JSON_NAME_KEY_MISSING	-10034	One or more `name` parameters are missing in your JSON data. Each section of the JSON data requires a unique `name` parameter.
EC_JSON_NAME_VALUE_DUPLICATED	-10035	There exists duplicated `name` parameters in your JSON data. The `name` parameter should be unique.
EC_JSON_NAME_REFERENCE_INVALID	-10037	You have referenced an invalid `name` value in your JSON data.
EC_PARAMETER_VALUE_INVALID	-10038	There exists invalid parameter value in your JSON data.
EC_CALL_REJECTED_WHEN_CAPTURING	-10062	Function call is rejected when capturing in progress.

InitSettingsFromFile

Loads and initializes a template from a file.

int InitSettingsFromFile(const char* filePath, char errorMsgBuffer[]=NULL, const int errorMsgBufferLen=0)

Parameters

[in] filePath The path to the file containing the template.

[in] errorMsgBuffer A buffer for error messages.

[in] errorMsgBufferLen The length of the error message buffer.

Return value

Returns an error code. Zero indicates success.

Error Code	Value	Description
EC_FILE_NOT_FOUND	-10005	The file is not found.
EC_JSON_PARSE_FAILED	-10030	Failed to parse the JSON data.
EC_JSON_TYPE_INVALID	-10031	One or more parameters are allocated with wrong data type.
EC_JSON_KEY_INVALID	-10032	There exists invalid key in your JSON data.
EC_JSON_VALUE_INVALID	-10033	There exists invalid parameter value in your JSON data.
EC_JSON_NAME_KEY_MISSING	-10034	One or more `name` parameters are missing in your JSON data. Each section of the JSON data requires a unique `name` parameter.
EC_JSON_NAME_VALUE_DUPLICATED	-10035	There exists duplicated `name` parameters in your JSON data. The `name` parameter should be unique.
EC_JSON_NAME_REFERENCE_INVALID	-10037	You have referenced an invalid `name` value in your JSON data.
EC_PARAMETER_VALUE_INVALID	-10038	There exists invalid parameter value in your JSON data.
EC_CALL_REJECTED_WHEN_CAPTURING	-10062	Function call is rejected when capturing in progress.

OutputSettings

Exports a specific template to a string.

char* OutputSettings(const char* templateName, bool includeDefaultValues = false, int* pErrorCode = NULL)

Parameters

[in] templateName The name of the template to export.

[in] includeDefaultValues Specifies whether to include default values in the exported template.

[out] pErrorCode An error code.

Return value

Returns a string containing the exported template. The string is allocated by the SDK and must be freed by calling CoreModule::FreeBytes.

Error Code	Value	Description
EC_TEMPLATE_NAME_INVALID	-10036	The target template name is invalid.

Remarks

It is supported to export all loaded templates by specifying the templateName as ‘*’.

OutputSettingsToFile

Exports a specific template to a file.

int OutputSettingsToFile(const char* templateName, const char* filePath, bool includeDefaultValues = false)

Parameters

[in] templateName The name of the template to export.

[in] filePath The path to the output file.

[in] includeDefaultValues Specifies whether to include default values in the exported template.

Return value

Returns an error code. Zero indicates success.

Error Code	Value	Description
EC_FILE_SAVE_FAILED	-10058	The file path is unavailable or the file can’t be created for any other reasons.

Remarks

It is supported to export all loaded templates by specifying the templateName as ‘*’.

GetSimplifiedSettings

Retrieves a simplified version of the capture settings for a specific template.

int GetSimplifiedSettings(const char* templateName, SimplifiedCaptureVisionSettings* settings)

Parameters

[in] templateName The name of the template.

[out] settings A pointer to a SimplifiedCaptureVisionSettings object.

Return value

Returns an error code. Zero indicates success.

Error Code	Value	Description
EC_TEMPLATE_NAME_INVALID	-10036	The target template name is invalid.
EC_CONVERT_COMPLEX_TEMPLATE_ERROR	-10061	The template you specified is a complex template which can not be output as a `SimplifiedCaptureVisionSettings` object.
EC_CALL_REJECTED_WHEN_CAPTURING	-10062	Function call is rejected when capturing in progress.

See Also

SimplifiedCaptureVisionSettings

UpdateSettings

Updates a template with simplified capture settings.

int UpdateSettings(const char* templateName, const SimplifiedCaptureVisionSettings* settings, char errorMsgBuffer[]=NULL, const int errorMsgBufferLen=0)

Parameters

[in] templateName The name of the template to update.

[in] settings A pointer to a SimplifiedCaptureVisionSettings object.

[in] errorMsgBuffer A buffer for error messages.

[in] errorMsgBufferLen The length of the error message buffer.

Return value

Returns an error code. Zero indicates success.

Error Code	Value	Description
EC_TEMPLATE_NAME_INVALID	-10036	The target template name is invalid.
EC_PARAMETER_VALUE_INVALID	-10038	There exists invalid parameter value in your `SimplifiedCaptureVisionSettings`.

See Also

SimplifiedCaptureVisionSettings

ResetSettings

Resets all templates to factory settings.

int ResetSettings()

Return value

Returns an error code. Zero indicates success.

Error Code	Value	Description
EC_CALL_REJECTED_WHEN_CAPTURING	-10062	Function call is rejected when capturing in progress.

GetParameterTemplateCount

Retrieves the total number of available parameter templates.

int GetParameterTemplateCount()

Return value

Returns an integer representing the count of parameter templates.

GetParameterTemplateName

Retrieves the name of a specific parameter template by its index.

int GetParameterTemplateName(const int index, char nameBuffer[], int nameBufferLen)

Parameters

[in] index The index of the parameter template in the array.

[in, out] nameBuffer A pointer to a pre-allocated buffer provided by the caller. The name of the parameter template will be copied into this buffer.

[in] nameBufferLen The length of the allocated buffer.

Return value

Returns an error code. Zero indicates success.