Reading the repo
Opening the box…
Reading the repo
Opening the box…
How to install on Windows
Flutter Client SDK for LiveKit
Saved setup from 8 h ago
Will it work on Windows?
make (e.g. winget install GnuWin32.Make) or WSL.LiveKit client SDK for Flutter is designed to work across all platforms supported by Flutter:
The maintainers included bootstrap.sh. Run it from the cloned folder after reading it.
bash bootstrap.sh
Then run powershell -ExecutionPolicy Bypass -File .\setup.ps1. It stops at the first error and is safe to run again. Servers and tests aren't started; it lists them at the end. Read it first.
Compare yours with the README's “Supported platforms” list above before installing anything.
Needs Git: winget install Git.Git
git clone https://github.com/livekit/client-sdk-flutter.git cd client-sdk-flutter
Flutter >=3.10.0 <4.0.0
# Install Flutter: https://docs.flutter.dev/get-started/install/windows
flutter pub get
flutter run
flutter test
Makefile targets need make (e.g. winget install GnuWin32.Make) or WSL.
final roomOptions = RoomOptions(
adaptiveStream: true,
dynacast: true,
// ... your room options
)
final room = Room();
// you can use `prepareConnection` to speed up connection.
await room.prepareConnection(url, token);
await room.connect(url, token, roomOptions: roomOptions);
try {
// video will fail when running in ios simulator
await room.localParticipant.setCameraEnabled(true);
} catch (error) {
print('Could not publish video, error: $error');
}
await room.localParticipant.setMicrophoneEnabled(true);
Certificate pinning is available for native platforms through RoomOptions.networkOptions. It applies to SDK-owned WSS signaling and internal HTTPS requests. It does not apply to WebRTC media, TURN, or application-owned token endpoints.
Certificate pinning is not supported on Flutter web because browsers do not expose certificate material to application code. Configuring it on web is treated as a misconfiguration and fails fast: Room.connect throws UnsupportedError instead of silently connecting without pinning. Only enable certificatePinning on web builds if you want that behavior, otherwise leave it unset when targeting web.
On native platforms, validation runs during TLS connection setup after the peer certificate is available and before the SDK writes HTTP or WSS request bytes. If validation fails, request headers and bodies are not sent.
Rules are selected by host. Exact hosts like project.livekit.cloud, single-label wildcards like *.livekit.cloud, multi-label wildcards like **.livekit.cloud, and * are supported. *.livekit.cloud matches project.livekit.cloud, but not a.b.livekit.cloud. **.livekit.cloud matches both. Rules with empty hosts apply to every SDK-owned TLS connection.
Hosts that match no rule are connected with platform trust only, and the SDK logs a warning. Keep in mind the SDK also connects to hosts you did not write yourself: LiveKit Cloud region failover uses server-provided regional hostnames like project.region.production.livekit.cloud, which carry more labels than your project URL. Use **.livekit.cloud so pinning also covers those hosts, and make sure the pin set includes the keys the regional endpoints serve.
All rules that match the connection host are applied. Within one check type, any configured value may match. Across check types, each configured type must pass. For example, two matching SPKI rules are treated as one accepted pin set, while SPKI pins plus exact leaf certificates require both the SPKI check and the exact leaf certificate check to pass.
Use SPKI SHA-256 pins when possible. primaryPins and backupPins are both accepted. Backup pins are useful for certificate rotation because the SDK accepts either set.
SPKI pins are matched against the leaf certificate's public key only. Unlike OkHttp or HPKP, the rest of the chain is not checked because Dart does not expose it, so pinning an intermediate or root CA key never matches and fails every connection. Pin leaf keys, and use backup pins for the future leaf keys you plan to rotate to.
final roomOptions = RoomOptions(
networkOptions: NetworkOptions(
certificatePinning: CertificatePinningOptions(
rules: [
CertificatePinningRule(
hosts: ['**.livekit.cloud'],
primaryPins: ['sha256/current-public-key-pin'],
backupPins: [
'sha256/next-public-key-pin-1',
'sha256/next-public-key-pin-2',
],
),
],
),
),
);
final room = Room(roomOptions: roomOptions);
await room.connect(url, token);
To generate an SPKI pin:
openssl s_client -connect your-host:443 -servername your-host </dev/null 2>/dev/null \
| openssl x509 -pubkey -noout \
| openssl pkey -pubin -outform der \
| openssl dgst -sha256 -binary \
| openssl base64
Prefix the output with sha256/ before passing it to primaryPins or backupPins.
Certificate rules can also enforce exact leaf certificates or a custom TLS trust store.
Use pinnedLeafCertificates to require an exact peer leaf certificate after TLS trust validation succeeds. Renewing or changing the leaf certificate requires shipping updated pinned certificates.
By itself, pinnedLeafCertificates does not trust private or self-signed certificates. For private PKI, also configure trustedCertificates with the leaf, intermediate, or root certificate that should anchor TLS validation.
final certificate = await CertificateBytes.fromAsset(
'assets/livekit_leaf_cert.pem',
);
final roomOptions = RoomOptions(
networkOptions: NetworkOptions(
certificatePinning: CertificatePinningOptions(
rules: [
CertificatePinningRule(
hosts: ['my-project.livekit.cloud'],
pinnedLeafCertificates: [certificate],
trustedCertificates: [certificate],
),
],
),
),
);
Use `trustedCertifi
…
No reports for Windows yet.
GitManual AI Agent reads the 8 key files and writes a step-by-step guide for Windows. Once written, it's saved for everyone.