Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/getstream/stream-video-swift
SwiftUI Video SDK ➡️ Stream Video 📹
https://github.com/getstream/stream-video-swift
audio-calls ios ios-sdk live-streaming real-time-communication sdk stream-video swiftui swiftui-components swiftui-framework swiftui-video uikit video video-api video-application video-calling video-communication video-sdk voice-messages
Last synced: 6 days ago
JSON representation
SwiftUI Video SDK ➡️ Stream Video 📹
- Host: GitHub
- URL: https://github.com/getstream/stream-video-swift
- Owner: GetStream
- License: other
- Created: 2022-06-24T08:41:05.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-05-01T13:19:36.000Z (5 months ago)
- Last Synced: 2024-05-01T13:51:33.558Z (5 months ago)
- Topics: audio-calls, ios, ios-sdk, live-streaming, real-time-communication, sdk, stream-video, swiftui, swiftui-components, swiftui-framework, swiftui-video, uikit, video, video-api, video-application, video-calling, video-communication, video-sdk, voice-messages
- Language: Swift
- Homepage: https://getstream.io/video/sdk/ios/
- Size: 174 MB
- Stars: 85
- Watchers: 18
- Forks: 11
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
- Security: SECURITY.md
Awesome Lists containing this project
README
# StreamVideo iOS
This is the official iOS SDK for StreamVideo, a platform for building apps with video and audio calling support. The repository includes a low-level SDK and a set of reusable UI components, available in both UIKit and SwiftUI.
## What is Stream?
Stream allows developers to rapidly deploy scalable feeds, chat messaging and video with an industry leading 99.999% uptime SLA guarantee.
With Stream's video components, you can use our SDK to build in-app video calling, audio rooms, audio calls, or live streaming. The best place to get started is with our tutorials:
- [Video & Audio Calling Tutorial](https://getstream.io/video/sdk/ios/tutorial/video-calling/)
- [Audio Rooms Tutorial](https://getstream.io/video/sdk/ios/tutorial/audio-room/)
- [Livestreaming Tutorial](https://getstream.io/video/sdk/ios/tutorial/livestreaming/)
Stream provides UI components and state handling that make it easy to build video calling for your app. All calls run on Stream's network of edge servers around the world, ensuring optimal latency and reliability.
## 👩💻 Free for Makers 👨💻
Stream is free for most side and hobby projects. To qualify, your project/company needs to have < 5 team members and < $10k in monthly revenue. Makers get $100 in monthly credit for video for free.
## 💡Supported Features💡
Here are some of the features we support:
- Developer experience: Great SDKs, docs, tutorials and support so you can build quickly
- Edge network: Servers around the world ensure optimal latency and reliability
- Chat: Stored chat, reactions, threads, typing indicators, URL previews etc
- Security & Privacy: Based in USA and EU, Soc2 certified, GDPR compliant
- Dynascale: Automatically switch resolutions, fps, bitrate, codecs and paginate video on large calls
- Screen sharing
- Picture in picture support
- Active speaker
- Custom events
- Geofencing
- Notifications and ringing calls
- Opus DTX & Red for reliable audio
- Webhooks & SQS
- Backstage mode
- Flexible permissions system
- Joining calls by ID, link or invite
- Enabling and disabling audio and video when in calls
- Flipping, Enabling and disabling camera in calls
- Enabling and disabling speakerphone in calls
- Push notification providers support
- Call recording
- Broadcasting to HLS
- Noise cancellation
Check our [docs](https://getstream.io/video/docs/ios/) to get more details about the supported features and integration guides.
## Repo Overview 😎
This repository contains the following parts:
- low-level client for calling (can be used standalone if you want to build your own UI)
- SwiftUI SDK (UI components developed in SwiftUI)
- UIKit SDK (wrappers for easier usage in UIKit apps)
### Main Principles
- Progressive disclosure: The SDK can be used easily with very minimal knowledge of it. As you become more familiar with it, you can dig deeper and start customizing it on all levels.
- Swift native API: Uses Swift's powerful language features to make the SDK usage easy and type-safe.
- Familiar behavior: The UI elements are good platform citizens and behave like native elements; they respect `tintColor`, padding, light/dark mode, dynamic font sizes, etc.
- Fully open-source implementation: You have access to the complete source code of the SDK on GitHub.
### Low-Level Client
The low-level client is used for establishing audio and video calls. It integrates with Stream's backend infrastructure, and implements the WebRTC protocol.
Here are the most important components that the low-level client provides:
- `StreamVideo` - the main SDK object.
- `Call` - an object that provides info about the call state, as well as methods for updating it.
#### StreamVideo
This is the main object for interfacing with the low-level client. It needs to be initialized with an API key and a user/token, before the SDK can be used.
```swift
let streamVideo = StreamVideo(
apiKey: "key1",
user: user.userInfo,
token: user.token,
videoConfig: VideoConfig(),
tokenProvider: { result in
yourNetworkService.loadToken(completion: result)
}
)
```
#### Call
The `Call` class provides all the information about the call, such as its participants, whether the call is being recorded, etc. It also provides methods to perform standard actions available during a call, such as muting/unmuting users, sending reactions, changing the camera input, granting permissions, recording, etc.
You can create a new `Call` via the `StreamVideo`'s method `func call(callType: String, callId: String, members: [Member])`.
### SwiftUI SDK
The SwiftUI SDK provides out of the box UI components, ready to be used in your app.
The simplest way to add calling support to your hosting view is to attach the `CallModifier`:
```swift
struct CallView: View {
@StateObject var viewModel: CallViewModel
init() {
_viewModel = StateObject(wrappedValue: CallViewModel())
}
var body: some View {
HomeView(viewModel: viewModel)
.modifier(CallModifier(viewModel: viewModel))
}
}
```
You can customize the look and feel of the screens presented in the calling flow, by implementing the corresponding methods in our `ViewFactory`.
Most of our components are public, so you can use them as building blocks if you want to build your custom UI.
All the texts, images, fonts and sounds used in the SDK are configurable via our `Appearance` class, to help you brand the views to be inline with your hosting app.
### UIKit SDK
The UIKit SDK provides UIKit wrappers around the SwiftUI views. Its main integration point is the `CallViewController` which you can easily push in your navigation stack, or add as a modal screen.
```swift
private func didTapStartButton() {
let next = CallViewController.make(with: callViewModel)
next.modalPresentationStyle = .fullScreen
next.startCall(
callType: "default",
callId: callId,
members: members
)
self.navigationController?.present(next, animated: true)
}
```
The `CallViewController` is created with a `CallViewModel` - the same one used in our SwiftUI SDK.
At the moment, all the customizations in the UIKit SDK, need to be done in SwiftUI.
## Roadmap
Video roadmap and changelog is available [here](https://github.com/GetStream/protocol/discussions/127).
### 0.2 milestone
- [x] Toast views
- [x] Test coverage
- [x] Lobby updates (show participants and events)
- [x] Support settings.audio.default_device
- [x] Report SDK version number on all API calls
- [x] Fix AppClips
- [x] Pagination on query channels
### 0.3 milestone
- [x] Remote pinning of users
- [x] Add chat to the AppStore app (and app clip if possible)
- [x] Stability
- [x] API integration tests
- [x] CPU usage improvements
- [x] Audio Room UIKit tutorial
- [x] Improved chat integration
- [x] Screensharing from mobile
- [x] Button to switch speakerphone/earpiece
- [x] Audio filters
### 0.4 milestone
- [x] Picture-in-picture support
- [x] Enable SFU switching
- [x] Address testing feedback
- [x] Call Analytics / Stats
- [x] Thermal state improvements
- [x] Test with many participants
- [x] Testing on more devices
### 0.5.0 milestone
- [x] Tap to focus
- [x] Complete reconnection flows
- [x] Camera controls (zooming, tap to focus)
- [x] Picture-in-picture improvements
### 1.0.0 milestone - April
- [x] Blur & AI video filters
- [x] Analytics and stats for calls
- [x] Standardization across SDKs
- [x] Livestream, default video player UI for all SDKs
- [x] Improved CallKit integration
- [x] Benchmarks for audio rooms and livestreams
### 1.1.0 milestone - June
- [ ] Closed Captions and multi language support for transcriptions
- [x] Improve noise reduction/cancelation
- [ ] Improved support for teams & multi-tenant
- [ ] Waiting rooms
- [ ] Session timers
- [ ] Manual quality selection (currently it's always automatic)
- [ ] Query call session endpoint + better missed calls support
- [ ] Audio only call tutorial for each SDK
- [ ] WHIP
- [ ] AV1
- [ ] RTMP out
### After 1.1
- SIP
- Breakout rooms
- Transcription Summaries
- Ingress for SRT, RTSP, SDI, NDI, MTS/ MPEG-2 TS, RIST and Zixi
- Whiteboards
- RTSP input (via egress, same as RTMP input)
- WHEP