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.

Since

1.6.0

Functions

attachToGlContext

abstract fun attachToGlContext(textureId: Int)

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

abstract override fun close()

detachFromGlContext

abstract fun detachFromGlContext()

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

pause

abstract fun pause()

Pauses frame updates made available to listeners through subscribeTo.

readFrame

abstract fun readFrame(): ImageProcessor.Input.Frame

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

resume

abstract fun resume()

Starts or resumes frame updates made available to listeners through 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.

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.