shared/io.anyline.tiretread.sdk.scanner

Package-level declarations

Types

AnylineInternalFeature

@Target(allowedTargets = [AnnotationTarget.FUNCTION])

annotation class AnylineInternalFeature

DistanceStatus

enum DistanceStatus : Enum<DistanceStatus>

Image

expect class Image

MeasurementSystem

@Serializable

enum MeasurementSystem : Enum<MeasurementSystem>

OnDistanceChanged

data class OnDistanceChanged(val measurementUUID: String?, val previousStatus: DistanceStatus, val newStatus: DistanceStatus, val previousDistance: Float, val newDistance: Float) : ScanEvent

Event returned when the distance of the tire to the camera changed.

OnFocusFound

data class OnFocusFound(val measurementUUID: String?) : ScanEvent

Event returned when the focus was found.

OnImageUploaded

data class OnImageUploaded(val measurementUUID: String, val uploaded: Int, val total: Int) : ScanEvent

Event returned when one of the images was uploaded.

OnScanStarted

data class OnScanStarted(val measurementUUID: String) : ScanEvent

Event returned when the scan was started.

OnScanStopped

data class OnScanStopped(val measurementUUID: String) : ScanEvent

Event returned when the scan was stopped whether it was manually or through a timeout.

OnTireWidthProvided

data class OnTireWidthProvided(val measurementUUID: String?, val tireWidth: Int?) : ScanEvent

Event invoked when the user selects a tire width in the TireWidthInput screen or skips the step.

ScanEvent

actual sealed class ScanEvent

Event classes that inherit from ScanEvent contain the data returned in the callbacks provided during the setup of the scan process.

expect sealed class ScanEvent

Event classes that inherit from ScanEvent contain the data returned in the callbacks provided during the setup of the scan process.

actual sealed class ScanEvent

Event classes that inherit from ScanEvent contain the data returned in the callbacks provided during the setup of the scan process. The following events are mandatory to be handled to provide a proper user flow: - OnUploadCompleted - OnUploadFailed - OnUploadAborted - OnScanAbort

ScanSpeed

@Serializable

enum ScanSpeed : Enum<ScanSpeed>

TireTreadScanner

actual class TireTreadScanner

expect class TireTreadScanner

actual class TireTreadScanner

Class representing the tire tread scanner.

TireTreadScanView

class TireTreadScanView @JvmOverloads constructor(context: Context, attrs: AttributeSet? = null, defStyleAttr: Int = 0) : FrameLayout

Functions

TireTreadScanView

fun TireTreadScanView(onScanAborted: (String?) -> Unit, onScanProcessCompleted: (String) -> Unit, callback: (ScanEvent) -> Unit?, onError: (String?, Exception) -> Unit): UIViewController?

Initializes the scan view with the default configuration using the DefaultUI.

fun TireTreadScanView(config: TireTreadConfig = TireTreadConfig(), onScanAborted: (String?) -> Unit, onScanProcessCompleted: (String) -> Unit, callback: (ScanEvent) -> Unit?, onError: (String?, Exception) -> Unit): UIViewController?

Initializes the scan view with the configuration that was provided with config.

fun TireTreadScanView(config: String, onScanAborted: (String?) -> Unit, onScanProcessCompleted: (String) -> Unit, callback: (ScanEvent) -> Unit?, onError: (String?, Exception) -> Unit): UIViewController?

Initializes the scan view with the configuration in form of a JSON string that was provided with config.