HaishinKit for iOS, macOS, tvOS, and Android.

Camera and Microphone streaming library via RTMP, HLS for iOS, macOS, tvOS.
API Documentation

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 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.
If you want to contribute, submit a pull request!
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.
日本語が分かる方は、日本語でのコミニケーションをお願いします！

💖 Sponsors

🎨 Features

RTMP

HLS

HTTPService
HLS Publish

Multi Camera

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

let back = AVCaptureDevice.default(.builtInWideAngleCamera, for: .video, position: .back)
stream.attachCamera(back)

if #available(iOS 13.0, *) {
  let front = AVCaptureDevice.default(.builtInWideAngleCamera, for: .video, position: .front)
  stream.attachMultiCamera(front)
}

Rendering

-	HKView	PiPHKView	MTHKView
Engine	AVCaptureVideoPreviewLayer	AVSampleBufferDisplayLayer	Metal
Publish	○	◯	○
Playback	×	◯	○
VisualEffect	×	◯	○

Others

Support multitasking camera access.
Support tvOS 11.0+ (Technical Preview)
- tvOS can't use camera and microphone devices.
Hardware acceleration for H264 video encoding, AAC audio encoding
Support "Allow app extension API only" option
~~Support GPUImage framework (~> 0.5.12)~~
- ~~https://github.com/shogo4405/GPUHaishinKit.swift/blob/master/README.md~~
~~Objective-C Bridging~~

🌏 Requirements

-	iOS	OSX	tvOS	Xcode	Swift
1.4.0+	11.0+	10.13+	10.2+	14.0+	5.7+
1.3.0+	11.0+	10.13+	10.2+	14.0+	5.7+
1.2.0+	9.0+	10.11+	10.2+	13.0+	5.5+

🐾 Examples

Examples project are available for iOS with UIKit, iOS with SwiftUI, macOS and tvOS.

Camera and microphone publish.
RTMP Playback

git clone https://github.com/shogo4405/HaishinKit.swift.git
cd HaishinKit.swift
carthage bootstrap --use-xcframeworks
open HaishinKit.xcodeproj

☕ Cocoa Keys

Please contains Info.plist.

iOS 10.0+

NSMicrophoneUsageDescription
NSCameraUsageDescription

macOS 10.14+

NSMicrophoneUsageDescription
NSCameraUsageDescription

🔧 Installation

CocoaPods

source 'https://github.com/CocoaPods/Specs.git'
use_frameworks!

def import_pods
    pod 'HaishinKit', '~> 1.4.2
end

target 'Your Target'  do
    platform :ios, '11.0'
    import_pods
end

Carthage

github "shogo4405/HaishinKit.swift" ~> 1.4.2

Swift Package Manager

https://github.com/shogo4405/HaishinKit.swift

🔧 Prerequisites

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)
}

📓 RTMP Usage

Real Time Messaging Protocol (RTMP).

let rtmpConnection = RTMPConnection()
let rtmpStream = RTMPStream(connection: rtmpConnection)
rtmpStream.attachAudio(AVCaptureDevice.default(for: .audio)) { error in
    // print(error)
}
rtmpStream.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)

rtmpConnection.connect("rtmp://localhost/appName/instanceName")
rtmpStream.publish("streamName")
// if you want to record a stream.
// rtmpStream.publish("streamName", type: .localRecord)

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")

Settings

var stream = RTMPStream(connection: rtmpConnection)

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
// rtmpStream.videoCapture(for: 1).isVideoMirrored = false

// Specifies the audio codec settings.
stream.audioSettings = [
  .bitrate: 32 * 1000,
]

// Specifies the video codec settings.
stream.videoSettings = [
  .width: 640, // video output width
  .height: 360, // video output height
  .bitrate: 160 * 1000, // video output bitrate
  .profileLevel: kVTProfileLevel_H264_Baseline_3_1, // H264 Profile require "import VideoToolbox"
  .maxKeyFrameIntervalDuration: 2, // key frame / sec
]

// Specifies the recording settings. 0" means the same of input.
stream.startRecording([
  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
    ]
    */
  ]
])

// 2nd arguemnt set false
stream.attachAudio(AVCaptureDevice.default(for: .audio), automaticallyConfiguresApplicationAudioSession: false)

// picrure in picrure settings.
stream.multiCamCaptureSettings = MultiCamCaptureSetting(
  mode: .pip,
  cornerRadius: 16.0,
  regionOfInterest: .init(
    origin: CGPoint(x: 16, y: 16),
    size: .init(width: 160, height: 160)
  )
)

// split settings.
stream.multiCamCaptureSettings = MultiCamCaptureSetting(
  mode: .split(direction: .east),
  cornerRadius: 0.0,
  regionOfInterest: .init(
    origin: .zero,
    size: .zero
  )
)

Authentication

var rtmpConnection = RTMPConnection()
rtmpConnection.connect("rtmp://username:password@localhost/appName/instanceName")

Screen Capture

// iOS
let screen = IOUIScreenCaptureUnit(shared: UIApplication.shared)
screen.delegate = rtmpStream
screen.startRunning()

// macOS
rtmpStream.attachScreen(AVCaptureScreenInput(displayID: CGMainDisplayID()))

📓 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

var httpStream = HTTPStream()
httpStream.attachCamera(AVCaptureDevice.default(.builtInWideAngleCamera, for: .video, position: .back))
httpStream.attachAudio(AVCaptureDevice.default(for: .audio))
httpStream.publish("hello")

var hkView = HKView(frame: view.bounds)
hkView.attachStream(httpStream)

var httpService = HLSService(domain: "", type: "_http._tcp", name: "HaishinKit", port: 8080)
httpService.startRunning()
httpService.addHTTPStream(httpStream)

// add ViewController#view
view.addSubview(hkView)

💠 Sponsorship

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の優先的な対応

Sponsorship

📖 Reference

Adobe’s Real Time Messaging Protocol
- http://www.adobe.com/content/dam/Adobe/en/devnet/rtmp/pdf/rtmp_specification_1.0.pdf
Action Message Format -- AMF 0
- https://www.adobe.com/content/dam/acom/en/devnet/pdf/amf0-file-format-specification.pdf
Action Message Format -- AMF 3
- https://www.adobe.com/content/dam/acom/en/devnet/pdf/amf-file-format-spec.pdf
Video File Format Specification Version 10
- https://www.adobe.com/content/dam/acom/en/devnet/flv/video_file_format_spec_v10.pdf
Adobe Flash Video File Format Specification Version 10.1
- http://download.macromedia.com/f4v/video_file_format_spec_v10_1.pdf

📜 License

BSD-3-Clause

orgTestCodacy11KRepos110MB / repo-5241-HaishinKit.swift