Video-Like Replay

Enhance your Session Replay experience with video-like playback. Configure screenshot quality and capture frequency to see exactly what your users experienced during their sessions.

Experimental API - PII Warning

Video-like Session Replay APIs require @OptIn(ExperimentalVideoLikeReplay::class).

This feature may capture sensitive UI unmasked in some cases. USE AT YOUR OWN DISCRETION TO PREVENT PII LEAKAGE. Opt in only after validating masking/privacy in your app.

Min Required SDK Version

Video-like Session Replay is supported starting Android SDK version 19.1.0

Overview

Video-like Session Replay transforms your session recordings from simple screen-by-screen captures into smooth, video-like playback. This feature gives you complete visibility into user behavior by:

• Capturing more frequent screenshots - See every interaction, not just screen transitions

• Providing configurable quality profiles - Balance visual fidelity with storage efficiency

• Supporting multiple capture modes - Choose the right approach for your debugging needs

---

Quick Start

Add these APIs before initializing the SDK for the best experience:

Kotlin

import ai.luciq.library.Luciq
import ai.luciq.library.LuciqInvocationEvent
import ai.luciq.library.sessionreplay.SessionReplay
import ai.luciq.library.sessionreplay.CapturingMode
import ai.luciq.library.sessionreplay.ScreenshotQuality
import ai.luciq.library.sessionreplay.ExperimentalVideoLikeReplay

// Configure video-like replay
@OptIn(ExperimentalVideoLikeReplay::class)
fun configureVideoLikeReplay() {
    SessionReplay.setCapturingMode(CapturingMode.FREQUENCY)
    SessionReplay.setScreenshotCaptureInterval(1000) // 1 screenshot per second
}

// Screenshot quality does NOT require @OptIn
SessionReplay.setScreenshotQuality(ScreenshotQuality.NORMAL)

// Initialize SDK
Luciq.Builder(application, "YOUR_APP_TOKEN")
    .setInvocationEvents(LuciqInvocationEvent.SHAKE)
    .build()

Java

---

Capturing Modes

Control when screenshots are captured using the setCapturingMode API.

setCapturingMode() requires @OptIn(ExperimentalVideoLikeReplay::class) when using INTERACTIONS or FREQUENCY modes.

Navigation Mode (Default)

Captures screenshots only when users navigate between screens. This is the default behavior and provides the lowest overhead.

Best for: Apps where screen transitions are the primary user flow

Kotlin

// Default mode - no @OptIn needed for NAVIGATION
SessionReplay.setCapturingMode(CapturingMode.NAVIGATION)

Java

---

Interactions Mode

Captures screenshots on screen navigation and user interactions. Includes debouncing to prevent excessive captures.

Best for: Debugging user interaction issues, understanding how users interact with complex screens

Supported Interactions

Legacy Views (XML)	Jetpack Compose
Tap	Tap
Double Tap	Double Tap
Long Press	Long Press
Swipe	Swipe
Pinch	Pinch
Scroll	Scroll

Kotlin

@OptIn(ExperimentalVideoLikeReplay::class)
fun enableInteractionsMode() {
    SessionReplay.setCapturingMode(CapturingMode.INTERACTIONS)
}

Java

---

Frequency Mode

Captures screenshots at a fixed time interval for true video-like playback. Also captures on screen navigation.

Best for: Full video-like replay experience, debugging visual issues, understanding complete user journeys

Kotlin

@OptIn(ExperimentalVideoLikeReplay::class)
fun enableFrequencyMode() {
    SessionReplay.setCapturingMode(CapturingMode.FREQUENCY)
    SessionReplay.setScreenshotCaptureInterval(1000) // Capture every 1000ms (1 FPS)
}

Java

On low-end Android devices, Navigation mode is automatically enforced regardless of the configured mode. See Low-End Device Handling for details.

---

Screenshot Capture Interval

When using Frequency mode, configure how often screenshots are captured.

setScreenshotCaptureInterval() requires @OptIn(ExperimentalVideoLikeReplay::class).

Parameter	Description
intervalMs	Time between captures in milliseconds
Default	1000ms (1 screenshot per second)
Minimum	500ms

Kotlin

@OptIn(ExperimentalVideoLikeReplay::class)
fun configureInterval() {
    // Capture every 500ms (2 FPS)
    SessionReplay.setScreenshotCaptureInterval(500)

    // Capture every 2 seconds
    SessionReplay.setScreenshotCaptureInterval(2000)
}

Java

Values below 500ms will be automatically set to 500ms (the minimum allowed). A warning will be logged to help you identify the issue.

Timer Reset Behavior

The capture timer resets when:

• A manual screenshot is captured via the SDK API

• Screen navigation occurs

This ensures you always capture important moments regardless of the timer state.

---

Screenshot Quality

Control the visual quality of captured screenshots. Higher quality provides better visuals but uses more storage.

setScreenshotQuality() does NOT require @OptIn - this API is stable and not experimental.

Quality Profiles

Profile	Compression	Use Case
HIGH	50% quality (WebP)	Detailed debugging, visual regression testing
NORMAL (Default)	25% quality (WebP)	Balanced quality and storage
GREYSCALE	25% quality + grayscale (WebP)	Maximum storage efficiency, text-heavy apps

Kotlin

SessionReplay.setScreenshotQuality(ScreenshotQuality.HIGH)      // Best visual quality
SessionReplay.setScreenshotQuality(ScreenshotQuality.NORMAL)    // Balanced (default)
SessionReplay.setScreenshotQuality(ScreenshotQuality.GREYSCALE) // Smallest file size

Java

Estimated Screenshots per Session

Based on the default 1MB session screenshot limit:

Quality Profile	Approx. Screenshots per Session
HIGH	~62 screenshots
NORMAL	~104 screenshots
GREYSCALE	~130 screenshots

For video-like replay at 1 FPS with NORMAL quality, you can capture approximately 1-2 minutes of continuous session activity.

---

Low-End Device Handling

To ensure optimal user experience, the SDK automatically detects low-end Android devices and enforces Navigation mode regardless of the configured capturing mode.

What This Means

• If you configure CapturingMode.FREQUENCY or CapturingMode.INTERACTIONS, low-end devices will still use CapturingMode.NAVIGATION

• Screenshot quality settings are still respected

• This behavior is automatic and requires no additional configuration

Why This Matters

Low-end devices have limited:

• CPU resources for frequent screenshot capture

• Memory for storing compressed images

• Storage for session data

By enforcing Navigation mode, the SDK prevents negative impact on app performance and user experience.

---

Configuration Timing

Recommended: Before SDK Initialization

For best results, configure Video-like Session Replay before calling Luciq.Builder().build():

Kotlin

@OptIn(ExperimentalVideoLikeReplay::class)
fun initializeLuciq() {
    // Configure video-like replay first
    SessionReplay.setCapturingMode(CapturingMode.FREQUENCY)
    SessionReplay.setScreenshotCaptureInterval(1000)
    SessionReplay.setScreenshotQuality(ScreenshotQuality.NORMAL)

    // Then initialize SDK
    Luciq.Builder(application, "YOUR_APP_TOKEN")
        .setInvocationEvents(LuciqInvocationEvent.SHAKE)
        .build()
}

Java

Runtime Configuration

You can also change settings during the session. Changes take effect as follows:

Setting	When Applied
Capturing Mode	Current session
Screenshot Quality	Next screenshot
Capture Interval	After current interval completes

Kotlin

@OptIn(ExperimentalVideoLikeReplay::class)
fun changeSettingsAtRuntime() {
    // Change quality mid-session (not experimental)
    SessionReplay.setScreenshotQuality(ScreenshotQuality.HIGH)

    // Switch capturing mode (applies immediately)
    SessionReplay.setCapturingMode(CapturingMode.FREQUENCY)
}

Java

---

Privacy & Masking

Video-like Session Replay respects all existing privacy configurations:

• Auto-masking continues to work across all capturing modes

• Private views are masked in all captured screenshots

• Secure flag on windows is respected - content is not captured

Marking Views as Private

Kotlin

// Legacy Views (XML)
sensitiveView.setLuciqPrivateView(true)

// Jetpack Compose
Box(
    modifier = Modifier.luciqPrivateView()
) {
    Text("Sensitive Data")
}

Java

Using Secure Flag

Views in windows with the secure flag are automatically excluded from Session Replay:

Kotlin

window.setFlags(
    WindowManager.LayoutParams.FLAG_SECURE,
    WindowManager.LayoutParams.FLAG_SECURE
)

Java

For more information on privacy controls, see Session Replay for Android.

---

Best Practices

Recommended Configurations

Use Case	Configuration
General debugging	Navigation mode + NORMAL quality
UI/UX analysis	Interactions mode + NORMAL quality
Full video replay	Frequency mode (1000ms) + NORMAL quality
Visual debugging	Frequency mode (500ms) + HIGH quality
Storage-conscious	Navigation mode + GREYSCALE quality

Code Examples

Video-like Replay (Balanced)

Kotlin

@OptIn(ExperimentalVideoLikeReplay::class)
fun configureBalancedVideoReplay() {
    SessionReplay.setCapturingMode(CapturingMode.FREQUENCY)
    SessionReplay.setScreenshotCaptureInterval(1000)
    SessionReplay.setScreenshotQuality(ScreenshotQuality.NORMAL)
}

Java

Interaction-Focused Debugging

Kotlin

@OptIn(ExperimentalVideoLikeReplay::class)
fun configureInteractionDebugging() {
    SessionReplay.setCapturingMode(CapturingMode.INTERACTIONS)
    SessionReplay.setScreenshotQuality(ScreenshotQuality.NORMAL)
}

Java

Maximum Visual Fidelity

Kotlin

@OptIn(ExperimentalVideoLikeReplay::class)
fun configureMaxFidelity() {
    SessionReplay.setCapturingMode(CapturingMode.FREQUENCY)
    SessionReplay.setScreenshotCaptureInterval(500)
    SessionReplay.setScreenshotQuality(ScreenshotQuality.HIGH)
}

Java

Storage-Optimized

Kotlin

// No @OptIn needed - using default NAVIGATION mode
SessionReplay.setCapturingMode(CapturingMode.NAVIGATION)
SessionReplay.setScreenshotQuality(ScreenshotQuality.GREYSCALE)

Java

---

API Reference

SessionReplay.setCapturingMode()

Sets when screenshots are captured.

Requires @OptIn(ExperimentalVideoLikeReplay::class) for INTERACTIONS and FREQUENCY modes.

SessionReplay.setCapturingMode(mode: CapturingMode)

Value	Description
CapturingMode.NAVIGATION	Capture on screen changes only (default)
CapturingMode.INTERACTIONS	Capture on navigation and user interactions
CapturingMode.FREQUENCY	Capture at fixed time intervals

---

SessionReplay.setScreenshotQuality()

Sets the visual quality of captured screenshots.

This API is NOT experimental - no @OptIn required.

SessionReplay.setScreenshotQuality(quality: ScreenshotQuality)

Value	Description
ScreenshotQuality.HIGH	50% WebP compression
ScreenshotQuality.NORMAL	25% WebP compression (default)
ScreenshotQuality.GREYSCALE	Grayscale + 25% WebP compression

---

SessionReplay.setScreenshotCaptureInterval()

Sets the capture interval for Frequency mode.

Requires @OptIn(ExperimentalVideoLikeReplay::class).

SessionReplay.setScreenshotCaptureInterval(intervalMs: Int)

Parameter	Description
intervalMs	Interval in milliseconds (min: 500, default: 1000)

---

Migration Guide

If you're upgrading from a previous SDK version:

1. No breaking changes - Default behavior remains Navigation mode with NORMAL quality

2. Opt-in feature - Video-like replay must be explicitly configured

3. Repro Steps unaffected - Bug and Crash report screenshots continue to use Navigation mode and NORMAL quality

4. Experimental APIs - Remember to add @OptIn(ExperimentalVideoLikeReplay::class) when using setCapturingMode() with non-default modes or setScreenshotCaptureInterval()