Unified API for UXCam session recording, offering session control, user identification, event logging, screen privacy/occlusion, session URLs, opt‑in/out controls and configurable capture behavior.
A Kotlin Multiplatform wrapper library for UXCam session recording SDK, providing a unified Kotlin API for both Android and iOS platforms.
Add the repository to your settings.gradle.kts:
dependencyResolutionManagement {
repositories {
maven { url = uri("https://sdk.uxcam.com/android/") }
}
}
Add the dependency to your shared module's build.gradle.kts:
kotlin {
sourceSets {
commonMain.dependencies {
implementation("dev.onexeor:uxcam-kmp:<version>")
}
}
}
Add the repository to your settings.gradle.kts:
dependencyResolutionManagement {
repositories {
maven { url = uri("https://sdk.uxcam.com/android/") }
}
}
Add the dependency to your module's build.gradle.kts:
dependencies {
implementation("dev.onexeor:uxcam-kmp:<version>")
}
Add to your Podfile:
pod 'uxcam-kmp', :git => 'https://github.com/OneXeor/UXCam-KMP.git'
Then run:
pod install
import dev.onexeor.uxcam.UXCam
import dev.onexeor.uxcam.UXConfig
// Basic initialization
UXCam.startWithConfiguration(
key = "YOUR_UXCAM_API_KEY"
) { success ->
println("UXCam initialized: $success")
}
// With custom configuration
UXCam.startWithConfiguration(
key = "YOUR_UXCAM_API_KEY",
config = UXConfig(
enableAutomaticScreenNameTagging = true,
enableImprovedScreenCapture = true, // Android only
enableCrashHandling =
)
) { success ->
println()
}
UXCam.setUserIdentity("user-123")
UXCam.setUserProperty("plan", "premium")
UXCam.setUserProperty("age", 25)
UXCam.setUserProperty("verified", true)
UXCam.logEvent("button_clicked")
UXCam.logEvent("purchase_completed", mapOf(
"product_id" to "SKU-123",
"amount" to 29.99
))
// Pause/resume recording
UXCam.pauseScreenRecording()
UXCam.resumeScreenRecording()
// Session management
UXCam.startNewSession()
UXCam.stopSessionAndUploadData()
UXCam.cancelCurrentSession()
// Get current session URL
val sessionUrl = UXCam.urlForCurrentSession()
// Ignore specific screens from recording
UXCam.addScreenNameToIgnore("PaymentScreen")
UXCam.addScreenNamesToIgnore(listOf("LoginScreen", "SettingsScreen"))
enableImprovedScreenCapture for enhanced recording qualityenableImprovedScreenCapture is ignored (Android-only feature)optIntoSchematicRecordings() during initialization# Build the library
./gradlew :uxcam-kmp:build
# Run tests
./gradlew :uxcam-kmp:allTests
# Generate iOS framework
./gradlew :uxcam-kmp:generateDummyFramework
This project is actively maintained. See our GitHub Milestones for planned releases:
Contributions are welcome! Check the open issues to find something to work on.
Contributions are welcome! Please read our Contributing Guidelines before submitting a Pull Request.
This project is licensed under the MIT License - see the LICENSE file for details.
Note: This is a wrapper library. The underlying UXCam SDK is subject to UXCam's Terms and Conditions. You need a valid UXCam account to use this library.
| Method | Description |
|---|
startWithConfiguration(key, config, completionHandler) | Initialize UXCam with API key and configuration |
tagScreenName(screenName) | Manually tag current screen with a name |
setUserIdentity(identity) | Set user identifier |
setUserProperty(key, value) | Set custom user property |
logEvent(eventName, properties?) | Log custom event |
pauseScreenRecording() | Pause screen recording |
resumeScreenRecording() | Resume screen recording |
startNewSession() | Start a new recording session |
stopSessionAndUploadData() | Stop session and upload data |
cancelCurrentSession() | Cancel current session |
urlForCurrentSession() | Get URL for current session |
urlForCurrentUser() | Get URL for all user's sessions |
isRecording() | Check if recording is currently active |
pendingUploads() | Get count of sessions pending upload |
optOutOverall() | Opt user out of all recording (GDPR) |
optInOverall() | Opt user back into recording |
optInOverallStatus() | Check if user is opted in |
optOutOfSchematicRecordings() | Opt out of schematic recordings (iOS only) |
optIntoSchematicRecordings() | Opt into schematic recordings (iOS only) |
optInSchematicRecordingStatus() | Check schematic recording status (iOS only) |
occludeSensitiveView(view) | Hide sensitive view from recordings |
unOccludeSensitiveView(view) | Remove occlusion from a view |
addScreenNameToIgnore(screenName) | Exclude screen from recording |
addScreenNamesToIgnore(screenNames) | Exclude multiple screens |
removeScreenNameToIgnore(screenName) | Remove screen from ignore list |
removeAllScreenNamesToIgnore() | Clear all ignored screens |
allowShortBreakForAnotherApp(b) | Allow short app switches |
| Property | Type | Default | Description |
|---|
enableAutomaticScreenNameTagging | Boolean | true | Auto-tag screen names |
enableImprovedScreenCapture | Boolean | false | Improved capture (Android only) |
enableCrashHandling | Boolean | true | Enable crash reporting |
enableMultiSessionRecord | Boolean | true | Record multiple sessions |
enableIntegrationLogging | Boolean | false | Enable verbose debug logging |
enableAdvancedGestureRecognition | Boolean | false | Advanced gestures (iOS only) |
Surfaced from shared tags and platforms — no rankings paid for.