Flutter SDK - метод start
Этот метод используется для запуска трекера. При запуске трекера начинается запись сессии.
Сигнатура
Section titled СигнатураFuture<void> OpenReplay.instance.start({
required String projectKey,
OROptions options = OROptions.defaults,
String? serverUrl,
})
Параметры
Section titled ПараметрыprojectKey: String: Находится в панели управления OpenReplay в разделе ‘Preferences > Projects’.options: OROptions: Что фиксирует трекер, см. ниже.serverUrl: String?: Ingest-эндпоинт для self-hosted развёртываний. Не указывайте его в OpenReplay Cloud.
Параметры инициализации
Section titled Параметры инициализацииДоступные параметры:
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.
По умолчанию: все логические параметры равны true, кроме debugLogs и debugImages. Полное описание каждого из них см. в разделе инициализация.
Частота кадров и качество изображения берутся из настроек вашего проекта, а не из этих параметров.
Буферизованный запуск
Section titled Буферизованный запускЧтобы записывать в кольцевой буфер без создания сессии — так, чтобы последующий триггер мог отправить предшествующие секунды, — запустите трекер с помощью 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() из собственного кода.
Остались вопросы?
Section titled Остались вопросы?Если у вас есть какие-либо вопросы об этом процессе, не стесняйтесь обращаться к нам в нашем Slack или загляните на наш Форум.