PostHogSessionReplayConfig

Properties

NameType
maskAllTextInputsboolean

Enable masking of all text and text input fields

maskAllImagesboolean

Enable masking of all images to a placeholder

maskAllSandboxedViewsboolean

Enable masking of all sandboxed system views These may include UIImagePickerController, PHPickerViewController and CNContactPickerViewController iOS only

captureLogboolean

Enable capturing of logs as console events

iOSdebouncerDelayMsnumber

Deboucer delay used to reduce the number of snapshots captured and reduce performance impact This is used for capturing the view as a screenshot The lower the number more snapshots will be captured but higher the performance impact Deprecated: please use throttleDelayMs instead

androidDebouncerDelayMsnumber

Deboucer delay used to reduce the number of snapshots captured and reduce performance impact This is used for capturing the view as a screenshot The lower the number more snapshots will be captured but higher the performance impact Ps: it was 500ms (0.5s) by default until version 3.3.7 Deprecated: please use throttleDelayMs instead

throttleDelayMsnumber

Throttling delay used to reduce the number of snapshots captured and reduce performance impact This is used for capturing the view as a wireframe or screenshot The lower the number more snapshots will be captured but higher the performance impact

This value has precedence over iOSdebouncerDelayMs and androidDebouncerDelayMs If this is not set, we will take the max number between iOSdebouncerDelayMs and androidDebouncerDelayMs for back compatibility

captureNetworkTelemetryboolean

Enable capturing network telemetry iOS only

screenshotModeBackgroundCaptureboolean

Schedule screenshot image capture on a background queue. iOS only Experimental support

Warning: Enabling this option will trigger Main Thread Checker warnings and may briefly freeze the app the first time a screenshot is captured. Consider disabling Main Thread Checker in your scheme's run diagnostics when enabling this.

sampleRatenumber

Session replay sample rate between 0 and 1 Local config has precedence over remote config when both are set. If undefined, sampling is controlled by remote config (when available).

Community questions