Frame Source Deserializer
Defined in framework ScanditCaptureCore
Warning
The deserialization API is not yet stable and will still change over the coming releases.
- FrameSourceDeserializer
open class FrameSourceDeserializer : NSObject
Added in version 6.1.0
A deserializer to construct frame sources from JSON. For most use cases it is enough to use Camera.init() 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.
- init
convenience init(modeDeserializers: Array<any DataCaptureModeDeserializer>)
Added in version 6.1.0
Creates a new deserializer object.
- delegate
open weak var delegate: FrameSourceDeserializerDelegate? { get, set }
Added in version 6.1.0
The object informed about deserialization events.
- warnings
open var warnings: Array<String> { get }
Added in version 6.1.0
The warnings produced during deserialization, for example which properties were not used during deserialization.
- frameSource
open func frameSource(fromJSONString JSONString: String) throws -> any FrameSource
Added in version 6.1.0
Deserializes a frame source from JSON.
An error is set if the provided JSON does not contain required properties or contains properties of the wrong type.
- update
open func update(_ frameSource: any FrameSource, fromJSONString JSONString: String) throws -> any FrameSource
Added in version 6.1.0
Takes an existing frame source and updates it by deserializing new or changed properties from JSON.
An error is set if the provided JSON does not contain required properties or contains properties of the wrong type.
- cameraSettings
open func cameraSettings(fromJSONString JSONString: String) throws -> CameraSettings
Added in version 6.1.0
Deserializes camera settings from JSON.
An error is set if the provided JSON does not contain required properties or contains properties of the wrong type.
- update
open func update(_ settings: CameraSettings, fromJSONString JSONString: String) throws -> CameraSettings
Added in version 6.1.0
Takes existing camera settings and updates them by deserializing new or changed properties from JSON.
An error is set if the provided JSON does not contain required properties or contains properties of the wrong type.