Dev Center
Table of contents

Thanks for downloading Dynamsoft Barcode Reader Package!

Your download will start shortly. If your download does not begin, click here to retry.

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.

- (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
  1. NSError __autoreleasing * _Nullable error;
    [barcodeReader getRuntimeSettings:&error];
    
  2. let settings = try? barcodeReader.getRuntimeSettings()
    

updateRuntimeSettings:(iPublicRuntimeSettings *)

Update runtime settings with a given iPublicRuntimeSettings struct.

- (BOOL)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
  1. iPublicRuntimeSettings *settings = [barcodeReader getRuntimeSettings:nil];
    // After you have made some changes on the runtime settings.
    [barcodeReader updateRuntimeSettings:settings error:nil];
    
  2. let settings = try? barcodeReader.getRuntimeSettings()
    // After you have made some changes on the runtime settings.
    try? barcodeReader.updateRuntimeSettings(settings!)
    

updateRuntimeSettings:(EnumPresetTemplate)

- (void)updateRuntimeSettings:(EnumPresetTemplate)presetTemplate;

Parameters

presetTemplate: One of the preset templates defined by EnumPresetTemplate

Code Snippet

  • Objective-C
  • Swift
  1. [barcodeReader updateRuntimeSettings:EnumPresetTemplateVideoSingleBarcode];
    
  2. barcodeReader.updateRuntimeSettings(EnumPresetTemplate.videoSingleBarcode)
    

resetRuntimeSettings

Reset all parameters to default values.

- (BOOL)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
  1. [barcodeReader resetRuntimeSettings:nil];
    
  2. try? barcodeReader.resetRuntimeSettings()
    

This page is compatible for:

Version 7.5.0

Is this page helpful?

YesYes NoNo

In this article:

latest version

  • Latest version
  • Version 9.0.0
  • Version 8.9.3
  • Version 8.9.0
  • Version 8.8.0
  • Version 8.6.0
  • Version 8.4.0
  • Version 8.2.1
  • Version 8.2.0
  • Version 8.1.2
  • Version 8.1.0
  • Version 8.0.0
  • Version 7.6.0
  • Version 7.5.0
Change +
© 2003–2022 Dynamsoft. All rights reserved.
Privacy Statement / Site Map / Home / Purchase / Support