HaishinKit for Android, iOS, macOS, tvOS and visionOS.

• Camera and microphone streaming library via RTMP/RTMPS and SRT for Android.

• API Documentation

💖 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.

🎨 Features

• Protocols ✨Publish and play back over RTMP/RTMPS or experimental SRT (MPEG-TS with H.264/H.265 and AAC).

• Stream sessions ✨Use a common StreamSession API for RTMP and SRT publishing and playback.

• Multi Camera access ✨Support multi camera access.

• 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.

🐾 Examples

• Reference implementation app for live streaming publish and playback.

• If an issue occurs, please check whether it also happens in the examples app.

git clone https://github.com/HaishinKit/HaishinKit.kt.git
cd HaishinKit.kt

# Open [Android Studio] -> [Open] ...

🔧 Usage

Gradle dependency

JitPack

• A common mistake is trying to use implementation com.github.HaishinKit.**HaishinKit.kt**, which does not work. The correct form is implementation com.github.HaishinKit.**HaishinKit~kt**.

• Use a version available on JitPack and replace x.x.x with that version.

Add JitPack to your project's settings.gradle repositories:

dependencyResolutionManagement {
  repositories {
    maven { url 'https://jitpack.io' }
  }
}

Add dependencies to your app's build.gradle:

dependencies {
  implementation 'com.github.HaishinKit.HaishinKit~kt:haishinkit:x.x.x'
  // Choose the transport modules your app uses.
  implementation 'com.github.HaishinKit.HaishinKit~kt:rtmp:x.x.x'
  implementation 'com.github.HaishinKit.HaishinKit~kt:srt:x.x.x'
  // Optional UI and composition modules.
  implementation 'com.github.HaishinKit.HaishinKit~kt:compose:x.x.x'
  implementation 'com.github.HaishinKit.HaishinKit~kt:lottie:x.x.x'
  // Optional Vulkan output (API 28+).
  // implementation 'com.github.HaishinKit.HaishinKit~kt:vulkan:x.x.x'
}

Dependencies

Add rtmp, srt, or both for network streaming. Use the same version for all artifacts and choose a release that includes the modules you need.

Android manifest

<uses-permission android:name="android.permission.INTERNET" />
<uses-permission android:name="android.permission.CAMERA" />
<uses-permission android:name="android.permission.RECORD_AUDIO" />

Prerequisites

ActivityCompat.requestPermissions(
    this, arrayOf(
        Manifest.permission.CAMERA,
        Manifest.permission.RECORD_AUDIO
    ), 1
)

RTMP and SRT stream sessions

Register the factories for the protocols your app uses, then build a session with the complete stream URI. Call the suspending methods from your app's coroutine scope.

import android.net.Uri
import com.haishinkit.rtmp.RtmpStreamSessionFactory
import com.haishinkit.srt.SrtStreamSessionFactory
import com.haishinkit.stream.StreamSession

StreamSession.Builder.registerFactory(RtmpStreamSessionFactory)
StreamSession.Builder.registerFactory(SrtStreamSessionFactory)

val session = StreamSession.Builder(context, Uri.parse("srt://192.168.1.10:9710"))
    .setMode(StreamSession.Mode.PUBLISH) // Use PLAYBACK to receive media.
    .build()
// Before connecting, attach session.stream to your MediaMixer for publishing,
// or attach a StreamView output to session.stream for playback.
session.connect().onFailure { error -> /* Handle connection/startup failure. */ }
// When finished:
session.close()

For RTMP/RTMPS, pass a complete URI such as rtmps://example.com/live/streamName. Observe session.readyState for connection state changes.

Experimental SRT module

The :srt module supports encrypted SRT connections and MPEG-TS publishing and playback through SrtConnection, SrtStream, and SrtStreamSessionFactory. Caller, listener, and rendezvous socket modes are supported. To listen for one peer, use srt://:9710?mode=listener. Socket mode is independent of publishing/playback; connect a caller to a listener, or configure both peers for rendezvous.

Pass the complete SRT URL, including options such as streamid, latency (microseconds), or passphrase. A separate RTMP stream name is not used. See Android SRT setup for requirements, build commands, encryption options, and example app usage.

Optional Vulkan output

Android API 28+ can select the Vulkan output backend for publishing, recording, and preview. Screen composition and effects use the existing OpenGL renderer. See the Vulkan module guide for setup, capability requirements, OpenGL fallback, and device validation.

🌏 Related projects

📜 License

BSD-3-Clause