HaishinKit Plugin

• A Flutter plugin for iOS, Android. Camera and Microphone streaming library via RTMP.

Note

This project is being developed with the goal of defining a Flutter interface for HaishinKit. However, since development is progressing slowly, I recommend using other plugins if you need something stable or are in a hurry.

	Android	iOS	macOS
Support	SDK 21+	iOS 15.0+	12.0+

💖 Sponsors

Do you need additional support? Technical support on Issues and Discussions is provided only to contributors and academic researchers of HaishinKit. By becoming a sponsor, we can provide the support you need.

Sponsor: $50 per month: Technical support via GitHub Issues/Discussions with priority response.

💬 Communication

• GitHub Issues and Discussions are open spaces for communication among users and are available to everyone as long as the code of conduct is followed.
• Whether someone is a contributor to HaishinKit is mainly determined by their GitHub profile icon. If you are using the default icon, there is a chance your input might be overlooked, so please consider setting a custom one. It could be a picture of your pet, for example. Personally, I like cats.
• If you want to support e-mail based communication without GitHub.
  • Consulting fee is $50/1 incident. I'm able to response a few days.

🎨 Features

• Protocols ✨Publish and playback feature are available RTMP.
• Multi Streaming ✨Allowing live streaming to separate services. Views also support this, enabling the verification of raw video data.
• Video mixing ✨Possible to display any text or bitmap on a video during broadcasting or viewing. This allows for various applications such as watermarking and time display.

🌏 Dependencies

Project name	Notes	License
HaishinKit for iOS, macOS and tvOS.	Camera and Microphone streaming library via RTMP, HLS for iOS, macOS and tvOS.	BSD 3-Clause "New" or "Revised" License
HaishinKit for Android.	Camera and Microphone streaming library via RTMP for Android.	BSD 3-Clause "New" or "Revised" License

API reference

🔧 Setup

iOS and macOS use HaishinKit.swift 2.3.0 through Swift Package Manager. Use Flutter 3.44 or newer and Xcode 26 or newer. The minimum deployment targets remain iOS 15 and macOS 12. The Flutter bridge uses Swift 5 language mode with the Swift 6 toolchain.

Enable Swift Package Manager before building an Apple application:

flutter config --enable-swift-package-manager
flutter clean
flutter pub get

CocoaPods installation of this plugin is no longer supported. HaishinKit.swift 2.3.0 distributes its SRT and WebRTC dependencies through Swift packages. The Dart API is unchanged; existing StreamSession, MediaMixer, and screen snapshot calls continue to use the shared iOS/macOS bridge. Android uses HaishinKit.kt 0.19.0 (haishinkit and rtmp) from JitPack, including the cross-platform ScreenObjectSnapshot and rendering fixes.

Android apps consuming this plugin need compileSdk = 37 or newer. The example uses Android Gradle Plugin 9.2.1 and Gradle 9.4.1. With the current Kotlin plugin configuration, also set these properties in android/gradle.properties:

android.builtInKotlin=false
android.newDsl=false

Please contains macos/Runner/Info.plist and ios/Runner/Info.plist files.

<key>NSCameraUsageDescription</key>
<string>your usage description here</string>
<key>NSMicrophoneUsageDescription</key>
<string>your usage description here</string>

Please contains macos/Runner/Debug.Entitlements and macos/Runner/Release.Entitlements files.

<key>com.apple.security.device.audio-input</key>
<true />
<key>com.apple.security.device.camera</key>
<true />

🔧 Develop

Use freezed for development. When creating data classes, please try running the following command.

flutter pub run build_runner build --delete-conflicting-outputs

🐾 Example

An example project is available for both iOS and Android. https://github.com/HaishinKit/HaishinKit.dart/tree/main/example

📜 License

BSD-3-Clause