CameraKit/com.snap.camerakit/ImageProcessor/Input

Input

interface Input

Defines the image input source model that is available to be read from by the processor.

Inheritors

BackedBySurfaceTexture

Pausable

Types

BackedBySurfaceTexture

abstract class BackedBySurfaceTexture(val surfaceTexture: SurfaceTexture) : ImageProcessor.Input

Convenience base Input that is backed by android.graphics.SurfaceTexture.

Capability

enum Capability : Enum<ImageProcessor.Input.Capability>

Defines all capabilities that Input may provide in addition to image data.

Companion

object Companion

Allows to attach extension functions to the Input interface on implementation side.

Frame

interface Frame

Defines the properties of a single image input Frame available from Input.readFrame.

Option

sealed class Option

Defines possible Input usage options that ImageProcessor should consider when interacting with it.

Pausable

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

interface Pausable : ImageProcessor.Input, Closeable

Defines an Input that provides an ability to pause and resume frame updates. Once done using an instance of Pausable, close must be called to avoid leaking resources.

Properties

facingFront

abstract val facingFront: Boolean

True indicates whether a Frame is facing front in relation to user that is observing it.

height

abstract val height: Int

The expected height in pixels of a Frame that is read once available.

rotationDegrees

abstract val rotationDegrees: Int

The natural orientation of a Frame in relation to a device that is providing it.

width

abstract val width: Int

The expected width in pixels of a Frame that is read once available.

Functions

attachToGlContext

abstract fun attachToGlContext(textureId: Int)

Mirrors android.graphics.SurfaceTexture.attachToGLContext when this input is backed by android.graphics.SurfaceTexture.

detachFromGlContext

abstract fun detachFromGlContext()

Mirrors android.graphics.SurfaceTexture.detachFromGLContext when this input is backed by android.graphics.SurfaceTexture.

readFrame

abstract fun readFrame(): ImageProcessor.Input.Frame

Allows to read a Frame when notified by in a callback subscribed via subscribeTo.

subscribeTo

@CheckResult

abstract fun subscribeTo(onFrameAvailable: Consumer<ImageProcessor.Input>): Closeable

Subscribes to the provided onFrameAvailable to be notified when a new Frame is available for this input. The returned Closeable must be closed when done working with this input otherwise underlying resources will be leaked.