Skip to main content

Configuration

Launching with options

warning

iOS/iPadOS: Since v7.0.0 the underlying Bugsee iOS SDK supports the simulator; crash capture is excluded. For full functionality, launch your app with Bugsee on a real device.

Bugsee behavior is very customizable. If the default configuration does not satisfy your needs, you can launch the SDK with additional parameters. Use an instance of IOSLaunchOptions or AndroidLaunchOptions for the corresponding platform to change Bugsee behavior.

var bugseeOptions = new Bugsee.IOSLaunchOptions();

bugseeOptions.shakeToReport = true;
bugseeOptions.reportPrioritySelector = true;
bugseeOptions.defaultBugPriority = Bugsee.BugseeSeverityLevel.Critical;

Bugsee.launch("<your token>", bugseeOptions);

Available Options

For iOS

KeyDefaultNotes
captureDeviceAndNetworkNamestrueCapture device name, wifi SSID and mobile carrier name.
captureLogstrueAutomatically capture all console logs
crashReporttrueCatch and report application crashes (*)
defaultBugPriorityLowDefault priority for bugs
defaultCrashPriorityBlockerDefault priority for crashes
killDetectionfalseDetect abnormal termination (experimental, read more)
maxRecordingTime60Maximum recording duration
monitorNetworktrueCapture network traffic
reportPrioritySelectorfalseAllow user to modify priority when reporting manual
screenshotToReporttrueScreenshot key to trigger report
shakeToReportfalseShake gesture to trigger report
styleDefaultEnumeration of Default, Dark and BasedOnStatusBar
videoEnabledtrueEnable video recording
frameRateHighSpecifies how often frames are captured
screenshotEnabledtrueAttach screenshot to a report
wifiOnlyUploadfalseUpload reports only when a device is connected to a WiFi network
maxDataSize50Bugsee will avoid using more disk space than specified (in MB). If total Bugsee data size exceeds specified value, oldest recordings (even not sent) will be removed. Value should not be smaller than 10
warning
  • iOS allows only one crash detector to be active at a time. If you insist on using an alternative solution for handling crashes, you might want to use this option and disable Bugsee from taking over.

For Android

KeyDefaultNotes
captureDeviceAndNetworkNamestrueCapture device name, wifi SSID and mobile carrier name.
captureLogstrueAutomatically capture all console logs
crashReporttrueCatch and report application crashes
defaultBugPriorityLowDefault priority for bugs
defaultCrashPriorityBlockerDefault priority for crashes
extendedVideoModetrueEnables or disables the use of MediaProjection API (**)
frameRateHighSpecifies how often frames are captured
logLevelVerboseMinimal log level of Logcat messages, which will be attached to report
maxDataSize50Maximum disk space consumed by Bugsee
maxRecordingTime60Maximum recording duration
monitorNetworktrueCapture network traffic
notificationBarTriggertrueTrigger report from notification bar
reportPrioritySelectorfalseAllow user to modify priority when reporting manual
screenshotEnabledtrueAttach screenshot to a report
serviceModefalseUsed, when Bugsee is launched from service. No video and no visual controls available. Recording continues even in background.
shakeToReportfalseShake gesture to trigger report
videoEnabledtrueEnable video recording
wifiOnlyUploadfalseUpload reports only when a device is connected to a WiFi network
warning

** If extendedVideoMode is set to true, the MediaProjection API is used while recording video. In this case, all types of views are recorded, but the user is asked to allow video recording. If false (experimental), the view drawing cache is used to capture the screen. In this case, the user is not asked to allow video recording, but the frame rate is lower and some special views like the status bar, soft keyboard, and views that contain Surface (MapView, VideoView, GlSurfaceView, etc.) are not recorded. This option has no effect if the VideoEnabled option is set to false.

Stop, Relaunch

It is also possible to relaunch Bugsee with other options later.

// Relaunch with other options.
var options = new Bugsee.IOSLaunchOptions();

// Set other launch options
//...

Bugsee.relaunch(options);

Alternatively, you can stop the events and video recording.

// Stop recording completely
Bugsee.stop()