Flutter音频追踪插件opus_tracking的使用

安装

在你的pubspec.yaml文件中添加以下依赖：

dependencies:
  opus_tracking: ^0.1.5

使用

配置

首先，在需要使用该库的地方导入包：

import 'package:opus_tracking/opus_tracking.dart';

接着，创建全局的EventClient对象，并设置必要的参数：

EventClient eventClient = EventTrackingFactory.create(
  tenantId: 'your-tenant-id',
  apiKey: 'your-api-key',
  source: 'your-application-source',
  apiDomain: 'your-api-domain'
);

在导航到其他屏幕时，请调用以下方法：

eventClient.addScreenName(
  IScreen(
    uiKey: generateRandomString(10),
    name: 'your-screen-name'
  )
);

如果返回上一个屏幕，请调用：

eventClient.removeScreenName();

其他功能

你也可以使用自定义配置来初始化EventClient：

EventClient eventClient = EventTrackingFactory.create(
  tenantId: 'your-tenant-id',
  apiKey: 'your-api-key',
  config: {
    'common_properties': {
      'user_id': 'user_id',
    },
    'source': 'source',
  }
);

此外，你可以自定义跟踪事件的一些参数：

eventClient.setApiDomain('your-api-domain');
eventClient.setApiKey('your-api-key');
eventClient.setBasicInfo({
  'domain': 'your-domain'
});
eventClient.setIsAuthenticated(true);

跟踪事件

点击跟踪

IClickParams params = IClickParams(additionalData: {});
eventClient.logClickEvent('your-button-ui-key', params: params);

屏幕跟踪

IScreenParams params = IScreenParams(additionalData: {});
eventClient.logScreenEvent('screen-name', params: params);

行为跟踪

dynamic params = {};
eventClient.logBehaviourEvent('behavior-name', params: params);

异常处理

确保不要将tenantId、apiKey、apiDomain和source设置为空字符串。否则会抛出异常。

示例代码

以下是完整的示例代码：

import 'package:flutter/material.dart';
import 'package:opus_tracking/opus_tracking.dart';

void main() {
  runApp(const MyApp());
}

class MyApp extends StatelessWidget {
  const MyApp({super.key});

  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'Flutter Demo',
      theme: ThemeData(
        colorScheme: ColorScheme.fromSeed(seedColor: Colors.deepPurple),
        useMaterial3: true,
      ),
      home: const MyHomePage(title: 'Flutter Demo Home Page'),
    );
  }
}

class MyHomePage extends StatefulWidget {
  const MyHomePage({super.key, required this.title});

  final String title;

  [@override](/user/override)
  State<MyHomePage> createState() => _MyHomePageState();
}

class _MyHomePageState extends State<MyHomePage> {
  int _counter = 0;
  late final EventClient _eventClient;

  [@override](/user/override)
  void initState() {
    super.initState();

    // 初始化EventClient
    EventClient eventClient = EventTrackingFactory.create(
        tenantId: 'your-tenant-id',
        apiKey: 'your-api-key',
        source: 'your-application-source',
        apiDomain: 'your-api-domain');

    // 添加屏幕名称
    eventClient.addScreenName(IScreen(uiKey: generateRandomString(10), name: 'home'));

    setState(() {
      _eventClient = eventClient;
    });
  }

  void _incrementCounter() {
    IClickParams params = IClickParams(additionalData: {});
    _eventClient.logClickEvent('increment-counter-btn', params: params);

    setState(() {
      _counter++;
    });
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        backgroundColor: Theme.of(context).colorScheme.inversePrimary,
        title: Text(widget.title),
      ),
      body: Center(
        child: Column(
          mainAxisAlignment: MainAxisAlignment.center,
          children: [
            const Text(
              'You have pushed the button this many times:',
            ),
            Text(
              '$_counter',
              style: Theme.of(context).textTheme.headlineMedium,
            ),
            ElevatedButton(
                onPressed: () {
                  // 导航到凭证屏幕
                  eventClient.addScreenName(IScreen(
                      uiKey: generateRandomString(10), name: 'credential'));
                  IScreenParams params = IScreenParams(additionalData: {});
                  _eventClient.logScreenEvent('credential', params: params);
                },
                child: const Text('Go to screen credential')),
            ElevatedButton(
                onPressed: () {
                  // 返回到首页
                  eventClient.removeScreenName();
                  IScreenParams params = IScreenParams(additionalData: {});
                  _eventClient.logScreenEvent('home', params: params);
                },
                child: const Text('Go back to screen home')),
            ElevatedButton(
                onPressed: () {
                  dynamic params = {};
                  _eventClient.logBehaviourEvent('increment-counter-event', params: params);
                },
                child: const Text('Log behavior event'))
          ],
        ),
      ),
      floatingActionButton: FloatingActionButton(
        onPressed: _incrementCounter,
        tooltip: 'Increment',
        child: const Icon(Icons.add),
      ),
    );
  }
}