Configure Settings

initSettings

Configures runtime settings using a provided JSON string, which contains settings for one or more CaptureVisionTemplates.

• Objective-C
• Swift

1. - (BOOL)initSettings:(NSString *)content
              error:(NSError * _Nullable * _Nullable)error
   

2. func initSettings(_ content:String) throws -> BOOL
   

Parameters

content: A JSON string that contains Capture Vision settings.
error: An NSError pointer. If an error occurs, it will represent the error information.

Error

Return Value

A BOOL value that indicates whether the settings are initialized successfully.

initSettingsFromFile

Configures runtime settings using a provided JSON file, which contains settings for one or more CaptureVisionTemplates.

• Objective-C
• Swift

1. - (BOOL)initSettingsFromFile:(NSString *)file
                       error:(NSError * _Nullable * _Nullable)error
   

2. func initSettingsFromFile(_ file:String) throws -> BOOL
   

Parameters

file: A JSON file that contains Capture Vision settings.
error: An NSError pointer. If an error occurs, it will represent the error information.

Error

Return Value

A BOOL value that indicates whether the settings are initialized successfully.

Code Snippet

The following steps shows how to read a template file under the DynamsoftResources.bundle:

1. Create a DynamsoftResources folder in the finder. Under the DynamsoftResources folder create a new folder, Templates.

2. Put your .json template file under the Templates folder. Here we suppose you are adding a template file named ReadPDF417.json.

3. Rename the DynamsoftResources folder’s extension name to .bundle and drag the DynamsoftResources.bundle into your project on Xcode. Select Create groups for the Added folders option.

   

   DynamsoftResources.bundle Example

4. Add the following code to your project to initialize the template:

   • Objective-C
   • Swift

   1. [self.cvr initSettingsFromFile:@"ReadPDF417.json" error:nil];
      

   2. try! cvr.initSettingsFromFile("ReadPDF417.json")
      

5. To use your template, you have to specify the template name in the startCapturing or capture method.

   • Objective-C
   • Swift

   1. [self.cvr startCapturing:@"ReadPDF417" completionHandler:^(BOOL isSuccess, NSError * _Nullable error) {
         if (!isSuccess && error != nil) {
            // Add code to handle error
         }
      }];
      

   2. cvr.startCapturing("ReadPDF417") { isSuccess, error in
         if (!isSuccess) {
            // Add code to handle error
         }
      }
      

getSimplifiedSettings

Retrieves a SimplifiedCaptureVisionSettings object that contains simplified settings for the specified CaptureVisionTemplate.

• Objective-C
• Swift

1. - (nullable DSSimplifiedCaptureVisionSettings *)getSimplifiedSettings:(NSString *)templateName
                                                               error:(NSError * _Nullable * _Nullable)error;
   

2. func getSimplifiedSettings(_ templateName:String) throws -> SimplifiedCaptureVisionSettings
   

Parameters

templateName: Name of the targeted Capture Vision template that is defined in a JSON string or a JSON file.
error: An NSError pointer. If an error occurs, it will represent the error information.

Error

Return Value

A DSSimplifiedCaptureVisionSettings object.

Remarks

A single JSON string or file can define multiple Capture Vision templates. getSimplifiedSettings will only return the simplified settings of the template named in the input parameter, even though there could be several templates in the JSON string/file.

getTemplateNames

Retrieves the names of all the currently available templates.

• Objective-C
• Swift

1. - (NSArray<NSString*>*) getTemplateNames;
   

2. func getSimplifiedSettings() -> SimplifiedCaptureVisionSettings
   

Return Value

An array that contains all the currently available templates names.

updateSettings

Updates the specified CaptureVisionTemplate with a SimplifiedCaptureVisionSettings object.

• Objective-C
• Swift

1. - (BOOL)updateSettings:(NSString *)templateName
             settings:(nonnull DSSimplifiedCaptureVisionSettings *)settings
                error:(NSError * _Nullable * _Nullable)error;
   

2. func updateSettings(_ templateName:String, settings:SimplifiedCaptureVisionSettings) throws -> BOOL
   

Parameters

templateName: Specifies a CaptureVisionTemplate by its name.
settings: The SimplifiedCaptureVisionSettings object that contains updated settings.
error: An NSError pointer. If an error occurs, it will represent the error information.

Error

Return Value

A bool value that indicates whether the settings are uploaded successfully.

resetSettings

Restores all runtime settings to their original default values.

• Objective-C
• Swift

1. - (BOOL)resetSettings:(NSError * _Nullable * _Nullable)error;
   

2. func resetSettings() throws -> BOOL
   

Parameters

error: An NSError pointer. If an error occurs, it will represent the error information.

Error

Return Value

A BOOL value that indicates whether the settings are reset successfully.

outputSettings

Returns an object that contains settings for the specified CaptureVisionTemplate.

• Objective-C
• Swift

1. - (nullable NSString *)outputSettings:(NSString *)templateName
                               error:(NSError * _Nullable * _Nullable)error
   

2. func outputSettings(_ templateName:String) throws -> String
   

Parameters

error: An NSError pointer. If an error occurs, it will represent the error information.

Error

Return Value

The Capture Vision settings in a JSON string.

outputSettingsToFile

Output a JSON file containing the settings for the specified CaptureVisionTemplate.

• Objective-C
• Swift

1. - (BOOL)outputSettingsToFile:(NSString *)templateName
                       file:(NSString *)file
                      error:(NSError * _Nullable * _Nullable)error;
   

2. func outputSettingsToFile(_ templateName:String, file:String) throws -> BOOL
   

Parameters

templateName: The name of the template that you want to output.
file: The file path and name where the template will be output and saved.
error: An NSError pointer. If an error occurs, it will represent the error information.

Error

Return Value

A BOOL value that indicates whether the template is output successfully.