iOS

This article will help you to start building your iOS application with Voximplant.

There are two methods to incorporate Voximplant libraries into your Xcode project: Cocoapods and Swift Package Manager.

1. Install CocoaPods (Refer to the CocoaPods getting started guide)
2. If you don’t have a podfile, create one by executing pod init in the project directory.
3. Add the VoxImplantSDK dependency to the Podfile:

platform: ios, '11.0'
use_frameworks!

target 'MyApp' do
    // other dependencies and configurations
    pod 'VoxImplantSDK'
end

4. Execute the pod install command in the project directory to install the SDK.
5. From now on, open your project using the newly created .xcworkspace file.

Alternatively, you can use Swift Package Manager to add the dependencies to your project.

1. Open your project in Xcode.
2. Go to File → Swift Packages → Add Package Dependency.
3. Add the iOS SDK GitHub repository contents.
4. Select the desired SDK version.
5. Declare the package in the Package.swift file’s dependencies section:

dependencies: [
    .package(url: "https://github.com/voximplant/ios-sdk-releases.git", .upToNextMinor(from: "2.53.0"))
]

1. If you intend to use the camera and microphone in your app, open the Info.plist file in your project and add the following keys:

Provide values for these added keys. These values represent what a device displays when it prompts for camera or microphone access.

2. Declare four Background modes. Go to your project’s main file, navigate to the Singing & Capabilities tab, and click the “+” button at the top. Select “Background modes” from the dropdown menu. To enable call and push notification functionalities, choose the following modes as depicted in the screenshot:

Now, you are ready to create a Voximplant client instance. To do this, import VoxImplantSDK into your Swift class and create an instance of VIClient as shown below:

To create a client instance and connect, import VoxImplantSDK into your Swift class. Additionally, your class must conform to the VIClientSessionDelegate protocol.

On class initialization, create a Voximplant client instance and declare your class as a session delegate for the client instance (see the code example below). Then, call the connect method to connect to the cloud.

In the clientSessionDidConnect function, call the login(password) method to log in to the platform using a password. Alternatively, use the login(oneTimeKey) method to log in using a one-time key.

Refer to this code example to understand the login process:

Now that your application and SDK are set up and successfully connected to the Voximplant cloud, you can start implementing the desired functionality, such as making calls, participating in conferences, sending messages, and more. To achieve this, visit the Guides section of our documentation and select the features that align with your needs.

To implement the desired functionality, follow the step-by-step Guides or download and test our latest iOS SDK: