SDK Reference

This reference documents UXCam SDK methods available across all platforms. For platform-specific implementation guides, see the Mobile SDK or Web SDK documentation.

Core APIs

Configuration & Initialization

Method	Description
`startWithConfiguration(config)`	Initialize the SDK with configuration options
`optIntoVideoRecordings()`	Enable screen recording (required for iOS/Android)

Configuration Options

See platform guides for all configuration parameters

Screen Tagging

Tag screens for analytics and heatmaps.

Method	Description
`tagScreenName(screenName)`	Manually tag the current screen

// iOS
UXCam.tagScreenName("Home Screen")

// Android
UXCam.tagScreenName("Home Screen")

// React Native
RNUxcam.tagScreenName("Home Screen")

// Flutter
FlutterUxcam.tagScreenName("Home Screen")

Screen Tagging Guide

Complete screen tagging documentation with examples

Platform-Specific Guides

Android, iOS, Flutter navigation integration

Events

Track custom user actions.

Method	Description
`logEvent(eventName)`	Log an event
`logEvent(eventName, properties)`	Log an event with properties

// iOS
UXCam.logEvent("Purchase", withProperties: ["item": "Pro Plan", "price": 9.99])

// Android
UXCam.logEvent("Purchase", mapOf("item" to "Pro Plan", "price" to 9.99))

// React Native
RNUxcam.logEventWithProperties("Purchase", { item: "Pro Plan", price: 9.99 })

// Flutter
FlutterUxcam.logEventWithProperties("Purchase", {"item": "Pro Plan", "price": 9.99})

Events Guide

Complete event tracking documentation

User Identification

Associate sessions with user identifiers.

Method	Description
`setUserIdentity(userId)`	Set the user identifier
`setUserProperty(key, value)`	Set a user property

// iOS
UXCam.setUserIdentity("user_12345")
UXCam.setUserProperty("subscription", value: "premium")

// Android
UXCam.setUserIdentity("user_12345")
UXCam.setUserProperty("subscription", "premium")

// React Native
RNUxcam.setUserIdentity("user_12345")
RNUxcam.setUserProperty("subscription", "premium")

// Flutter
FlutterUxcam.setUserIdentity("user_12345")
FlutterUxcam.setUserProperty("subscription", "premium")

User Properties Guide

Complete user identification documentation

Privacy APIs

Occlusion (Sensitive Data)

Hide sensitive content in recordings.

Method	Description
`occludeSensitiveView(view)`	Hide a specific view
`occludeSensitiveScreen(true)`	Hide the entire screen
`occludeAllTextFields(true)`	Hide all text input fields

// iOS
UXCam.occlude(sensitiveView)
UXCam.occludeAllTextFields(true)

// Android
UXCam.occludeSensitiveView(sensitiveView)
UXCam.occludeAllTextFields(true)

Occlusion Guide

Complete occlusion documentation with platform examples

Consent & Opt-Out

Manage user consent for recording.

Method	Description
`optOutOverall()`	Stop all recording for this user
`optIn()`	Resume recording (if previously opted out)
`optOutStatus()`	Check if user has opted out

// iOS
UXCam.optOutOverall()
let isOptedOut = UXCam.optOutStatus()
UXCam.optIn()

// Android
UXCam.optOutOverall()
val isOptedOut = UXCam.optOutStatus()
UXCam.optIn()

Opt-In/Out Guide

Complete consent management documentation

Session Control APIs

Recording Control

Control when recording happens.

Method	Description
`stopSessionAndUploadData()`	End session and upload
`pauseScreenRecording()`	Pause screen capture
`resumeScreenRecording()`	Resume screen capture
`isRecording()`	Check if currently recording

// iOS
UXCam.stopSessionAndUploadData()
let recording = UXCam.isRecording()

// Android
UXCam.stopSessionAndUploadData()
val recording = UXCam.isRecording()

Recording Control Guide

Complete recording control documentation

Crash Handling

Configure crash and exception reporting.

Method	Description
`reportExceptionEvent(exception)`	Report a handled exception
Configuration: `enableCrashHandling`	Enable/disable crash capture

Crash Handling Guide

Crash and exception reporting documentation

Debugging APIs

Integration Logging

Method	Description
Configuration: `enableIntegrationLogging`	Enable verbose debug logs
`urlForCurrentSession()`	Get dashboard URL for current session

// iOS
config.enableIntegrationLogging = true
if let url = UXCam.urlForCurrentSession() {
    print("Session URL: \(url)")
}

// Android
val config = UXConfig.Builder(key)
    .enableIntegrationLogging(true)
    .build()
val url = UXCam.urlForCurrentSession()

Debugging Guide

Integration logging documentation

Platform-Specific APIs

Some features have platform-specific implementations:

Feature	Platforms	Guide
Jetpack Compose Tagging	Android	Guide
SwiftUI Tagging	iOS	Guide
Flutter Route Tracking	Flutter	Guide
Jetpack Compose Occlusion	Android	Guide
WebView Handling	All	Guide