HaishinKit for iOS, macOS, tvOS, visionOS and Android.
- Camera and Microphone streaming library via RTMP and SRT for iOS, macOS, tvOS and visionOS.
- README.md contains unreleased content, which can be tested on the main branch.
- API Documentation
Sponsored with ๐ by
Enterprise Grade APIs for Feeds & Chat. Try the iOS Chat tutorial ๐ฌ
- If you need help with making LiveStreaming requests using HaishinKit, use a GitHub Discussions with Q&A.
- If you'd like to discuss a feature request, use a GitHub Discussions with Idea
- If you met a HaishinKit's bug๐, use a GitHub Issue with Bug report template
- The trace level log is very useful. Please set
LBLogger.with(HaishinKitIdentifier).level = .trace
. - If you don't use an issue template. I will immediately close the your issue without a comment.
- The trace level log is very useful. Please set
- If you want to contribute, submit a pull request with a pr template.
- 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.
- Discord chatroom.
- ๆฅๆฌ่ชใๅใใๆนใฏใๆฅๆฌ่ชใงใฎใณใใใฑใผใทใงใณใใ้กใใใพใ๏ผ
Project name | Notes | License |
---|---|---|
HaishinKit for Android. | Camera and Microphone streaming library via RTMP for Android. | BSD 3-Clause "New" or "Revised" License |
HaishinKit for Flutter. | Camera and Microphone streaming library via RTMP for Flutter. | BSD 3-Clause "New" or "Revised" License |
- Authentication
- Publish and Recording
- Playback (Beta)
- Adaptive bitrate streaming
- Action Message Format
- AMF0
- AMF3
- SharedObject
- RTMPS
- Native (RTMP over SSL/TLS)
- Tunneled (RTMPT over SSL/TLS) (Technical Preview)
- RTMPT (Technical Preview)
- ReplayKit Live as a Broadcast Upload Extension
- Enhanced RTMP
- Publish and Recording (H264/AAC)
- Playback(beta)
- mode
- caller
- listener
- rendezvous
Supports two camera video sources. A picture-in-picture display that shows the image of the secondary camera of the primary camera. Supports camera split display that displays horizontally and vertically.
Picture-In-Picture | Split |
---|---|
![]() |
![]() |
// If you're using multi-camera functionality, please make sure to call the attachMultiCamera method first. This is required for iOS 14 and 15, among others.
if #available(iOS 13.0, *) {
let front = AVCaptureDevice.default(.builtInWideAngleCamera, for: .video, position: .front)
stream.attachMultiCamera(front)
}
let back = AVCaptureDevice.default(.builtInWideAngleCamera, for: .video, position: .back)
stream.attachCamera(back)
rtmpStream.attachAudio(AVCaptureDevice.default(for: .audio))
Features | PiPHKView | MTHKView |
---|---|---|
Engine | AVSampleBufferDisplayLayer | Metal |
Publish | โ | โ |
Playback | โ | โ |
VisualEffect | โ | โ |
MultiCamera | โ | โ |
PictureInPicture | โ |
- tvOS 17.0 for AVCaptureSession.
- Support multitasking camera access.
- Support "Allow app extension API only" option
Examples project are available for iOS with UIKit, iOS with SwiftUI, macOS and tvOS. Example macOS requires Apple Silicon mac.
- Camera and microphone publish.
- Playback
git clone https://github.com/shogo4405/HaishinKit.swift.git
cd HaishinKit.swift
carthage bootstrap --platform iOS,macOS,tvOS --use-xcframeworks
open HaishinKit.xcodeproj
Version | Xcode | Swift |
---|---|---|
1.7.0+ | 15.0+ | 5.9+ |
1.6.0+ | 15.0+ | 5.8+ |
1.5.0+ | 14.0+ | 5.7+ |
- | iOS | tvOS | macOS | visionOS | watchOS |
---|---|---|---|---|---|
HaishinKit | 12.0+ | 12.0+ | 10.13+ | 1.0+ | - |
SRTHaishinKit | 12.0+ | - | 13.0+ | - | - |
Please contains Info.plist.
iOS 10.0+
- NSMicrophoneUsageDescription
- NSCameraUsageDescription
macOS 10.14+
- NSMicrophoneUsageDescription
- NSCameraUsageDescription
tvOS 17.0+
- NSMicrophoneUsageDescription
- NSCameraUsageDescription
HaishinKit has a multi-module configuration. If you want to use the SRT protocol, please use SRTHaishinKit. SRTHaishinKit supports SPM only.
HaishinKit | SRTHaishinKit | |
---|---|---|
SPM | https://github.com/shogo4405/HaishinKit.swift | https://github.com/shogo4405/HaishinKit.swift |
CocoaPods | source 'https://github.com/CocoaPods/Specs.git' use_frameworks! def import_pods pod 'HaishinKit', '~> 1.6.0 end target 'Your Target' do platform :ios, '12.0' import_pods end |
Not supported. |
Carthage | github "shogo4405/HaishinKit.swift" ~> 1.6.0 | Not supported. |
Make sure you setup and activate your AVAudioSession iOS.
import AVFoundation
let session = AVAudioSession.sharedInstance()
do {
try session.setCategory(.playAndRecord, mode: .default, options: [.defaultToSpeaker, .allowBluetooth])
try session.setActive(true)
} catch {
print(error)
}
let connection = RTMPConnection()
let stream = RTMPStream(connection: rtmpConnection)
stream.attachAudio(AVCaptureDevice.default(for: .audio)) { error in
// print(error)
}
stream.attachCamera(AVCaptureDevice.default(.builtInWideAngleCamera, for: .video, position: .back)) { error in
// print(error)
}
let hkView = MTHKView(frame: view.bounds)
hkView.videoGravity = AVLayerVideoGravity.resizeAspectFill
hkView.attachStream(stream)
// add ViewController#view
view.addSubview(hkView)
connection.connect("rtmp://localhost/appName/instanceName")
stream.publish("streamName")
let connection = RTMPConnection()
let stream = RTMPStream(connection: rtmpConnection)
let hkView = MTHKView(frame: view.bounds)
hkView.videoGravity = AVLayerVideoGravity.resizeAspectFill
hkView.attachStream(stream)
// add ViewController#view
view.addSubview(hkView)
connection.connect("rtmp://localhost/appName/instanceName")
stream.play("streamName")
var connection = RTMPConnection()
connection.connect("rtmp://username:password@localhost/appName/instanceName")
let connection = SRTConnection()
let stream = SRTStream(connection: connection)
stream.attachAudio(AVCaptureDevice.default(for: .audio)) { error in
// print(error)
}
stream.attachCamera(AVCaptureDevice.default(.builtInWideAngleCamera, for: .video, position: .back)) { error in
// print(error)
}
let hkView = HKView(frame: view.bounds)
hkView.videoGravity = AVLayerVideoGravity.resizeAspectFill
hkView.attachStream(rtmpStream)
// add ViewController#view
view.addSubview(hkView)
connection.connect("srt://host:port?option=foo")
stream.publish()
let connection = SRTConnection()
let stream = SRTStream(connection: connection)
let hkView = MTHKView(frame: view.bounds)
hkView.videoGravity = AVLayerVideoGravity.resizeAspectFill
hkView.attachStream(rtmpStream)
// add ViewController#view
view.addSubview(hkView)
connection.connect("srt://host:port?option=foo")
stream.play()
stream.frameRate = 30
stream.sessionPreset = AVCaptureSession.Preset.medium
/// Specifies the video capture settings.
stream.videoCapture(for: 0).isVideoMirrored = false
stream.videoCapture(for: 0).preferredVideoStabilizationMode = .auto
// stream.videoCapture(for: 0).isVideoMirrored = false
๐ AudioCodecSettings
When you specify the sampling rate, it will perform resampling. Additionally, in the case of multiple channels, downsampling can be applied.
stream.audioSettings = AudioCodecSettings(
bitRate: Int = 64 * 1000,
sampleRate: Float64 = 0,
channels: UInt32 = 0,
downmix: Bool = false,
channelMap: [Int]? = nil
)
๐ฅ VideoCodecSettings
stream.videoSettings = VideoCodecSettings(
videoSize: .init(width: 854, height: 480),
profileLevel: kVTProfileLevel_H264_Baseline_3_1 as String,
bitRate: 640 * 1000,
maxKeyFrameIntervalDuration: 2,
scalingMode: .trim,
bitRateMode: .average,
allowFrameReordering: nil,
isHardwareEncoderEnabled: true
)
// Specifies the recording settings. 0" means the same of input.
stream.startRecording(self, settings: [
AVMediaType.audio: [
AVFormatIDKey: Int(kAudioFormatMPEG4AAC),
AVSampleRateKey: 0,
AVNumberOfChannelsKey: 0,
// AVEncoderBitRateKey: 128000,
],
AVMediaType.video: [
AVVideoCodecKey: AVVideoCodecH264,
AVVideoHeightKey: 0,
AVVideoWidthKey: 0,
/*
AVVideoCompressionPropertiesKey: [
AVVideoMaxKeyFrameIntervalDurationKey: 2,
AVVideoProfileLevelKey: AVVideoProfileLevelH264Baseline30,
AVVideoAverageBitRateKey: 512000
]
*/
]
])
Looking for sponsors. Sponsoring I will enable us to:
- Purchase smartphones or peripheral devices for testing purposes.
- Pay for testing on a specific streaming service or for testing on mobile lines.
- Potentially private use to continue the OSS development
If you use any of our libraries for work, see if your employers would be interested in sponsorship. I have some special offers. I would greatly appreciate. Thank you.
- If you request I will note your name product our README.
- If you mention on a discussion, an issue or pull request that you are sponsoring us I will prioritise helping you even higher.
ในใใณใตใผใๅ้ใใฆใใพใใๅฉ็จ็จ้ใจใใฆใฏใ
- ใในใ็ฎ็ใงใในใใผใใใฉใณใฎ่ณผๅ ฅใๅจ่พบๆฉๅจใฎ่ณผๅ ฅใ่กใใพใใ
- ็นๅฎใฎในใใชใผใใณใฐใตใผใในใธใฎใในใใฎๆฏๆใใใใขใใคใซๅ็ทใงใฎใในใใฎๆฏๆใใซๅฉ็จใใพใใ
- ่ๆธใฎOSS้็บใ็ถ็ถ็ใซ่กใ็บใซ็ง็ใซๅฉ็จใใๅฏ่ฝๆงใใใใพใใ
ใใฎใฉใคใใฉใชใผใไปไบใง็ถ็ถ็ใซๅฉ็จใใฆใใๅ ดๅใฏใใใฒใ้็จไธปใซใในใใณใตใผใซ่ๅณใใชใใ็ขบ่ชใใใ ใใใจๅนธใใงใใใใใคใ็นๅ ธใ็จๆใใฆใใพใใ
- README.mdใธใฎไผๆฅญใญใดใฎๆฒ่ผ
- IssueใPull Requestใฎๅชๅ ็ใชๅฏพๅฟ
- Adobeโs Real Time Messaging Protocol
- Action Message Format -- AMF 0
- Action Message Format -- AMF 3
- Video File Format Specification Version 10
- Adobe Flash Video File Format Specification Version 10.1
BSD-3-Clause