diff --git a/README.md b/README.md index d2c6e8ba..b8ad1219 100644 --- a/README.md +++ b/README.md @@ -13,7 +13,9 @@ # LiveKit Flutter SDK + Use this SDK to add real-time video, audio and data features to your Flutter app. By connecting to a self- or cloud-hosted LiveKit server, you can quickly build applications like interactive live streaming or video calls with just a few lines of code. + This package is published to pub.dev as [livekit_client](https://pub.dev/packages/livekit_client). @@ -22,25 +24,20 @@ This package is published to pub.dev as [livekit_client](https://pub.dev/package More Docs and guides are available at [https://docs.livekit.io](https://docs.livekit.io) -## Current supported features - -| Feature | Subscribe/Publish | Simulcast | Background audio | Screen sharing | End to End Encryption | Multi Codec Simulcast | -| :-----: | :---------------: | :-------: | :--------------: | :------------: | :-------------------: | :-------------------: | -| iOS | 馃煝 | 馃煝 | 馃煝 | 馃煝 | 馃煝 | 馃煝 | -| Android | 馃煝 | 馃煝 | 馃煝 | 馃煝 | 馃煝 | 馃煝 | -| Mac | 馃煝 | 馃煝 | 馃煝 | 馃煝 | 馃煝 | 馃煝 | -| Windows | 馃煝 | 馃煝 | 馃煝 | 馃煝 | 馃煝 | 馃煝 | -| Linux | 馃煝 | 馃煝 | 馃煝 | 馃煝 | 馃煝 | 馃煝 | +## Supported platforms -馃煝 = Available +LiveKit client SDK for Flutter is designed to work across all platforms supported by Flutter: -馃煛 = Coming soon (Work in progress) - -馃敶 = Not currently available (Possibly in the future) +- Android +- iOS +- Web +- macOS +- Windows +- Linux ## Example app -We built a multi-user conferencing app as an example in the [example/](example/) folder. You can join the same room from any supported LiveKit clients. +We built a multi-user conferencing app as an example in the [example/](example/) folder. LiveKit is compatible cross-platform: you could join the same room using any of our supported realtime SDKs. Online demo: https://livekit.github.io/client-sdk-flutter/ @@ -155,7 +152,7 @@ void main() async { #### Audio Modes -By default, we use the `communication` audio mode on Android which works best for two-way voice communication. +By default, we use the `communication` audio mode on Android which works best for two-way voice communication. If your app is media playback oriented and does not need the use of the device's microphone, you can use the `media` audio mode which will provide better audio quality. @@ -493,7 +490,9 @@ Apache License 2.0 A huge thank you to [flutter-webrtc](https://github.com/flutter-webrtc/flutter-webrtc) for making it possible to use WebRTC in Flutter. +
+
LiveKit Ecosystem
Real-time SDKsReact ComponentsBrowseriOS/macOSAndroidFlutterReact NativeRustNode.jsPythonUnity (web)Unity (beta)