Session replay

import 'package:nexus_flutter/nexus.dart';
import 'package:nexus_flutter/nexus_dio.dart'; // NexusDioInterceptor

NexusReplayCopy Anchor Link

Session replay. Captures the app as rrweb-compatible screenshot frames + pointer events via NexusReplayController (Flutter-side, all platforms) and ships them to /partner/replay, correlated to the session. Also accepts batches from a native recorder if one is present (future native SDKs).

isRecordingCopy Anchor Link

bool get isRecording

controllerCopy Anchor Link

NexusReplayController get controller

The Flutter capture engine — used by NexusScope to install the RepaintBoundary and forward pointer events. Internal.

start()Copy Anchor Link

Future<void> start()

Start capturing the session.

stop()Copy Anchor Link

Future<void> stop()

Stop capturing and flush any buffered events.

pause()Copy Anchor Link

void pause()

Pause/resume capture (called around app background/foreground).

resume()Copy Anchor Link

void resume()

trackScreen()Copy Anchor Link

void trackScreen(String name)

Record a page/route change (populates the player's Pages tab). Usually wired automatically via NexusNavigatorObserver; call manually for custom navigation. No-op when replay is disabled.

Parameters

observeRouter()Copy Anchor Link

void observeRouter(Listenable router, String Function() currentPath)

Track navigation from a Listenable router + a current-path getter — e.g. GoRouter (catches shell/nested routes a root observer misses):

nexus.replay.observeRouter(
  appRouter.routerDelegate,
  () => appRouter.routerDelegate.currentConfiguration.uri.path,
);

Parameters

recordNetwork()Copy Anchor Link

void recordNetwork({required String url, required String method, required int status, required int durationMs, int? size})

Record a network request for the player's Network tab — feed this from your HTTP client's interceptor (e.g. a Dio interceptor). No-op unless recording.

Parameters

flush()Copy Anchor Link

Future<void> flush()

dispose()Copy Anchor Link

void dispose()

NexusMaskCopy Anchor Link

class NexusMask extends StatefulWidget

Redact a widget from session replay. The wrapped subtree renders normally to the user, but its on-screen area is painted over with a solid block in every captured replay frame — so sensitive pixels (card numbers, tokens, PII) never leave the device.

NexusMask(child: Text(order.cardNumber))

NexusMaskCopy Anchor Link

const NexusMask({super.key, required this.child})

Parameters

childCopy Anchor Link

final Widget child

NexusNavigatorObserverCopy Anchor Link

class NexusNavigatorObserver extends NavigatorObserver

Reports route changes to Nexus so session replay's Pages tab shows the screens a user moved through. Add it to your app's navigator:

MaterialApp(
  navigatorObservers: [NexusNavigatorObserver()],
  ...
)

Uses each route's settings.name, so name your routes (or push with RouteSettings(name: ...)); unnamed routes fall back to a generic label. For custom navigation, call context.nexus.trackScreen('...') directly.

didPush()Copy Anchor Link

void didPush(Route<dynamic> route, Route<dynamic>? previousRoute)

Parameters

didReplace()Copy Anchor Link

void didReplace({Route<dynamic>? newRoute, Route<dynamic>? oldRoute})

Parameters

didPop()Copy Anchor Link

void didPop(Route<dynamic> route, Route<dynamic>? previousRoute)

Parameters

NexusDioInterceptorCopy Anchor Link

class NexusDioInterceptor extends Interceptor

A Dio interceptor that feeds every request into session replay's Network tab — method, URL, status, duration and response size.

import 'package:nexus_flutter/nexus_dio.dart';

dio.interceptors.add(NexusDioInterceptor());

A no-op until Nexus is initialised and replay is recording. Add it last so it observes the final request/response (after your auth/retry interceptors).

onRequest()Copy Anchor Link

void onRequest(RequestOptions options, RequestInterceptorHandler handler)

Parameters

onResponse()Copy Anchor Link

void onResponse(Response<dynamic> response, ResponseInterceptorHandler handler)

Parameters

onError()Copy Anchor Link

void onError(DioException err, ErrorInterceptorHandler handler)

Parameters