API Reference

This page covers the main public entry points used during setup.

Android

Start

Snapbug.start(this)

Start with configuration

Snapbug.start(this) {
    crashReporter { catchFatalErrors = true }
    debugFeedback { screenNameProvider = { "Home" } }
}

Runtime connection updates

snapbug.updateServerHost("192.168.1.10")
snapbug.updateRelay(
    relayHost = "license.snapbug.ai",
    roomCode = "123456"
)

Connection state

The SDK exposes a connection state flow with:

  • Disconnected
  • Connecting
  • Connected(viaRelay, viaWebRtc)
  • Error(message)

Flutter

Start

await Snapbug.start();

Start with explicit plugins

await Snapbug.start(
  plugins: [SnapbugNetwork()],
);

Bridge helpers

await Snapbug.sendMessage(
  plugin: "network",
  method: "request",
  body: "{}",
);
 
await Snapbug.updateServerHost("192.168.1.10");

React Native

Start

Snapbug.start();

Start with explicit plugins

Snapbug.start({
  plugins: [new SnapbugNetwork()],
});

Bridge helpers

Snapbug.sendMessage("network", "request", "{}");
Snapbug.updateServerHost("192.168.1.10");

Notes

  • The preferred user-facing transport is the Chrome Extension room-code flow.
  • updateServerHost(...) is mainly for legacy localhost or direct host-based scenarios.
  • The local service is optional and adds AI workflows on top of the main inspection flow.