Skip to content

Latest commit

 

History

History
107 lines (88 loc) · 2.83 KB

captured-result-item.md

File metadata and controls

107 lines (88 loc) · 2.83 KB
Raw
layout title description keywords needGenerateH3Content needAutoGenerateSidebar noTitleIndex
default-layout
DSCapturedResultItem - Dynamsoft Core Module iOS Edition API Reference
The class DSCapturedResultItem of Dynamsoft Core Module represents an item in a captured result, such as barcode, text line, detected quad, normalized image, original image, parsed item, etc.
captured result item, objective-c, swift
true
true
true

DSCapturedResultItem

The CapturedResultItem class provides a common structure for representing different types of captured results. Each specific captured result item type will have its own implementation and additional properties specific to that type.

Definition

Assembly: DynamsoftCore.framework

>- Objective-C >- Swift > >1. ```objc @interface DSCapturedResultItem : NSObject ``` 2. ```swift class CapturedResultItem : NSObject ```

Attributes

Attributes Type Description
type DSCapturedResultItemType The type of the captured result item, indicating what kind of data it represents.
referencedItem DSCapturedResultItem * A property of type DSCapturedResultItem that represents a reference to another captured result item.
targetROIDefName NSString The name of the [TargetROIDef]({{ site.dcv_parameters_reference }}target-roi-def/) object which includes a task that generated the result.
taskName NSString The name of the task that generated the result.

type

The type of the captured result item, indicating what kind of data it represents.

>- Objective-C >- Swift > >1. ```objc @property (nonatomic, readonly) DSCapturedResultItemType type ``` 2. ```swift var type: DSCapturedResultItemType { get } ```

referencedItem

A property of type DSCapturedResultItem that represents a reference to another captured result item.

>- Objective-C >- Swift > >1. ```objc @property (nonatomic, nullable, readonly) DSCapturedResultItem *referencedItem ``` 2. ```swift var referencedItem: DSCapturedResultItem? { get } ```

targetROIDefName

The name of the [TargetROIDef]({{ site.dcv_parameters_reference }}target-roi-def/) object which includes a task that generated the result.

>- Objective-C >- Swift > >1. ```objc @property (nonatomic, nullable, readonly) NSString *targetROIDefName ``` 2. ```swift var targetROIDefName: String? { get } ```

taskName

The name of the task that generated the result.

>- Objective-C >- Swift > >1. ```objc @property (nonatomic, nullable, readonly) NSString *taskName ``` 2. ```swift var taskName: String? { get } ```