camera-core/com.stripe.android.camera.framework/ResultAggregator

ResultAggregator

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP])

abstract class ResultAggregator<DataFrame, State, AnalyzerResult, InterimResult, FinalResult>(listener: AggregateResultListener<InterimResult, FinalResult>, initialState: State, statsName: String?) : StatefulResultHandler<DataFrame, State, AnalyzerResult, Boolean> , LifecycleEventObserver

The ResultAggregator processes results from analyzers until a condition is met. That condition is part of the aggregator's logic.

Constructors

ResultAggregator

constructor(listener: AggregateResultListener<InterimResult, FinalResult>, initialState: State, statsName: String?)

Properties

var state: State

The state of the result handler. This can be read, but not updated by analyzers.

Functions

aggregateResult

abstract suspend fun aggregateResult(frame: DataFrame, result: AnalyzerResult): Pair<InterimResult, FinalResult?>

Aggregate a new result. If this method returns a non-null FinalResult, the aggregator will stop listening for new results.

bindToLifecycle

open fun bindToLifecycle(lifecycleOwner: LifecycleOwner)

Bind this result aggregator to a lifecycle. This allows the result aggregator to pause and reset when the lifecycle owner pauses.

fun cancel()

Cancel a result aggregator. This means that the result aggregator will ignore all further results and will never return a final result.

open suspend override fun onResult(result: AnalyzerResult, data: DataFrame): Boolean

open override fun onStateChanged(source: LifecycleOwner, event: Lifecycle.Event)