このメソッドはトラッカーを開始するために使用します。トラッカーを開始すると、セッションの録画が始まります。

Future<void> OpenReplay.instance.start({
  required String projectKey,
  OROptions options = OROptions.defaults,
  String? serverUrl,
})

• projectKey: String: OpenReplay ダッシュボードの ‘Preferences > Projects’ にあります。
• options: OROptions: トラッカーが取得する内容。後述します。
• serverUrl: String?: セルフホストのデプロイ用のインジェストエンドポイント。OpenReplay Cloud では省略してください。

利用可能なオプション:

• crashes: bool Dart のエラーを取得します。
• analytics: bool タッチ、スワイプ、画面、入力を取得します。
• performances: bool CPU、メモリ、バッテリー、サーマル状態を取得します。
• logs: bool debugPrint の出力を取得します。
• screen: bool フレームのキャプチャを有効にします。
• screenshotBatchSize: ScreenshotBatchSize 1 回のアップロードあたりのフレーム数。low（10）、normal（20）、high（30）。デフォルト: normal。
• targetLongEdge: int キャプチャされるフレームの長辺の長さ（ピクセル単位）。デフォルト: 720。
• dedupeFrames: bool 直前のフレームと同一のフレームをスキップします。
• maskPlatformViews: bool WebView、マップ、カメラプレビューをプレースホルダーで覆います。
• wifiOnly: bool 予約済み。まだ適用されません。
• debugLogs: bool / debugImages: bool SDK 自体のデバッグ出力。デフォルト: false。

デフォルト: debugLogs と debugImages を除くすべてのブール値が true です。各オプションの詳細な説明については、初期化をご覧ください。

フレームレートと画像品質は、これらのオプションではなく、プロジェクト設定から取得されます。

セッションを作成せずにローリングバッファへ記録し、後のトリガーで直前の数秒分を送信できるようにするには、coldStart() で開始し、triggerRecording() で昇格させます。

await OpenReplay.instance.coldStart(projectKey: 'YOUR_PROJECT_KEY');

// later, when something worth recording happens
await OpenReplay.instance.triggerRecording(condition: 'checkout_error');

サーバー側での条件評価は、Flutter SDK ではまだ利用できません。ご自身のコードから triggerRecording() を呼び出してください。

このプロセスについてご不明な点がございましたら、お気軽に Slack までお問い合わせください。