CameraKit/com.snap.camerakit/Session/Processor

Processor

interface Processor : ImageProcessor, AudioProcessor, UserProcessor, LocationProcessor, SafeRenderAreaProcessor, MediaProcessor, LegalProcessor

Defines a processor that Session exposes to its users.

Functions

Link copied to clipboard
@CheckResult
abstract fun connectInput(input: AudioProcessor.Input): Closeable

Connects the provided input to this processor and returns a Closeable to release the connection when required. Normally, processing of the provided input starts instantly however certain processors may do it async so it is not guaranteed that any work will be done as soon as input is connected.

@CheckResult
abstract fun connectInput(input: ImageProcessor.Input): Closeable
@CheckResult
open fun connectInput(input: ImageProcessor.Input, options: Set<ImageProcessor.Input.Option>): Closeable

Connects the provided input to this processor and returns a Closeable to release the connection when required. Normally, processing of the provided input starts instantly however certain processors may do it async so it is not guaranteed that any work will be done as soon as input is connected.

@CheckResult
abstract fun connectInput(input: LegalProcessor.Input): Closeable

Connects the provided input to this processor and returns a Closeable to release the connection when required. Normally, processing of the provided input starts instantly however certain processors may do it async so it is not guaranteed that any work will be done as soon as input is connected.

@CheckResult
abstract fun connectInput(input: LocationProcessor.Input): Closeable

Connects the provided input to this processor and returns a Closeable to release the connection when required. Normally, processing of the provided input starts instantly however certain processors may do it async so it is not guaranteed that any work will be done as soon as input is connected.

@CheckResult
abstract fun connectInput(input: MediaProcessor.Input): Closeable

Connects the provided input to this processor and returns a Closeable to release the connection when required. Normally, processing of the provided input starts instantly however certain processors may do it async so it is not guaranteed that any work will be done as soon as input is connected.

@CheckResult
abstract fun connectInput(input: SafeRenderAreaProcessor.Input): Closeable

Connects the provided input to this processor and returns a Closeable to release the connection when required. Normally, processing of the provided input starts instantly however certain processors may do it async so it is not guaranteed that any work will be done as soon as input is connected.

@CheckResult
abstract fun connectInput(input: UserProcessor.Input): Closeable

Connects the provided input to this processor and returns a Closeable to release the connection when required. Normally, processing of the provided input starts instantly however certain processors may do it async so it is not guaranteed that any work will be done as soon as input is connected.

Link copied to clipboard
@CheckResult
abstract fun connectOutput(output: ImageProcessor.Output): Closeable
@CheckResult
open fun connectOutput(output: ImageProcessor.Output, options: Set<ImageProcessor.Output.Option>): Closeable

Connects the provided output to this processor and returns a Closeable to release the connection when required. Similarly to connectInput, it is not guaranteed that the provided output will receive results as soon as it is connected, the processor may do it async.

Link copied to clipboard
@CheckResult
abstract fun observe(onResult: Consumer<LegalProcessor.Input.Result>): Closeable

Notifies the provided onResult callback when this LegalProcessor obtains a Input.Result until the returned Closeable is closed.

Link copied to clipboard
@CheckResult
abstract fun observeRequiredCapabilities(onCapabilitiesRequested: Consumer<Set<ImageProcessor.Input.Capability>>): Closeable

Takes in onCapabilitiesRequested that will be notified when image processing operations require additional data from connected Input. Right after observeRequiredCapabilities is called onCapabilitiesRequested consumer will be invoked on the caller thread with the current set of required capabilities. emptySet is used to represent that additional capabilities aren't required.

Link copied to clipboard
abstract fun waitFor(requestUpdate: LegalProcessor.Input.RequestUpdate, onResult: Consumer<LegalProcessor.Input.Result>)

Notifies the provided onResult callback when this LegalProcessor handles a Input.Result. When the requestUpdate option is LegalProcessor.Input.RequestUpdate.ALWAYS the processor will attempt to subscribe to a LegalProcessor.Input eagerly in order to obtain a Input.Result earlier than typically required.