Parameter and Runtime Settings Basic Methods

Method	Description
`getRuntimeSettings`	Get current runtime settings.
`updateRuntimeSettings:(iPublicRuntimeSettings)`	Update runtime settings with a given struct.
`updateRuntimeSettings:(EnumPresetTemplate)`	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.

Objective-C
Swift

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

func getRuntimeSettings() throws -> iPublicRuntimeSettings

Parameters

[in,out] error: A pointer to an error object.

An error occurs when:

The library failed to get the runtime settings.

Return Value

A DBRPublicRuntimeSettings storing current runtime settings.

Code Snippet

Objective-C
Swift

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

do{
   let settings = try barcodeReader.getRuntimeSettings()
}catch{
   // Add your code to deal with exceptions
}

updateRuntimeSettings:(iPublicRuntimeSettings*)

Update runtime settings with a given iPublicRuntimeSettings struct.

Objective-C
Swift

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

func updateRuntimeSettings(_ settings: iPublicRuntimeSettings) throws

Parameters

[in] settings The struct of template settings.
[in,out] error: A pointer to an error object.

An error occurs when:

There exists parameters that are invalid or out of range in the iPublicRuntimeSettings object.

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];

do{
   let settings = try barcodeReader.getRuntimeSettings()
   // After you have made some changes on the runtime settings.
   try barcodeReader.updateRuntimeSettings(settings!)
}catch{
   // Add your code to deal with exceptions
}

updateRuntimeSettings:(EnumPresetTemplate)

Objective-C
Swift

- (void)updateRuntimeSettings:(EnumPresetTemplate)presetTemplate;

func updateRuntimeSettings(_ tpl: EnumPresetTemplate)

Parameters

presetTemplate: One of the preset templates defined by EnumPresetTemplate

Code Snippet

Objective-C
Swift

[barcodeReader updateRuntimeSettings:EnumPresetTemplateVideoSingleBarcode];

barcodeReader.updateRuntimeSettings(EnumPresetTemplate.videoSingleBarcode)

resetRuntimeSettings

Reset all parameters to default values.

Objective-C
Swift

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

```
func resetRuntimeSettings() throws
```

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];

do{
   try barcodeReader.resetRuntimeSettings()
}catch{
   // Add your code to deal with exceptions
}