diff --git a/contents/docs/session-replay/_snippets/android-installation.mdx b/contents/docs/session-replay/_snippets/android-installation.mdx
index 1889a49bc422..a47a7b6a5c5a 100644
--- a/contents/docs/session-replay/_snippets/android-installation.mdx
+++ b/contents/docs/session-replay/_snippets/android-installation.mdx
@@ -4,11 +4,26 @@
import AndroidInstall from "../../integrate/_snippets/install-android.mdx"
+export const EnableSessionReplayDark = "https://res.cloudinary.com/dmukukwp6/image/upload/posthog.com/contents/images/docs/session-replay/enable-session-replay-in-project-settings-dark-mode.png"
+export const EnableSessionReplayLight = "https://res.cloudinary.com/dmukukwp6/image/upload/posthog.com/contents/images/docs/session-replay/enable-session-replay-in-project-settings-light-mode.png"
+
+
> Session replay requires PostHog Android SDK version >= [3.4.0](https://github.com/PostHog/posthog-android/releases), and it's recommended to always use the latest version.
-## Step two: Configure replay settings
+## Step two: Enable session recordings in your project settings
+
+Enable session recordings in your PostHog [Project Settings](https://app.posthog.com/project/settings).
+
+
+
+## Step three: Configure replay settings
Add `sessionReplay = true` to your PostHog configuration alongside any of your other configuration options:
diff --git a/contents/docs/session-replay/_snippets/flutter-installation.mdx b/contents/docs/session-replay/_snippets/flutter-installation.mdx
index 88cb38b53bdb..f8583e4561f8 100644
--- a/contents/docs/session-replay/_snippets/flutter-installation.mdx
+++ b/contents/docs/session-replay/_snippets/flutter-installation.mdx
@@ -6,6 +6,10 @@
import FlutterInstall from "../../integrate/_snippets/install-flutter.mdx"
+export const EnableSessionReplayDark = "https://res.cloudinary.com/dmukukwp6/image/upload/posthog.com/contents/images/docs/session-replay/enable-session-replay-in-project-settings-dark-mode.png"
+export const EnableSessionReplayLight = "https://res.cloudinary.com/dmukukwp6/image/upload/posthog.com/contents/images/docs/session-replay/enable-session-replay-in-project-settings-light-mode.png"
+
+
#### Widget and Observer setup
@@ -43,7 +47,18 @@ class _MyAppState extends State {
}
```
-## Step two: Configure replay settings
+## Step two: Enable session recordings in your project settings
+
+Enable session recordings in your PostHog [Project Settings](https://app.posthog.com/project/settings).
+
+
+
+## Step three: Configure replay settings
Add `sessionReplay = true` to your PostHog configuration alongside any of your other configuration options:
diff --git a/contents/docs/session-replay/_snippets/ios-installation.mdx b/contents/docs/session-replay/_snippets/ios-installation.mdx
index 08dd8f6979b3..d574e4de164c 100644
--- a/contents/docs/session-replay/_snippets/ios-installation.mdx
+++ b/contents/docs/session-replay/_snippets/ios-installation.mdx
@@ -4,13 +4,45 @@
import IOSInstall from "../../integrate/_snippets/install-ios.mdx"
+export const EnableSessionReplayDark = "https://res.cloudinary.com/dmukukwp6/image/upload/posthog.com/contents/images/docs/session-replay/enable-session-replay-in-project-settings-dark-mode.png"
+export const EnableSessionReplayLight = "https://res.cloudinary.com/dmukukwp6/image/upload/posthog.com/contents/images/docs/session-replay/enable-session-replay-in-project-settings-light-mode.png"
+
> Requires PostHog iOS SDK version >= [3.6.0](https://github.com/PostHog/posthog-ios/releases), and it's recommended to always use the latest version.
-## Step two: Configure replay settings
+## Step two: Enable session recordings in your project settings
+
+Enable session recordings in your PostHog [Project Settings](https://app.posthog.com/project/settings).
+
+
+
+## Step three: Configure replay settings
+
+### Automatically start session recordings
+
+Setting `config.sessionReplay = true` to your PostHog configuration will start session recordings on SDK setup.
+
+### Manually control session recordings
+
+Setting `config.sessionReplay = false` to your PostHog configuration will prevent PostHog from automatically starting session recordings on SDK setup.
+
+You can manually control when to start and stop session recordings using the following two methods:
+
+- `startSessionRecording(resumeCurrent: Bool)`
+ - Set **resumeCurrent** to `true` to resume a previous session recording (Default).
+ - Set **resumeCurrent** to `false` to start a new session recording.
+- `stopSessionRecording()`
+ - Stops/pauses the current session recording.
+
+> **Note:** Calling these methods will have no effect if session recordings are disabled in your PostHog [Project Settings](https://app.posthog.com/project/settings).
-Add `config.sessionReplay = true` to your PostHog configuration alongside any of your other configuration options:
+## Configuration options
```swift
let config = PostHogConfig(apiKey: "")
@@ -49,6 +81,5 @@ config.sessionReplayConfig.debouncerDelay = 1.0
- On iOS, minimum deployment target is [iOS13](/docs/libraries/ios)
- [SwiftUI](https://developer.apple.com/xcode/swiftui/) is only supported if the `screenshotMode` option is enabled.
- - `Text` views in SwiftUI are considered images, so they are masked unless `maskAllImages` is disabled.
- Custom views are not fully supported if `screenshotMode` is disabled.
- WebView is not supported. A placeholder will be shown.
diff --git a/contents/docs/session-replay/_snippets/react-native-installation.mdx b/contents/docs/session-replay/_snippets/react-native-installation.mdx
index 665c6bfa3cca..372c0d4c282e 100644
--- a/contents/docs/session-replay/_snippets/react-native-installation.mdx
+++ b/contents/docs/session-replay/_snippets/react-native-installation.mdx
@@ -8,6 +8,10 @@ title: React Native session replay
import ReactNativeInstall from "../../integrate/_snippets/install-react-native.mdx"
+export const EnableSessionReplayDark = "https://res.cloudinary.com/dmukukwp6/image/upload/posthog.com/contents/images/docs/session-replay/enable-session-replay-in-project-settings-dark-mode.png"
+export const EnableSessionReplayLight = "https://res.cloudinary.com/dmukukwp6/image/upload/posthog.com/contents/images/docs/session-replay/enable-session-replay-in-project-settings-light-mode.png"
+
+
> Requires PostHog React Native SDK version >= [3.2.0](https://github.com/PostHog/posthog-js-lite/releases), and it's recommended to always use the latest version.
@@ -20,7 +24,18 @@ yarn add posthog-react-native-session-replay
npm i -s posthog-react-native-session-replay
```
-## Step two: Configure replay settings
+## Step two: Enable session recordings in your project settings
+
+Enable session recordings in your PostHog [Project Settings](https://app.posthog.com/project/settings).
+
+
+
+## Step three: Configure replay settings
Add `enableSessionReplay: true` to your PostHog configuration alongside any of your other configuration options: