Spren Vision Android SDK

The Android SDK is in Alpha. We're working quickly to expand our support in the heterogeneity of Android devices.

*Devices with an asterisk are ones that use the wide angle camera for readings. All other devices use the default camera.

Currently, we allow users to only perform readings with flash on.

The open source code is available in the Spren Vision Android SDK GitHub Repository.

Here is an example of how to implement the Spren Vision Android SDK in your own app. Refer to the comments throughout the file to see what functions get called at what point.

var autoStart = true (Replace with SprenCapture reset method)

Enable or disable reading autostart. Autostart occurs after 3 seconds of conditions checks compliance.

fun setTorchMode(torch: Boolean): Boolean (Replace with fun turnFlashOn())

Attempts to toggle the torch (flashlight) on as appropriate. Returns the resulting torch mode. Setting the flash off has been disabled.

fun dropComplexity(): Boolean (no need to handle anymore)

This function has been deprecated and will be removed in the next releases.

fun handleOverExposure() (no need to handle anymore)

Attempts to reduce the exposure of the image by lowering the sensor exposure time. This may be called if exposure is non-compliant, i.e, at least 5 frames are over-exposed.

SprenCapture is where you can initialize a camera preview and first configure the camera. This will start a camera preview and image analysis, allow you to add the camera preview to your UI, and handle various other camera controls. Check out the function definitions below!

fun start(): Boolean

Attempts to create a Preview and ImageAnalysis use cases. Returns false when the camera does not support at least 30 FPS. For more information, see the Android docs for CameraX overview.

fun stop()

Stops the Preview and ImageAnalysis use cases

fun reset()

Starts or restarts a reading. Reading will start after 3 seconds of conditions checks compliance. This function needs to be called after fun start(): Boolean method and after subscribing to Spren Events

fun turnFlashOn()

Attempts to toggle the torch (flashlight) on.

RGBAnalyzer is an ImageAnalysis.Analyzer and handles providing frames to SprenCore.

The SprenCore library provides internal control over readings and allows you to gain information on what's going on internally in the SDK so your UI can be updated accordingly. Here you'll be able to set reading durations, handle progress updates, start and stop readings, and more. Use this library in conjunction with SprenCapture to utilize the full capabilities of Spren SDK.

SprenEventManager.subscribe(SprenEvent.STATE, ::stateListener)

Subscribes to events when state changes occur, i.e., started, finished, cancelled, and error.

SprenEventManager.subscribe(SprenEvent.COMPLIANCE, ::complianceListener)

Subscribes to events when a compliance check is performed. Compliance checks for lens coverage, and exposure are performed once per second.

SprenEventManager.subscribe(SprenEvent.PROGRESS, ::progressListener)

Subscribes to events when progress updates. Progress ranges from 0 to 99 in integer increments. State change to finished occurs in lieu of progress update at 100.

Unsubscribing events before leaving the flow

fun Spren.Companion.startReading()

Manually start the reading.

fun Spren.Companion.cancelReading()

Manually stop the reading.

fun getReadingData(context: Context): String?

After Spren transitions to finished, reading data may be retrieved to hit the Spren API for results. See the User and SDK data POST endpoint for more information.

var readingDurationSeconds = 90

Reading duration ≥ 90 seconds or ≤ 240 seconds.

fun Spren.Companion.setReadingDuration(duration: Int)

Set the reading duration. A duration in the range ≥ 90 seconds or ≤ 240 seconds must be provided or the call returns.

If you'd like to use your own library or code to handle camera configurations and initialization, make sure to reference this section and the RGBAnalyzer section to get more context and see what functions need to be implemented.

Reference RGBAnalyzer

fun process(frame: Bitmap, timestamp: Long)

Provide a frame for processing.

Bitmap

Created from ImageProxy e.g.:

val bitmap = imageProxy.image!!.toBitmap()

The ImageProxy format will be PixelFormat.RGBA_8888, which has only one image plane (R, G, B, A pixel by pixel). For more information, Image Analysis.

Compliance checks are run at 1 second intervals as frames are provided, i.e., if internally to SprenCore the time when the frame is received is >1 second later than the last check. For ComplianceCheck.Name: