onyxsdk-ktx/com.onyx.android.sdk.ktx.ink/PenSession

PenSession

interface PenSession : Closeable(source)

Injectable application-facing pen-session contract.

Inheritors

Properties

completedStrokes

abstract val completedStrokes: Flow<InkStroke>

Completed strokes in input order.

abstract val events: Flow<PenEvent>

Ordered raw pen events emitted while the stream is collected.

abstract val preview: StateFlow<InkPreview?>

Latest preview snapshot, or null before a stroke begins.

abstract val state: StateFlow<RawInkSessionState>

Current lifecycle state of the session.

Functions

abstract fun close()

abstract suspend fun closeAndAwait(): Result<Unit>

Closes the session and waits for firmware resources and its process lease to be released.

abstract suspend fun commit(bitmap: Bitmap, destination: Rect, dirtyRegion: Rect = destination, options: CommitOptions = CommitOptions()): Result<CommitReceipt>

Posts bitmap, refreshes dirtyRegion, and restores the session configuration.

abstract suspend fun pause(): Result<Unit>

Suspends firmware input and overlay rendering for this session.

abstract suspend fun resume(): Result<Unit>

Resumes firmware input and overlay rendering when a surface is available.