Data Capture View Deserializer

Defined in framework ScanditDataCaptureCore

Warning

The deserialization API is not yet stable and will still change over the coming releases.

Note

This deserializer is not thread-safe, subsequent calls for the same view have to be called on the same thread.

SDCDataCaptureViewDeserializer

@interface SDCDataCaptureViewDeserializer : NSObject

Added in version 6.1.0

A deserializer to construct frame sources from JSON. For most use cases it is enough to use SDCCamera.cameraFromJSONString:error: which internally uses this deserializer. Using the deserializer gives the advantage of being able to listen to the deserialization events as they happen and potentially influence them. Additionally warnings can be read from the deserializer that would otherwise not be available.

Related topics: Serialization.

+ dataCaptureViewDeserializerWithModeDeserializers:

+ (instancetype)
  dataCaptureViewDeserializerWithModeDeserializers:(NSArray<id<SDCDataCaptureModeDeserializer>> *)
                                                   modeDeserializers

Added in version 6.1.0

Creates a new deserializer object.

delegate

@property (nonatomic, weak, nullable) id<SDCDataCaptureViewDeserializerDelegate> delegate

Added in version 6.1.0

The object informed about deserialization events.

warnings

@property (nonatomic, readonly) NSArray<NSString *> *warnings

Added in version 6.1.0

The warnings produced during deserialization, for example which properties were not used during deserialization.

- viewFromJSONString:withContext:error:

- (nullable SDCDataCaptureView *)viewFromJSONString:(NSString *)JSONString
                                        withContext:(SDCDataCaptureContext *)context
                                              error:(NSError **)error

Added in version 6.1.0

Deserializes a data capture view from JSON.

An error is set if the provided JSON does not contain required properties or contains properties of the wrong type.

- updateView:fromJSONString:error:

- (nullable SDCDataCaptureView *)updateView:(SDCDataCaptureView *)view
                             fromJSONString:(NSString *)JSONString
                                      error:(NSError **)error

Added in version 6.1.0

Takes an existing data capture view and updates it by deserializing new or changed properties from JSON. See Updating from JSON for details of how updates are being done.

An error is set if the provided JSON does not contain required properties or contains properties of the wrong type.