Rendering

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

Set rendering mode

A rendering mode can be set on SDK setup, e.g.:

Smartlook.setup(key: API_KEY, options: [.renderingMode: Smartlook.RenderingMode.wireframe])

[Smartlook setupWithKey:@"API_KEY" options:@{ SLSetupOptionRenderingModeOptionsKey: SLRenderingModeOptionBlueprintWireframe }];

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

class func setRenderingMode(to renderingMode: Smartlook.RenderingMode)

+ (void)setRenderingModeTo:(nonnull SLRenderingMode)renderingMode;

Rendering modes available are following:

Smartlook.RenderingMode.native
Smartlook.RenderingMode.wireframe
Smartlook.RenderingMode.noRendering

SLRenderingMode const SLRenderingModeNative;
SLRenderingMode const SLRenderingModeWireframe;
SLRenderingMode const SLRenderingModeNoRendering;

📘
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:

class func currentRenderingMode() -> RenderingMode

+ (_Nonnull SLRenderingMode)currentRenderingMode;

Set rendering mode option

WIREFRAME rendering mode can be further configured by renderingModeOption.

The rendering mode option can be set on setup:

class func Smartlook.setup(
  key: String, 
  options: [
    .renderingMode: Smartlook.RenderingMode,
    .renderingModeOption: Smartlook.RenderingModeOption
  ]
)

+(void)setupWithKey:(nonnull NSString *)key
            options:@{
              SLSetupOptionRenderingModeKey:SLRenderingMode,
              SLSetupOptionRenderingModeOptionsKey:SLRenderingModeOption
            };

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

class func setRenderingMode(to renderingMode: Smartlook.RenderingMode,
                            option renderingModeOption: Smartlook.RenderingModeOption?)

+ (void)setRenderingModeTo:(nonnull SLRenderingMode)renderingMode
                withOption:(nullable SLRenderingModeOption)renderingModeOption

Rendering mode options for WIREFRAME rendering mode are following:

Smartlook.RenderingModeOption.none
Smartlook.RenderingModeOption.colorWireframe
Smartlook.RenderingModeOption.blueprintWireframe
Smartlook.RenderingModeOption.iconBlueprintWireframe

SLRenderingModeOption const SLRenderingModeOptionNone;
SLRenderingModeOption const SLRenderingModeOptionColorWireframe;
SLRenderingModeOption const SLRenderingModeOptionBlueprintWireframe;
SLRenderingModeOption const SLRenderingModeOptionIconBlueprintWireframe;

Current rendering mode option

Currently active rendering mode option can be obtained by calling:

class func currentRenderingModeOption() -> RenderingModeOption?

+ (_Nullable SLRenderingModeOption)currentRenderingModeOption;