CameraKit/com.snap.camerakit/ImageProcessor/Input/Pausable

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

Link copied to clipboard
abstract fun attachToGlContext(textureId: Int)

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

Link copied to clipboard
abstract override fun close()
Link copied to clipboard
Link copied to clipboard
abstract fun pause()

Pauses frame updates made available to listeners through subscribeTo.

Link copied to clipboard
abstract fun readFrame(): ImageProcessor.Input.Frame

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

Link copied to clipboard
abstract fun resume()

Starts or resumes frame updates made available to listeners through subscribeTo.

Link copied to clipboard
@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.

Properties

Link copied to clipboard
abstract val facingFront: Boolean

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

Link copied to clipboard
abstract val height: Int

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

Link copied to clipboard
abstract val rotationDegrees: Int

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

Link copied to clipboard
abstract val width: Int

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