DSObservationParameters

The DSObservationParameters class is used to set filter conditions for the DSIntermediateResultReceiver, so that only intermediate results meeting specific conditions will be called back.

Definition

Assembly: DynamsoftCore.framework

• Objective-C
• Swift

1. @interface DSObservationParameters : NSObject
   

2. class ObservationParameters : NSObject
   

Methods

Attributes

addObservedTask

Adds observed task name to be notified when relevant results are available.

• Objective-C
• Swift

1. -(void)addObservedTask:(NSString *)taskName;
   

2. func addObservedTask(_ taskName: String)
   

Parameters

taskName: Specify a task name to add to the observation list.

Code Snippet

• Objective-C
• Swift

1. [observationParameters addObservedTask:@"TextRecognition"];
   

2. observationParameters.addObservedTask("TextRecognition")
   

removeObservedTask

Remove the observed task name so that intermediate results generated by the task are not notified.

• Objective-C
• Swift

1. -(void)removeObservedTask:(NSString*)taskName;
   

2. func removeObservedTask(_ taskName: String)
   

Parameters

taskName: Specify a task name to remove from the observation list.

Code Snippet

• Objective-C
• Swift

1. [observationParameters removeObservedTask:@"TextRecognition"];
   

2. observationParameters.removeObservedTask("TextRecognition")
   

isTaskObserved

Check whether the specified task was observed.

• Objective-C
• Swift

1. -(BOOL)isTaskObserved:(NSString*)taskName;
   

2. func isTaskObserved(_ taskName: String) -> Bool
   

Parameters

taskName: Specify a task name to check the observation state.

Return Value

A BOOL value that indicates whether the specified task is observed.

Code Snippet

• Objective-C
• Swift

1. BOOL observed = [observationParameters isTaskObserved:@"TextRecognition"];
   

2. let observed = observationParameters.isTaskObserved("TextRecognition")
   

resultUnitTypesOnlyForInput

Defines the type of intermediate result unit that indicates skipping default calculations and replacing with input data units.

@property (nonatomic, nullable, copy) DSIntermediateResultUnitType resultUnitTypesOnlyForInput;