Flutter session replay docs omit startSessionRecording / stopSessionRecording / isSessionReplayActive

Which page

https://posthog.com/docs/session-replay/installation/flutter

Problem

The Flutter session replay page documents only the config options — sessionReplay, maskAllTexts, maskAllImages, throttleDelay — and gives no indication that replay can be started or stopped at runtime. Reading it, the reasonable conclusion is that control is limited to initial configuration plus the project-level toggle.

posthog_flutter 5.39.0 in fact exposes three public methods that are not mentioned anywhere on the page:

Future<void> startSessionRecording({bool resumeCurrent = true});
Future<void> stopSessionRecording();
Future<bool> isSessionReplayActive();

Why this gap matters

The privacy docs recommend, for sensitive screens:

you can manually stop and start session recordings

So the recommended approach for the highest-risk case is undocumented on Flutter. Anyone following the Flutter installation page alone has no way to discover it.

It matters more on Flutter than elsewhere, because masking cannot cover every case. For PIN, passcode and card-number entry on a keypad, tap coordinates reconstruct the value regardless of masking (see #570), so stop/start is the only available mitigation — and it isn't in the docs. We found these methods by reading the package source after concluding, from the documentation, that no such API existed.

Suggested fix

Add a short section to the Flutter installation page covering the three methods, with a note on resumeCurrent (continue the existing session vs. start a new one), and a pointer from the privacy page's "manually stop and start session recordings" line to a concrete Flutter example — e.g. stopping capture while a PIN screen is mounted and resuming on dispose.

Environment

• posthog_flutter 5.39.0

Start with the Flutter session replay installation page and compare it with the posthog_flutter 5.39.0 API described in the issue. Document startSessionRecording, stopSessionRecording, isSessionReplayActive, and resumeCurrent, then add a pointer from the privacy page with a PIN-screen example. Done means both pages explain runtime recording control for Flutter.