apivideo / api.video-swift-live-stream

Swift RTMP live stream client for iOS. Made with ♥ by api.video

   

Swift RTMP live stream client for iOS

api.video is the video infrastructure for product builders. Lightning fast video APIs for integrating, scaling, and managing on-demand & low latency live streaming features in your app.

Table of contents

• Table of contents
• Project description
• Getting started
  • Installation
    • With Cocoapods
  • Permissions
  • Code sample
• Plugins
• FAQ

Project description

This module is an easy way to broadcast RTMP live stream to api.video platform

Getting started

Installation

Swift Package Manager

In the Project Navigator select your own project. Then select the project in the Project section and click on the Package Dependencies tab. Click on the "+" button at the bottom. Paste the below url on the search bar on the top right. Finaly click on "Add package" button.

https://github.com/api.video-swift-live-stream

Or add this in your Package.swift

  dependencies: [
        .package(url: "https://github.com/api.video-swift-live-stream.git", from: "1.4.3"),
    ],

Cocoapods

1. Add the following entry to your Podfile:

pod 'ApiVideoLiveStream', '1.4.3'

2. Then run pod install
3. Don’t forget to import ApiVideoLiveStream in every file you’d like to use api.video live stream library

Carthage

github "apivideo/ApiVideoLiveStream.swift" ~> 1.4.3

Permissions

To be able to broadcast, you must update Info.plist with a usage description for camera and microphone

...
<key>NSCameraUsageDescription</key>
<string>Your own description of the purpose</string>
<key>NSMicrophoneUsageDescription</key>
<string>Your own description of the purpose</string>
...

Code sample

1. In ViewController.swift import the library

import ApiVideoLiveStream

2. Create a ApiVideoLiveStream object with your default audio and video configuration

class ViewController: UIViewController {
    var liveStream:  ApiVideoLiveStream?
    @IBOutlet var viewCamera: UIView!
    override func viewDidLoad() {
        super.viewDidLoad()
        let audioConfig = AudioConfig(bitrate: 32 * 1000)
        let videoConfig = VideoConfig(bitrate: 2 * 1024 * 1024, resolution: Resolutions.RESOLUTION_720, fps: 30)
        do {
            liveStream = try ApiVideoLiveStream(initialAudioConfig: audioConfig, initialVideoConfig: videoConfig, preview: preview)
        } catch {
            print (error)
        }
    }
}

3. Start your live stream with startStreaming

liveStream?.startStreaming(streamKey: "YOUR_STREAM_KEY")

Alternatively, you can use startStreaming url parameter to set the URL of your RTMP server.

Plugins

api.video sdk is using external library

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

FAQ

If you have any questions, ask us here: https://community.api.video . Or use Issues.

Also feel free to test our Sample app.

api.video-swift-live-stream's Issues

Stop Streaming flow & onDisconnect

Summary

Noticed that the callback onDisconnect is not being called when executing stopStreaming.
Is this intentional? Or an error?

Motivation

My users can only stream inside of a time based window. Meaning they will get disconnected when the time reaches the end time of that predefined time window. In order to accommodate this on mobile. When the end time is reached, the live stream will shut down and close the live stream page. Meaning i gotta know when the connection have been closed before i close the stream view.

Problem

In the stopStreaming method
The rtmpConnection.close() might go async at some point.
Meaning the event listeners will get removed before the connection is actually closed.
Or
rtmpConnection.close() might not trigger the rtmpStatusHandler at all for some reason.

Solution

Have a private enum that contains the status that we want the live stream to be in.
Meaning in startStreaming, we set this variable to "streaming".
So if the connection fails, we know if the user wants the stream and we can retry the connection.
In stopStreamingwe set the enum to "stopped". When the rtmpStatusHandler reaches RTMPConnection.Code.connectClosed.rawValue we can first onDisconnect and afterwards check the enum, and then remove the event listeners.

Can make a pr. But want a go ahead first.

[Feat]: Multiple cam request

Version

last

Environment that reproduces the issue

iphone 15 pro

Use case description

Thanks for the sample application, when starting live broadcast; How can I start with the rear camera turned on?

Proposed solution

No response

Alternative solutions

No response