Parameter and Runtime Settings Basic Methods

Method	Description
`getRuntimeSettings`	Get current runtime settings.
`updateRuntimeSettings (with Struct)`	Update runtime settings with a given struct.
`updateRuntimeSettings (with preset template)`)	Update runtime settings from one of the preset templates.
`resetRuntimeSettings`	Resets all parameters to default values.

getRuntimeSettings

Get current settings and save them into a iPublicRuntimeSettings struct.

- (iPublicRuntimeSettings* _Nullable)getRuntimeSettings:(NSError* _Nullable * _Nullable)error;

Parameters

[in, out] error Input a pointer to an error object. If an error occurs, this pointer is set to an actual error object containing the error information. You may specify nil for this parameter if you do not want the error information.

Return Value

A DBRPublicRuntimeSettings storing current runtime settings.

Code Snippet

Objective-C
Swift

NSError __autoreleasing * _Nullable error;
[barcodeReader getRuntimeSettings:&error];

let settings = try? barcodeReader.getRuntimeSettings()

updateRuntimeSettings

With a PublicRuntimeSettings Struct

Update runtime settings with a given iPublicRuntimeSettings struct.

- (void)updateRuntimeSettings:(iPublicRuntimeSettings* _Nonnull)settings
                        error:(NSError* _Nullable * _Nullable)error
                        NS_SWIFT_NAME(updateRuntimeSettings(_:));

Parameters

[in] settings The struct of template settings.
[in,out] error Input a pointer to an error object. If an error occurs, this pointer is set to an actual error object containing the error information. You may specify nil for this parameter if you do not want the error information.

Code Snippet

Objective-C
Swift

iPublicRuntimeSettings *settings = [barcodeReader getRuntimeSettings:nil];
// After you have made some changes on the runtime settings.
[barcodeReader updateRuntimeSettings:settings error:nil];

let settings = try? barcodeReader.getRuntimeSettings()
// After you have made some changes on the runtime settings.
try? barcodeReader.updateRuntimeSettings(settings!)

With a Preset Template

- (void)updateRuntimeSettings:(EnumPresetTemplate)presetTemplate;

Parameters

presetTemplate: One of the preset templates.

Code Snippet

Objective-C
Swift

[barcodeReader updateRuntimeSettings:EnumPresetTemplate.EnumPresetTemplateVideoSingleBarcode];

barcodeReader.updateRuntimeSettings(EnumPresetTemplate.EnumPresetTemplateVideoSingleBarcode)

resetRuntimeSettings

Reset all parameters to default values.

- (void)resetRuntimeSettings:(NSError* _Nullable * _Nullable)error;

Parameters

[in,out] error Input a pointer to an error object. If an error occurs, this pointer is set to an actual error object containing the error information. You may specify nil for this parameter if you do not want the error information.

Code Snippet

Objective-C
Swift

[barcodeReader resetRuntimeSettings:nil];

try? barcodeReader.resetRuntimeSettings()