recorder-annotations/io.github.hdcodedev.composegif.annotations/RecordGif

RecordGif

@Target(allowedTargets = [AnnotationTarget.FUNCTION])

annotation class RecordGif(val name: String = "", val durationMs: Int = 3000, val fps: Int = 50, val widthPx: Int = 540, val heightPx: Int = 0, val theme: GifTheme = GifTheme.DARK, val interactionStartDelayMs: Int = 1000, val interactionNodeTag: String = "", val interactions: Array<GifInteraction> = [], val gestures: Array<GifGestureStep> = [])

Marks a parameterless @Composable function as a GIF capture scenario.

Properties

val durationMs: Int = 3000

Target recording duration in milliseconds.

val fps: Int = 50

Capture frame rate used for frame extraction.

val gestures: Array<GifGestureStep>

Explicit low-level gesture steps to replay during capture.

val heightPx: Int = 0

Output height in pixels. Use 0 to keep aspect ratio and auto-resolve height.

interactionNodeTag

val interactionNodeTag: String

Node tag used as the gesture target root.

val interactions: Array<GifInteraction>

High-level interactions expanded into low-level gesture steps.

interactionStartDelayMs

val interactionStartDelayMs: Int = 1000

Delay before replaying configured interactions/gestures.

val name: String

Optional explicit scenario name. When blank, the KSP processor derives it from the function name.

val theme: GifTheme

Scenario theme metadata written into generated configuration.

val widthPx: Int = 540

Output width in pixels before GIF encoding.