Smartlook

Android

iOS

React Native

Flutter

Ionic

Cordova

Unity

Unreal Engine

Cocos

Xamarin

Web
SDK Installation
AndroidiOSCocosCordovaFlutterIonicReact NativeUnityUnreal Engine 4Xamarin
SDK Conceptual
SDK API reference
SDK Cookbooks
SDK Integrations
REST API (beta)

Cocos SDK Installation

Android

  1. Add Smartlook in your app’s build.gradle:
implementation 'com.smartlook.recording:app:1.6.2-cocos'
  1. Add Smartlook Maven repository in your projects build.gradle:
allprojects {
repositories {
maven {
url "https://sdk.smartlook.com/android/release"
}
}
}

3.Setup and start Smartlook in onCreate() of your Application class:

javakotlin
public class AppActivity extends Cocos2dxActivity {
@Override
public void onCreate() {
...
// DO OTHER INITIALIZATION BELOW
Smartlook.setupAndStartRecording(YOUR_API_KEY);
}
}

To setup Smartlook, the unique project API key is needed. It can be found in the mobile project settings in Smartlook Dashboard.

  1. Smartlook now starts recording the app. The recordings will appear in the Smartlook player shortly.

SDK will upload sessions only on WiFi. When uploading on mobile connections is requested, it must be enabled in the project settings in the dashboard. More details about the recording process can be found in the Conceptual documentation.

iOS

  1. In projects that use Cocoapods, Smartlook can be installed by adding the respective pod into Podfile:
pod Smartlook

Smartlook can be also added directly to the app project by downloading the latest Smartlook iOS SDK, unzipping the file and adding Smartlook.framework to the Xcode project.

  1. To setup and start recording with Smartlook, Smartlook must be imported and configured e.g., in AppDelegate and its didFinishLaunching:
swiftobjective-c
import Smartlook
...
func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {
Smartlook.setup(key: "YOUR_API_KEY", options: [.useAdaptiveFramerate: false]))
Smartlook.startRecording()

To setup Smartlook, the unique project API key is needed. It can be found in the mobile project settings in Smartlook Dashboard.

To understand the adaptive framework option see Smartlook API reference.

  1. Smartlook now starts recording the app. The recordings will appear in the Smartlook player shortly.

SDK will upload sessions only on WiFi. When uploading on mobile connections is requested, it must be enabled in the project settings in the dashboard. More details about the recording process can be found in the Conceptual documentation.

Supported versions

Currently minimal supported Android version is Jelly Bean (API 18), however video is recorded only for API 24+, analytics events and other functionality is not limited. Current minimal supported iOS version is 10.

Further Steps

All Smartlook SDK methods are documented in the Smartlook API reference.

Some advanced use-case and troubleshooting case-studies are described in the Cookbooks section of this documentation.

Issues and bugs can be reported in the issue tracker.

Concepts undelying the Smartlook functionality are descibed in the Conceptual documentation: