https://github.com/pexip/pexip-swift-sdk
Pexip Swift SDK (iOS, macOS)
https://github.com/pexip/pexip-swift-sdk
ios macos sdk swift video-conferencing webrtc
Last synced: 4 months ago
JSON representation
Pexip Swift SDK (iOS, macOS)
- Host: GitHub
- URL: https://github.com/pexip/pexip-swift-sdk
- Owner: pexip
- License: apache-2.0
- Created: 2022-05-03T09:15:31.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2025-03-26T16:30:48.000Z (7 months ago)
- Last Synced: 2025-06-04T21:37:31.160Z (4 months ago)
- Topics: ios, macos, sdk, swift, video-conferencing, webrtc
- Language: Swift
- Homepage: https://pexip.github.io/pexip-swift-sdk
- Size: 17.5 MB
- Stars: 9
- Watchers: 29
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Codeowners: CODEOWNERS
Awesome Lists containing this project
README
# Pexip Swift SDK for iOS and macOS
[](https://img.shields.io/badge/Swift-5.5_5.6-Orange?style=flat-square)
[](https://img.shields.io/badge/Platforms-iOS_macOS-yellowgreen?style=flat-square)
[](https://img.shields.io/badge/CocoaPods-compatible-green?style=flat-square)
[](https://img.shields.io/badge/Swift_Package_Manager-compatible-orange?style=flat-square)
**Pexip Swift SDK** is a collection of frameworks for self hosted [Pexip Infinity](https://docs.pexip.com/admin/admin_intro.htm) installations that enables customers to build bespoke applications for Apple platforms or add Pexip to existing mobile or desktop experiences and workflows.
- [Features](#features)
- [Products](#products)
- [Requirements](#requirements)
- [Installation](#installation)
- [Documentation](https://pexip.github.io/pexip-swift-sdk/sdk/documentation/pexipswiftsdk/)
- [Examples](#examples)
- [License](#license)
## Features
- Built upon the [Pexip Client REST API for Infinity](https://docs.pexip.com/api_client/api_rest.htm)
- Uses media signaling with [WebRTC](https://webrtc.org)
- Granulated into multiple libraries in order to be flexible and future proof. Pexip might provide other
media signaling technologies in the future, or Infinity might be interchanged with the next generation APIs from Pexip at some point.
## Products
- **PexipInfinityClient** - a fluent client for Pexip Infinity REST API v2, conference controls, conference events, media signaling and token refreshing.
- **PexipRTC** - Pexip WebRTC-based media stack for sending and receiving video streams
- **PexipMedia** - core components for working with audio and video
- **PexipVideoFilters** - a set of built-in video filters ready to use in your video conferencing app (background blur, background replacement, etc)
- **PexipScreenCapture** - high level APIs for screen capture on iOS and macOS
- **PexipCore** - extensions, utilities and shared components
- **WebRTC** - WebRTC binaries for Apple platforms
## Requirements
- iOS 13.0+
- macOS 10.15+
- Swift 5.5 with structured concurrency support
- Xcode 13
- Pexip Infinity v29 and higher
:warning: **The project doesn't compile on Xcode 14.3 because of incorrect availability attributes CGDisplayStream.h file (introduced: is 13.0 instead of 10.8). Let's hope it's fixed in future Xcode versions.**
## Installation
### Swift Package Manager
To add a package dependency to your Xcode project, select File > Add Packages and enter
`https://github.com/pexip/pexip-swift-sdk` as a repository URL.
You can also add the following dependency to your `Package.swift` file:
```swift
import PackageDescription
let package = Package(
name: "MyLibrary",
platforms: [
.iOS(.v13),
.macOS(.v10_15)
],
dependencies: [
.package(url: "https://github.com/pexip/pexip-swift-sdk", from: "0.1.0")
],
targets: [
.target(
name: "MyLibrary",
dependencies: [
.product(name: "PexipInfinityClient", package: "pexip-swift-sdk"),
.product(name: "PexipRTC", package: "pexip-swift-sdk"),
// ...
],
),
]
)
```
### CocoaPods
```ruby
source 'https://github.com/pexip/pexip-pod-specs.git'
pod 'PexipInfinityClient'
pod 'PexipRTC'
```
### Manually
- Download the archives from the [GitHub releases](https://github.com/pexip/pexip-swift-sdk/releases)
- Add the xcframeworks as embedded frameworks to your target in Xcode
## Examples
- Check [Swift Package Manager example app](https://github.com/pexip/pexip-swift-sdk/tree/main/Examples/Conference) to learn how to integrate **Pexip Swift SDK** in your app.
- Check [Video Filters example app](https://github.com/pexip/pexip-swift-sdk/tree/main/Examples/VideoFilters) to learn how to install **Pexip Swift SDK** with CocoaPods and apply various video filters with [ML Kit's Selfie Segmentation API](https://developers.google.com/ml-kit) instead of default [Vision Person Segmentation](https://developer.apple.com/documentation/vision/vngeneratepersonsegmentationrequest), which is available only on iOS 15.0+ and macOS 12.0+.
- [SDK documentation and API reference](https://pexip.github.io/pexip-swift-sdk)
## Development
- Download and install the latest version of [Xcode](https://developer.apple.com/support/xcode/).
- Open Xcode and install additional tools.
- Install [SwiftLint](https://github.com/realm/SwiftLint) `brew install swiftlint`
- Download the source code `git clone git@github.com:pexip/pexip-swift-sdk.git`
- **Review** and add custom Git hooks `git config core.hooksPath .githooks`
- Open the `Package.swift` with Xcode or run `open Package.swift` from the command line.
- Build "Cmd+B"
- Test "Cmd+U"
## License
**Pexip Swift SDK** is released under the Apache Software License, version 2.0.
See [LICENSE](https://github.com/pexip/pexip-swift-sdk/blob/main/LICENSE) for details.