Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/apivideo/api.video-swift-live-stream
Swift RTMP live stream client for iOS. Made with ♥ by api.video
https://github.com/apivideo/api.video-swift-live-stream
h264 h264-encoder ios library live-streaming live-streaming-videos livestream swift video
Last synced: 2 days ago
JSON representation
Swift RTMP live stream client for iOS. Made with ♥ by api.video
- Host: GitHub
- URL: https://github.com/apivideo/api.video-swift-live-stream
- Owner: apivideo
- License: mit
- Created: 2021-04-29T11:15:47.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-04-08T09:33:36.000Z (7 months ago)
- Last Synced: 2024-04-08T10:48:52.556Z (7 months ago)
- Topics: h264, h264-encoder, ios, library, live-streaming, live-streaming-videos, livestream, swift, video
- Language: Swift
- Homepage: https://api.video
- Size: 500 KB
- Stars: 28
- Watchers: 4
- Forks: 12
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
README
[](https://twitter.com/intent/follow?screen_name=api_video) [](https://github.com/apivideo/api.video-swift-live-stream) [](https://community.api.video)
Swift RTMP live stream client for iOS
[api.video](https://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](#table-of-contents)
- [Project description](#project-description)
- [Getting started](#getting-started)
- [Installation](#installation)
- [With Cocoapods](#with-cocoapods)
- [Permissions](#permissions)
- [Code sample](#code-sample)
- [Plugins](#plugins)
- [FAQ](#faq)
## Project description
This module is an easy way to broadcast RTMP live stream to [api.video](https://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.5"),
],
```
#### Cocoapods
1. Add the following entry to your Podfile:
```swift
pod 'ApiVideoLiveStream', '1.4.5'
```
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.5
```
### Permissions
To be able to broadcast, you must update Info.plist with a usage description for camera and microphone
```xml
...
NSCameraUsageDescription
Your own description of the purpose
NSMicrophoneUsageDescription
Your own description of the purpose
...
```
### Code sample
1. In ViewController.swift import the library
```swift
import ApiVideoLiveStream
```
2. Create a `ApiVideoLiveStream` object with your default audio and video configuration
```swift
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`
```swift
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][HaishinKit] |
## FAQ
If you have any questions, ask us here: https://community.api.video .
Or use [Issues].
Also feel free to test our [Sample app].
[//]: # (These are reference links used in the body of this note and get stripped out when the markdown processor does its job. There is no need to format nicely because it shouldn't be seen. Thanks SO - http://stackoverflow.com/questions/4823468/store-comments-in-markdown-syntax)
[Issues]:
[HaishinKit]:
[Sample app]: