Lifecycle & Recording

📘

Wireframe rendering not supported

Currently, wireframe rendering is not supported for Flutter.

Setup & start recording

Pre API 2.0

final SetupOptions options = SetupOptionsBuilder('API_KEY').build();
 Smartlook.setupAndStartRecording(options);

API 2.0

There is no explicit setup() method. The SDK is set up automatically.

Also, recording can be started even though the project key is not set yet. The recorded data will not be sent out till the project key is set but will be stored for the "future" send.

This can be beneficial when the project key is fetched from a server. In this scenario, the recording can be started right away (on the application start). The recording will be complete, the upload of recorded data is just postponed for the moment when the project key is set.

Smartlook.instance.preference.setProjectKey('YOUR PROJECT KEY');
Smartlook.instance.start();

Start & stop recording documentation.

Start & stop recording

Pre API 2.0

Smartlook.startRecording();
Smartlook.stopRecording();

API 2.0

Smartlook.instance.start();
Smartlook.instance.stop();

Start & stop recording documentation.

Check if the SDK is recording

Pre API 2.0

Smartlook.isRecording();

API 2.0

final bool isRecording = await Smartlook.instance.state.status.isRecording();

Reset session/user

Pre API 2.0

// Reset session
Smartlook.resetSession(false);

// Reset session & user
Smartlook.resetSession(true);

API 2.0

// Open new session
Smartlook.instance.user.session.openNew();

// Open new session & user
Smartlook.instance.user.openNew();