UXCam Flutter SDK Installation & Quick Start

npm version


Minimum Flutter Requirements:

  • sdk: '>=2.12.0 <4.0.0'
  • flutter: '>=1.10.0'

Follow the instructions below for the integration on iOS and Android

SDK Integration

Use this package as library

  1. Add the uxcam package to your flutter app:
flutter pub add flutter_uxcam
  1. This will add a line similar to this to your package's pubspec.yaml file
  flutter_uxcam: ^2.5.2
  1. Inside your dart file import flutter_uxcam like this:
import 'package:flutter_uxcam/flutter_uxcam.dart';
  1. Then inside the first method that gets called add the following code snippets; most likely inside the class of lib/main.dart file that's getting called by this void main() => runApp(MyApp()); where MyApp is the name of your class. FlutterUxConfig config = FlutterUxConfig(userAppKey: "UXCAM_APP_KEY"); FlutterUxcam.startWithConfiguration(config);
import 'package:flutter_uxcam/flutter_uxcam.dart';
void main() => runApp(MyApp());

class MyApp extends StatelessWidget {
  // This widget is the root of your application.
  Widget build(BuildContext context) {
    FlutterUxcam.optIntoSchematicRecordings(); // Confirm that you have user permission for screen recording
    FlutterUxConfig config = FlutterUxConfig(
      userAppKey: "UXCAM_APP_KEY",
      enableAutomaticScreenNameTagging: false);
    return MaterialApp(
      title: 'Flutter Demo',
      theme: ThemeData(
        primarySwatch: Colors.blue,
      home: MyHomePage(title: 'Flutter Demo Home Page'),
  1. If you get this error while running in iOS:

Error output from CocoaPods: ↳

[!] Automatically assigning platform ios with version 8.0 on target Runner because no platform was specified. Please specify a platform for this target in your > > Podfile. See https://guides.cocoapods.org/syntax/podfile.html#platform.

Then inside ios folder in pod file uncomment this line # platform :ios, '10.0' that means removing #.


SDK Updates

To check all the information on the fixes and improvements on the latest versions of the SDK, please visit this page.

Video Tutorial

What’s Next