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

RawInkSession

class RawInkSession : PenSession(source)

Exclusive, generation-aware owner of the firmware raw-ink overlay.

All lifecycle, input, surface, and commit commands are processed on one private queue. The public suspend functions may be called from any dispatcher.

Types

Companion

object Companion

Factory methods for exclusive raw-ink sessions.

Properties

completedStrokes

open override val completedStrokes: Flow<InkStroke>

Lossless channel with an enforced single collector.

events

open override val events: Flow<PenEvent>

Lossless and ordered while collected; events are not retained without a collector.

preview

open override val preview: StateFlow<InkPreview?>

Latest-wins preview. Sequence numbers make any coalesced intermediate updates explicit.

state

open override val state: StateFlow<RawInkSessionState>

Current lifecycle state of this session.

Functions

open override fun close()

Requests asynchronous session cleanup.

closeAndAwait

open suspend override fun closeAndAwait(): Result<Unit>

Closes the session and waits for all firmware cleanup to finish.

commit

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

Posts a bitmap beneath the overlay and restores raw-ink rendering afterward.

pause

open suspend override fun pause(): Result<Unit>

Pauses raw input and firmware overlay rendering.

resume

open suspend override fun resume(): Result<Unit>

Resumes raw input and overlay rendering when the surface is available.