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

Package-level declarations

Types

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

interface AggregateResultListener<InterimResult, FinalResult>

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

interface Analyzer<Input, State, Output>

An analyzer takes some data as an input, and returns an analyzed output. Analyzers should not contain any state. They must define whether they can run on a multithreaded executor, and provide a means of analyzing input data to return some form of result.

AnalyzerFactory

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

interface AnalyzerFactory<Input, State, Output, AnalyzerType : Analyzer<Input, State, Output>>

A factory to create analyzers.

AnalyzerLoop

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

sealed class AnalyzerLoop<DataFrame, State, Output> : ResultHandler<DataFrame, Output, Boolean>

A loop to execute repeated analysis. The loop uses coroutines to run the Analyzer.analyze method. If the Analyzer is threadsafe, multiple coroutines will be used. If not, a single coroutine will be used.

AnalyzerLoopErrorListener

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

interface AnalyzerLoopErrorListener

AnalyzerPool

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

data class AnalyzerPool<DataFrame, State, Output>(val desiredAnalyzerCount: Int, val analyzers: List<Analyzer<DataFrame, State, Output>>)

A pool of analyzers.

FiniteAnalyzerLoop

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

class FiniteAnalyzerLoop<DataFrame, State, Output>(analyzerPool: AnalyzerPool<DataFrame, in State, Output>, resultHandler: TerminatingResultHandler<DataFrame, out State, Output>, analyzerLoopErrorListener: AnalyzerLoopErrorListener, timeLimit: Duration = Duration.INFINITE, statsName: String? = null) : AnalyzerLoop<DataFrame, State, Output>

This kind of AnalyzerLoop will process data provided as part of its constructor. Data will be processed in the order provided.

ProcessBoundAnalyzerLoop

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

class ProcessBoundAnalyzerLoop<DataFrame, State, Output>(analyzerPool: AnalyzerPool<DataFrame, in State, Output>, resultHandler: StatefulResultHandler<DataFrame, out State, Output, Boolean>, analyzerLoopErrorListener: AnalyzerLoopErrorListener, statsName: String? = null) : AnalyzerLoop<DataFrame, State, Output>

This kind of AnalyzerLoop will process data until the result handler indicates that it has reached a terminal state and is no longer listening.

RepeatingTaskStats

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

data class RepeatingTaskStats(val executions: Int, val startedAt: ComparableTimeMark, val totalDuration: Duration, val totalCpuDuration: Duration, val minimumDuration: Duration, val maximumDuration: Duration)

ResultAggregator