Advanced Configuration & APIs

This section covers advanced UXCam Android SDK features beyond the basic integration.

Control Recording

Start, stop, and manage session recording programmatically.

Crashes & ANRs

How UXCam captures crash reports and ANR events.

Opt In / Opt Out

Give users control over session recording for privacy compliance.

Pause & Resume Recording

Temporarily pause recording for sensitive flows without stopping the session.

Integration Logging

Enable verbose SDK logs for debugging your integration.

Report Handled Exceptions

Send caught exceptions to UXCam alongside session replays.

Troubleshooting FAQs

Common issues and solutions during Android integration.

UXConfig Builder Reference

All configuration is set via UXConfig.Builder before calling UXCam.startWithConfiguration():

val config = UXConfig.Builder("YOUR_APP_KEY")
    // Screen tagging
    .enableAutomaticScreenNameTagging(true)            // default: true
    .enableReadableFragmentNames(true)                 // default: true (v3.10.0+)

    // Recording behavior
    .enableMultiSessionRecord(true)                    // default: true
    .enableCrashHandling(true)                         // default: true

    // Debugging
    .enableIntegrationLogging(false)                   // default: false
    .enableVerboseLogging(false)                       // default: false

    // Security
    .honorFlagSecure(false)                            // default: false

    // Environment filtering
    .environment(Environment.RELEASE)                  // ALPHA | BETA | RELEASE

    // Privacy — set occlusion at init time
    .occlusions(listOf(/* UXCamOcclusion objects */))  // optional

    // Experimental
    // .enableExperimentalForceQuitVideoRecovery()     // opt-in: recovers video on force quit

    .build()

UXCam.startWithConfiguration(config)

UXConfig config = new UXConfig.Builder("YOUR_APP_KEY")
    .enableAutomaticScreenNameTagging(true)
    .enableReadableFragmentNames(true)                 // v3.10.0+
    .enableMultiSessionRecord(true)
    .enableCrashHandling(true)
    .enableIntegrationLogging(false)
    .honorFlagSecure(false)
    .environment(Environment.RELEASE)
    .build();

UXCam.startWithConfiguration(config);

Configuration Options

Option	Default	Description
`enableAutomaticScreenNameTagging`	`true`	Auto-tag screens based on Activity/Fragment names
`enableReadableFragmentNames`	`true`	Show `Activity/Fragment` instead of hex hashes in timeline (v3.10.0+)
`enableMultiSessionRecord`	`true`	Record multiple sessions per app launch
`enableCrashHandling`	`true`	Capture crash reports and link them to session replays
`enableIntegrationLogging`	`false`	Print verbose SDK logs to Logcat for debugging
`enableVerboseLogging`	`false`	Extra-detailed logging (use only when requested by support)
`honorFlagSecure`	`false`	Respect Android's `FLAG_SECURE` window flag
`environment`	—	Filter sessions by build type: `ALPHA`, `BETA`, or `RELEASE`
`occlusions`	`[]`	Pre-configured occlusion rules applied at SDK start
`enableExperimentalForceQuitVideoRecovery`	`false`	Experimental: attempt to recover video data after force quit

⚠️
Deprecated Methods
The following initialization methods are deprecated since v3.4.0. Use UXConfig.Builder + startWithConfiguration() instead:

startWithKey(String) and all its overloads

setAutomaticScreenNameTagging(boolean)

setImprovedScreenCaptureEnabled(boolean) — improved capture is now always on

enableMultiSessionRecording(boolean) on old UXConfig — use builder