HaishinKit
- Camera and Microphone streaming library via RTMP, HLS for iOS, macOS, tvOS.
- Issuesの言語は、日本語が分かる方は日本語でお願いします!
Sponsored with ? by
Enterprise Grade APIs for Feeds & Chat. Try the iOS Chat tutorial ?
Communication
- If you need help with making LiveStreaming requests using HaishinKit, use a GitHub issue with Bug report template
- The trace level log is very useful. Please set
Logboard.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'd like to discuss a feature request, use a GitHub issue with Feature request template.
- If you want to support e-mail based communication without GitHub issue.
- Consulting fee is $50/1 incident. I'm able to response a few days.
- If you want to contribute, submit a pull request!
Features
RTMP
- [x] Authentication
- [x] Publish and Recording (H264/AAC)
- [x] Playback (Beta)
- [x] Adaptive bitrate streaming
- [x] Handling (see also #126)
- [x] Automatic drop frames
- [ ] Action Message Format
- [x] AMF0
- [ ] AMF3
- [x] SharedObject
- [x] RTMPS
- [x] Native (RTMP over SSL/TLS)
- [x] Tunneled (RTMPT over SSL/TLS) (Technical Preview)
- [x] RTMPT (Technical Preview)
- [x] ReplayKit Live as a Broadcast Upload Extension (Technical Preview)
HLS
- [x] HTTPService
- [x] HLS Publish
Rendering
- | HKView | MTHKView |
---|---|---|
Engine | AVCaptureVideoPreviewLayer | Metal |
Publish | ○ | ◯ |
Playback | × | ◯ |
VisualEffect | × | ◯ |
Condition | Stable | Stable |
Others
- [x] Support tvOS 10.2+ (Technical Preview)
- tvOS can't publish Camera and Microphone. Available playback feature.
- [x] Hardware acceleration for H264 video encoding, AAC audio encoding
- [x] Support "Allow app extension API only" option
- [ ]
Support GPUImage framework (~> 0.5.12) - [ ]
Objective-C Bridging
Requirements
- | iOS | OSX | tvOS | XCode | Swift |
---|---|---|---|---|---|
1.2.0+ | 9.0+ | 10.11+ | 10.2+ | 13.0+ | 5.5+ |
1.1.0+ | 9.0+ | 10.11+ | 10.2+ | 12.0+ | 5.0+ |
1.0.0+ | 8.0+ | 10.11+ | 10.2+ | 11.0+ | 5.0+ |
Cocoa Keys
Please contains Info.plist.
iOS 10.0+
- NSMicrophoneUsageDescription
- NSCameraUsageDescription
macOS 10.14+
- NSMicrophoneUsageDescription
- NSCameraUsageDescription
Installation
*Please set up your project Swift 5.5. *
CocoaPods
Carthage
github "shogo4405/HaishinKit.swift" ~> 1.2.2
Swift Package Manager
https://github.com/shogo4405/HaishinKit.swift
License
BSD-3-Clause
Donation
Paypal
Bitcoin
Prerequisites
Make sure you setup and activate your AVAudioSession.
RTMP Usage
Real Time Messaging Protocol (RTMP).
RTML 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")
Settings
Authentication
Screen Capture
HTTP Usage
HTTP Live Streaming (HLS). Your iPhone/Mac become a IP Camera. Basic snipet. You can see http://ip.address:8080/hello/playlist.m3u8
FAQ
How can I run example project?
Reference
- 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