Flutter SDK - start 메서드

OpenReplay Flutter SDK의 'start' 메서드에 대한 자세한 설명

Flutter SDK ⁠-⁠ start 메서드

이 메서드는 트래커를 시작하는 데 사용합니다. 트래커를 시작하면 세션 녹화가 시작됩니다.

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 업로드당 프레임 수로, 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으로 문의해 주세요.