Help centerWeb SDKIntegrationsRest API
API Reference
Go to Smartlook
Start typing to search…

Rendering

SDK can use different methods of capturing screen image data. These are called rendering modes.

Set rendering mode

A rendering mode can be changed on SDK setup using builder:

val options = Smartlook.SetupOptionsBuilder(API_KEY)
        .setRenderingMode(renderingMode: RenderingMode)
        .build()

Smartlook.setupAndStartRecording(options)
Smartlook.SetupOptionsBuilder setupOptionsBuilder = new Smartlook.SetupOptionsBuilder(API_KEY)
        .setRenderingMode(RenderingMode renderingMode);

Smartlook.setupAndStartRecording(setupOptionsBuilder.build());

Or at anytime during an application run by using thew following:

Smartlook.setRenderingMode(renderingMode: RenderingMode)
Smartlook.setRenderingMode(RenderingMode renderingMode);

Rendering modes available are following:

  • RenderingMode.NATIVE
  • RenderingMode.WIREFRAME
  • RenderingMode.NO_RENDERING
📘

NO_RENDERING mode does not record any screen data, this is beneficial on screens that include sensitive data, read more.

Current rendering mode

Currently active rendering mode can be obtained by calling:

Smartlook.currentRenderingMode()
Smartlook.currentRenderingMode();

Set rendering mode option

WIREFRAME rendering mode can be further configured by renderingModeOption.

The rendering mode option can be set on setup:

val options = Smartlook.SetupOptionsBuilder(API_KEY)
        .setRenderingMode(RenderingMode.WIREFRAME)
        .setRenderingModeOption(renderingModeOption: RenderingModeOption)
        .build()

Smartlook.setupAndStartRecording(options)
Smartlook.SetupOptionsBuilder setupOptionsBuilder = new Smartlook.SetupOptionsBuilder(API_KEY)
        .setRenderingMode(RenderingMode.WIREFRAME)
        .setRenderingModeOption(RenderingModeOption renderingModeOption);

Smartlook.setupAndStartRecording(setupOptionsBuilder.build());

Or at anytime during an application run by using the following:

Smartlook.setRenderingMode(RenderingMode.WIREFRAME, renderingModeOption: RenderingModeOption)
Smartlook.setRenderingMode(RenderingMode.WIREFRAME, RenderingModeOption renderingModeOption);

Rendering mode options for WIREFRAME rendering mode are following:

  • RenderingMode.WIREFRAME
  • RenderingMode.BLUEPRINT
  • RenderingMode.ICON_BLUEPRINT

Current rendering mode option

Currently active rendering mode option can be obtained by calling:

Smartlook.currentRenderingModeOption()
Smartlook.currentRenderingModeOption();