Installing the SDK
This document explains how to install the the Dolby.io Communications iOS Client SDK into your application. You can install the SDK using either Cocoapods, Carthage, Swift Package Manager, or install the SDK manually. We recommend using the Swift Package Manager because it offers the package management capability that is built-in with Xcode and does not require any third-party tools.
Installing the SDK with Swift Package Manager
The Swift Package Manager is a tool for automating the process of downloading, compiling, and linking dependencies.
-
Select
File
▸Add Packages…
to add package dependency. -
In the opened window, find the search box and specify the URL to the SDK repository: https://github.com/voxeet/voxeet-sdk-ios.
-
Choose voxeet-sdk-ios from the results list.
-
Select the proper SDK version from the
Dependency Rule
dropdown list.
- Select the
Add Package
option.
Installing the SDK with CocoaPods
CocoaPods is a dependency manager for Swift and Objective-C projects that manages dependencies between libraries.
- Install CocoaPods:
sudo gem install cocoapods
- Add VoxeetSDK to the Podfile file to integrate the SDK into the Xcode project:
pod 'VoxeetSDK'
- Make sure that the iOS platform mentioned in Podfile is set to '11.0':
platform :ios, '11.0'
- Build dependencies:
pod install
- Open the created
.xcworkspace
project.
Installing the SDK with Carthage
Carthage is a dependency manager that you can use to add the SDK into the Xcode project.
- Install Carthage using Homebrew:
brew update
brew install carthage
- To integrate Dolby.io Communications SDK for iOS into your Xcode project, create a
Cartfile
file in the root folder of your project. Paste the following command to the file:
binary "https://raw.githubusercontent.com/voxeet/voxeet-sdk-ios/master/VoxeetSDK.json" ~> VERSION
Note: Use the latest iOS SDK version instead of the VERSION
string.
- Build the frameworks.
carthage update --use-xcframeworks
The built frameworks are located in Carthage/Build/iOS
. Add VoxeetSDK.xcframework
, WebRTC.xcframework
, dvclient.xcframework
, and dvdnr.xcframework
to your Xcode project as members of the application target. Turn off the Copy items if needed
option.
For more information, see the Carthage documentation.
- In the
General
tab of your target, make sure thatVoxeetSDK.xcframework
,WebRTC.xcframework
,dvclient.xcframework
, anddvdnr.xcframework
are added to the'Frameworks, Libraries, and Embedded Content'
with the'Embed & Sign'
option selected for both frameworks.
Installing the SDK manually
You can also install the SDK manually.
-
Download the latest iOS SDK release zip.
-
Unzip it and drag and drop
VoxeetSDK.xcframework
,WebRTC.xcframework
,dvclient.xcframework
, anddvdnr.xcframework
frameworks to your project. -
In the dialog that is displayed, select the
Copy items if needed
option and make sure that the frameworks are added to the proper target. -
In the
General
tab of your target, add theVoxeetSDK.xcframework
,WebRTC.xcframework
,dvclient.xcframework
, anddvdnr.xcframework
to the'Frameworks, Libraries, and Embedded Content'
with the'Embed & Sign'
option selected for both frameworks.
Updated 2 months ago