Installing the Calls SDK is simple if you’re familiar with using external libraries or SDK’s in your projects. After creating your Sendbird application from your dashboard, install
Git Large File Storage (LFS), then you can choose to install the Calls SDK using either
The minimum requirements for Calls SDK for iOS are:
iOS 9.0 and later
Swift 4.0 and later
A Sendbird application comprises everything required in a Calls service including users, message, and channels. To create an application:
- Go to the Sendbird Dashboard and enter your email and password, and create a new account. You can also sign up with a Google account.
- When prompted by the setup wizard, enter your organization information to manage Sendbird applications.
- Lastly, when your dashboard home appears after completing setup, click Create + at the top-right corner.
Only one Sendbird application can be integrated per app for your service regardless of the platform. All users within your Sendbird application can communicate with each other across all platforms. This means that your iOS, Android, and web client app users can all make and receive calls with one another without any further setup. It should be noted that all data is limited to the scope of a single application, and users in different Sendbird applications can't make and receive calls to each other.
Note: For application administrators, the Sendbird Dashboard provides call logs to keep track of all calls made on the application.
To use Sendbird Calls, you should first add our custom-built
WebRTC framework to your project.
Git LFS must be installed to use the
WebRTC framework along with the
brew install git-lfsin your project directory.
- Refer to https://git-lfs.github.com.
Note: Make sure to install
Git LFSbefore installing
CocoaPods. Check the size of the
YOUR_PROJECT_DIRECTORY/Pods/SendBirdWebRTCfolder. The framework must be over 800 MB. If it is less than 800 MB, follow the steps in the Calls SDK’s Troubleshooting section.
- Install CocoaPods into your project by running
pod initin your project directory.
- Run the command,
- In the opened
pod ‘SendBirdCalls’to your configuration under your project target.
- Install the
SendBirdCallsframework by running
pod installin your project directory.
You can also use
Carthage to integrate the
SendBirdCalls framework into your Xcode project.
- Install Carthage into your project by running
brew install carthagein your project directory or choose another installation options.
- Create a
Cartfilein the same directory where your
github “sendbird/sendbird-webrtc-ios”dependencies to your
Cartfile.resolvedfile and a
Carthagedirectory will appear in the same directory where your
- Drag the built
Carthage/Build/iOSinto your application’s Xcode project.
- On your application targets’ Build Phases settings tab, click the + icon and choose New Run Script Phase. Create a Run Script in which you specify your shell (ex:
/bin/sh), add the following contents to the script area below the shell:
- Add the paths to the frameworks you want to use under Input Files. For example:
- Add the paths to the copied frameworks to the Output Files. For example:
- For more information, refer to the Carthage’s guide.
You can use the Calls SDK along with
Callkit in your app. To use some app services, you need to add background modes and push notifications to your app.
- For your app to continue running in the background, your app must have
Background Modesenabled in the Xcode Project > Signing & Capabilities pane. Select the
Voice over IPoption under the list of available modes.
Remote notificationsin Xcode Project > Signing & Capabilities.
- For more information about VoIP push notification and PushKit, refer to Apple's
Your iOS client app needs to display authorization messages to your users to grant the app access to camera and microphone.
- To access device microphones for audio call, include the
NSMicrophoneUsageDescriptionkey in your app’s
- To access device cameras for video call, include the
NSCameraUsageDescriptionin your app’s