ConnectionCheck class

Utility to diagnose connection issues with a LiveKit server, a Dart port of the ConnectionCheck helper from client-sdk-js.

Run it proactively (e.g. at app start) or reactively when connecting to a room fails, to determine why a connection cannot be established (firewall, VPN, blocked TURN, etc.).

final connectionCheck = ConnectionCheck(url, token);
final listener = connectionCheck.createListener();
listener.on<ConnectionCheckUpdateEvent>((event) {
  print('check ${event.info.name}: ${event.info.status}');
});

// the recommended minimum set of checks
await connectionCheck.checkWebsocket();
await connectionCheck.checkWebRTC();
await connectionCheck.checkTURN();

print('all checks passed: ${connectionCheck.isSuccess}');
await listener.dispose();
await connectionCheck.dispose();

Each check connects to the server independently and returns a CheckInfo describing the outcome. checkPublishAudio, checkPublishVideo and checkConnectionProtocol capture from the microphone/camera and therefore require the corresponding permissions to be granted beforehand.