https://github.com/haishinkit/haishinkit.kt
Camera and Microphone streaming library via RTMP for Android.
https://github.com/haishinkit/haishinkit.kt
android camera rtmp streaming
Last synced: 6 months ago
JSON representation
Camera and Microphone streaming library via RTMP for Android.
- Host: GitHub
- URL: https://github.com/haishinkit/haishinkit.kt
- Owner: HaishinKit
- License: bsd-3-clause
- Created: 2016-11-19T04:38:32.000Z (almost 9 years ago)
- Default Branch: main
- Last Pushed: 2025-03-24T10:01:29.000Z (6 months ago)
- Last Synced: 2025-04-04T18:07:07.873Z (6 months ago)
- Topics: android, camera, rtmp, streaming
- Language: Kotlin
- Homepage: https://docs.haishinkit.com/kt/latest
- Size: 20.9 MB
- Stars: 168
- Watchers: 10
- Forks: 48
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
- Code of conduct: .github/CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# HaishinKit for Android, [iOS, macOS, tvOS and visionOS](https://github.com/HaishinKit/HaishinKit.swift).
[](https://raw.githubusercontent.com/HaishinKit/HaishinKit.kt/master/LICENSE.md)
[](https://jitpack.io/#HaishinKit/HaishinKit~kt)
[](https://github.com/sponsors/shogo4405)
* Camera and Microphone streaming library via RTMP for Android.
* [API Documentation](https://docs.haishinkit.com/kt/latest/)
## 💖 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](https://github.com/sponsors/shogo4405): 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](https://github.com/HaishinKit/HaishinKit.swift?tab=coc-ov-file) 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](https://www.paypal.me/shogo4405/50USD)/1 incident. I'm able to response a few days.
## 🌏 Related projects
Project name |Notes |License
----------------|------------|--------------
[HaishinKit for iOS, macOS, tvOS and visionOS.](https://github.com/HaishinKit/HaishinKit.swift)|Camera and Microphone streaming library via RTMP for Android.|[BSD 3-Clause "New" or "Revised" License](https://github.com/HaishinKit/HaishinKit.swift/blob/master/LICENSE.md)
[HaishinKit for Flutter.](https://github.com/HaishinKit/HaishinKit.dart)|Camera and Microphone streaming library via RTMP for Flutter.|[BSD 3-Clause "New" or "Revised" License](https://github.com/HaishinKit/HaishinKit.dart/blob/master/LICENSE.md)
## 🎨 Features
### RTMP
- [x] Authentication
- [x] Publish
- [x] Playback
- [ ] Action Message Format
- [x] AMF0
- [ ] ~~AMF3~~
- [ ] ~~SharedObject~~
- [x] RTMPS
- [x] Native (RTMP over SSL/TSL)
- [ ] [Enhanced RTMP (Working in progress)](https://github.com/HaishinKit/HaishinKit.kt/wiki/Supports-Enhanced-RTMP-Status)
- [ ] v1
- [ ] v2
- [x] Audio Codecs
- [x] AAC
- [x] Video Codecs
- [x] H264, HEVC
### Recording
Now support local recording. Additionally, you can specify separate videoSettings and audioSettings from the live stream.
```kt
val recorder: StreamRecorder by lazy { StreamRecorder(requireContext()) }
recorder.videoSettings.profileLevel = VideoCodecProfileLevel.HEVC_MAIN_3_1
recorder.attachStream(stream)
recorder.startRecording(
File(Environment.getExternalStoragePublicDirectory(Environment.DIRECTORY_DOWNLOADS), "output.mp4").toString(),
MediaMuxer.OutputFormat.MUXER_OUTPUT_MPEG_4
)
```
### Filter
- [Table Of Filters](https://shogo4405.github.io/HaishinKit.kt/haishinkit/com.haishinkit.graphics.effect/index.html)
### Sources
- [x] Single camera with Camera2 api
- [x] Multi camera with Camera2 api
- [x] MediaProjection
- [x] Microphone with AudioRecord api.
### View rendering
|-|HkSurfaceView|HkTextureView|
|:---:|:---:|:---:|
|Engine|SurfaceView|TextureView|
|Playback|beta|beta|
|Publish|✅ Stable|✅ Stable|
|Note|Recommend Android 7.0+|Recommend Android 5.0-6.0|
### Others
- [x] Hardware acceleration for H264 video encoding/AAC audio encoding.
- [x] Asynchronously processing.
- [x] Graphics api
- [x] ✅ OpenGL
- [ ] 🐛 Vulkan
### Settings
```kt
stream.audioSettings.bitrate = 32 * 1000
stream.videoSettings.width = 640 // The width resoulution of video output.
stream.videoSettings.height = 360 // The height resoulution of video output.
stream.videoSettings.bitrate = 160 * 1000 // The bitRate of video output.
stream.videoSettings.IFrameInterval = 2 // The key-frmae interval
```
### Offscreen Rendering.
Through off-screen rendering capabilities, it is 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.
```kt
stream.attachVideo(cameraSource)
val text = Text()
text.textSize = 60f
text.textValue = "23:44:56"
text.layoutMargins.set(0, 0, 16, 16)
text.horizontalAlignment = ScreenObject.HORIZONTAL_ALIGNMENT_RIGHT
text.verticalAlignment = ScreenObject.VERTICAL_ALIGNMENT_BOTTOM
stream.screen.addChild(text)
val image = Image()
image.bitmap = BitmapFactory.decodeResource(resources, R.drawable.game_jikkyou)
image.verticalAlignment = ScreenObject.VERTICAL_ALIGNMENT_BOTTOM
image.frame.set(0, 0, 180, 180)
stream.screen.addChild(image)
```
## 🌏 Architecture Overview
### Publishing Feature
## 🐾 Examples
Examples project are available for Android.
- [x] Camera and microphone publish.
- [x] RTMP Playback
```sh
git clone https://github.com/HaishinKit/HaishinKit.kt.git
cd HaishinKit.kt
git submodule update --init
# 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**'.
- In older versions, there may be cases where Jetpack is not supported. If it's not available, please give up and use the latest version.
```
allprojects {
repositories {
maven { url 'https://jitpack.io' }
}
}
dependencies {
implementation 'com.github.HaishinKit.HaishinKit~kt:haishinkit:x.x.x'
implementation 'com.github.HaishinKit.HaishinKit~kt:compose:x.x.x'
implementation 'com.github.HaishinKit.HaishinKit~kt:lottie:x.x.x'
}
```
### Dependencies
|-|minSdk|Android|Requirements|Status|Description|
|:----|:----|:----|:-----|:----|:----|
|haishinkit|21+|5|Require|Stable|It's the base module for HaishinKit.|
|compose|21+|5|Optional|Beta|It's support for a composable component for HaishinKit.|
|lottie|21+|5|Optional|Beta|It's a module for embedding Lottie animations into live streaming video.|
### Android manifest
```xml
```
### Prerequisites
```kt
ActivityCompat.requestPermissions(this,arrayOf(
Manifest.permission.CAMERA,
Manifest.permission.RECORD_AUDIO
), 1)
```
### RTMP Usage
Real Time Messaging Protocol (RTMP).
```kt
class CameraTabFragment : Fragment(), IEventListener {
private lateinit var connection: RtmpConnection
private lateinit var stream: RtmpStream
private lateinit var cameraView: HkGLSurfaceView
private lateinit var cameraSource: CameraSource
override fun onCreate(savedInstanceState: Bundle?) {
super.onCreate(savedInstanceState)
activity?.let {
val permissionCheck = ContextCompat.checkSelfPermission(it, Manifest.permission.CAMERA)
if (permissionCheck != PackageManager.PERMISSION_GRANTED) {
ActivityCompat.requestPermissions(it, arrayOf(Manifest.permission.CAMERA), 1)
}
if (ContextCompat.checkSelfPermission(
it,
Manifest.permission.RECORD_AUDIO
) != PackageManager.PERMISSION_GRANTED
) {
ActivityCompat.requestPermissions(it, arrayOf(Manifest.permission.RECORD_AUDIO), 1)
}
}
connection = RtmpConnection()
stream = RtmpStream(connection)
stream.attachAudio(AudioRecordSource())
cameraSource = CameraSource(requireContext()).apply {
open(CameraCharacteristics.LENS_FACING_BACK)
}
stream.attachVideo(cameraSource)
connection.addEventListener(Event.RTMP_STATUS, this)
}
@SuppressLint("SetTextI18n")
override fun onCreateView(
inflater: LayoutInflater,
container: ViewGroup?,
savedInstanceState: Bundle?
): View {
val v = inflater.inflate(R.layout.fragment_camera, container, false)
val button = v.findViewById(R.id.button)
button.setOnClickListener {
if (button.text == "Publish") {
connection.connect(Preference.shared.rtmpURL)
button.text = "Stop"
} else {
connection.close()
button.text = "Publish"
}
}
val switchButton = v.findViewById(R.id.switch_button)
switchButton.setOnClickListener {
cameraSource.switchCamera()
}
cameraView = v.findViewById(R.id.camera)
cameraView.attachStream(stream)
return v
}
override fun onDestroy() {
super.onDestroy()
connection.dispose()
}
override fun handleEvent(event: Event) {
Log.i("$TAG#handleEvent", event.toString())
val data = EventUtils.toMap(event)
val code = data["code"].toString()
if (code == RtmpConnection.Code.CONNECT_SUCCESS.rawValue) {
stream.publish(Preference.shared.streamName)
}
}
companion object {
fun newInstance(): CameraTabFragment {
return CameraTabFragment()
}
private val TAG = CameraTabFragment::class.java.simpleName
}
}
```
### Filter API (v0.1)
```
- [assets]
- [shaders]
- custom-shader.vert(optional)
- custom-shader.frag
```
```
package my.custom.filter
import com.haishinkit.graphics.filter.VideoEffect
class Monochrome2VideoEffect(
override val name: String = "custom-shader"
) : VideoEffect
```
```
stream.videoEffect = Monochrome2VideoEffect()
```
## 📓 FAQ
### How can I compile the vulkan module with Android 5 project?
#### AndroidManifest.xml
```xml
```
#### MainActivity
```kotlin
if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.O) {
PixelTransformFactory.registerPixelTransform(VkPixelTransform::class)
}
```
### RTMP URL Format
* rtmp://server-ip-address[:port]/application/[appInstance]/[prefix:[path1[/path2/]]]streamName
- [] mark is an Optional.
```
rtmpConneciton.connect("rtmp://server-ip-address[:port]/application/[appInstance]")
rtmpStream.publish("[prefix:[path1[/path2/]]]streamName")
```
* rtmp://localhost/live/streamName
```
rtmpConneciton.connect("rtmp://localhost/live")
rtmpStream.publish("streamName")
```
### Related Project
* HaishinKit.swift - Camera and Microphone streaming library via RTMP, HLS for iOS, macOS and tvOS.
* https://github.com/HaishinKit/HaishinKit.swift
## 📜 License
BSD-3-Clause