Data Capture View Deserializer#

Defined in package com.scandit.datacapture.core.ui.serialization

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.

DataCaptureViewDeserializer#
class DataCaptureViewDeserializer

Added in version 6.1.0

A deserializer to construct frame sources from JSON. For most use cases it is enough to use Camera.fromJson() 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. Additonally warnings can be read from the deserializer that would otherwise not be available.

Related topics: Serialization.

DataCaptureViewDeserializer()#
DataCaptureViewDeserializer(@NonNull Context context,
        @NonNull List<@NonNull DataCaptureModeDeserializer> modeDeserializers)

Added in version 6.1.0

Creates a new deserializer object.

listener#
@NonNull DataCaptureViewDeserializerListener getListener()
void setListener(@NonNull DataCaptureViewDeserializerListener value)

Added in version 6.1.0

The object informed about deserialization events.

warnings#
@NonNull List<@NonNull String> getWarnings()

Added in version 6.1.0

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

viewFromJson(dataCaptureContext, jsonData)#
@NonNull DataCaptureView viewFromJson(@NonNull DataCaptureContext dataCaptureContext,
        @NonNull String jsonData)

Added in version 6.1.0

Deserializes a data capture view from JSON.

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

updateViewFromJson(view, jsonData)#
@NonNull DataCaptureView updateViewFromJson(@NonNull DataCaptureView view,
        @NonNull String jsonData)

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 exception is thrown if the provided JSON does not contain required properties or contains properties of the wrong type.