Skip to content

docs(unreal): Remove legacy Session Replay attachment mentions #18810

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
tustanivsky merged 1 commit into from
Jul 23, 2026
Merged

docs(unreal): Remove legacy Session Replay attachment mentions #18810

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions docs/platforms/unreal/session-replay/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,14 +47,14 @@ AttachSessionReplay=True
The following settings are available under the **Session Replay** section in the plugin settings:

- **Enable session replay (experimental)** (`AttachSessionReplay`, default `False`) — Master toggle for the feature.
- **Replay duration (ms)** (`SessionReplayDurationMs`, default `5000`, range `1000`–`20000`) — The requested length of the retroactive replay window. On Windows, Linux, macOS, and iOS this is the rolling clip length kept on disk for crash attachment; on Xbox it's the requested length of the OS-captured clip (which may be shorter if not enough frames are buffered). This value is ignored on Android, where the underlying SDK determines the duration.
- **Replay duration (ms)** (`SessionReplayDurationMs`, default `5000`, range `1000`–`20000`) — The requested length of the retroactive replay window. On Windows, Linux, macOS, and iOS this is the rolling clip length kept on disk for the crash replay; on Xbox it's the requested length of the OS-captured clip (which may be shorter if not enough frames are buffered). This value is ignored on Android, where the underlying SDK determines the duration.

### Advanced Recording Options (Windows, Linux, macOS & iOS)

The **Advanced recording options** group (`SessionReplayOptions`) provides low-level encoder and muxer tuning for the desktop and iOS recorders. The defaults are sensible for most projects.

- **Fragment duration (seconds)** (`FragmentSeconds`, default `0.5`, range `0.1`–`2.0`) — Length of each video fragment. Shorter values reduce the worst-case amount of footage lost at crash time, but increase keyframe frequency and lower compression efficiency.
- **Rotation interval (seconds)** (`RotationIntervalSeconds`, default `1.0`, range `0.25`–`5.0`) — How often the on-disk attachment file is refreshed.
- **Rotation interval (seconds)** (`RotationIntervalSeconds`, default `1.0`, range `0.25`–`5.0`) — How often the on-disk replay clip is refreshed.
- **Target framerate** (`Framerate`, default `30`, range `10`–`60`) — Capture framerate. The game can render faster; frames are sampled down to this rate.
- **Target bitrate (kbps)** (`BitrateKbps`, default `2000`, range `200`–`20000`) — Encoder target bitrate.

Expand Down Expand Up @@ -91,7 +91,7 @@ On desktop platforms, Session Replay continuously encodes the game's backbuffer

<Alert>

The most recent fraction of a second of footage (up to one fragment duration) may be missing from the attached clip, since the fragment being encoded at the moment of the crash isn't yet finalized.
The most recent fraction of a second of footage (up to one fragment duration) may be missing from the recorded clip, since the fragment being encoded at the moment of the crash isn't yet finalized.

</Alert>

Expand Down
Loading