Creating your own real time communication app
Applozic Audio-Video Call SDK provides high-quality IP audio and video calls capabilities within your application. With this SDK, your application's users can take part in secure 1-to-1 calls and automate workflows by building reliable conversation systems through voice-calling and video-calling. You can create a standalone application for communication using this SDK, or integrate it with your existing application.
Note: The Voice and Video SDK is a beta product and new features will be added in the upcoming months.
If you face any difficulties while following this tutorial, you can contact us at firstname.lastname@example.org.
To check out our cocoapods sample app, click here.
Here are some of the dependencies you will need:
- Xcode 12.0 or later
- CocoaPods 1.9.0 or later
- Your project must target iOS 11 or higher
Note: We are assuming the following application is going to be written using Objective-C. For corresponding code in Swift, please check the documentation linked within each section.
To use the Applozic iOS Audio Video SDK and leverage pre-built components that you can easily customize, you can sign up for Applozic and get your APP_ID from the install section of the console.
Installation - Setup the building blocks for audio and video capabilities
- ApplozicAudioVideo is available through CocoaPods.
- To install it, setup your Podfile located at /ios/Podfile and add below pod dependency:
- Navigate to YourApp/ios directory from terminal and run the below command:
Note: If you do not have pod dependency, check out how to get started here.
The Audio-Video Call SDK includes our iOS messaging SDK. If you have added the pod 'Applozic' in your Podfile please remove that and replace it with 'ApplozicAudioVideo'.
Add permissions for Camera, Photo Library, Microphone, Contacts and Location usage.
Note: We won't be asking the users for these permissions unless they use the respective feature. Due to Apple's requirement, we have to add these permissions if we are using any of their APIs related to Camera, Microphone, etc.
Open Info.plist from /ios/YOUR_PROJECT_NAME/Info.plist file and paste
these permissions anywhere inside the
Setup Application ID
Open the ALChatManager.h file and replace “applozic-sample-app” with your APP-ID.
Once you are at this stage, follow the Applozic documentation to complete the authentication, set up of user profiles and other such basic building blocks of your application.
Integration - Authenticate and set up push notification
Authentication serves two purposes here:
- It helps you to identify users i.e. differentiate between the users who have access to real time chat from those who do not have access to chat.
- It enables you to set up user profiles necessary for real time communication.
We have a detailed guide on setting up authentication for your application in our documentation. Once you have completed the steps, we can move on to the next stage.
Add Audio video configuration
Add below lines of code in ALChatManger.m's file in the method
ALDefaultChatViewSettings to enable the audio-video call capabilities.
Push Notification Setup
There are two types of push notifications that need to be set up at this stage.
- Apple Push Notification service (APNs) certificate, which enables you to send push notifications to your user's device.
- VOIP certificate, which is required for sending incoming call notification from applozic to your app
Setting up APNs Certificates
Applozic sends the communication payload to Apple servers, which then sends the push notification to your user's device.
Creating APNs certificates
For Apple to send push notifications to user devices, you need to create an APNs certificate in your Apple developer account.
- Visit this link, to create Apple Push Notification service SSL (Sandbox) i.e development certificate.
- Visit this link, to create Apple Push Notification service SSL (Sandbox & Production), i.e, distribution certificate.
Note: Supported format for APNs certificate is .p12
Once the certificates are created you can download them and export the p12 files with password for development and distribution certificate using Keychain Access in Mac.
Upload APNs Certificates
Go to Applozic console push notification section to upload the APNs development and distribution certificates. The following screenshot is what will be visible on the console for you:
Updating capabilities and customizing Chat UI
Follow the mentioned guides and that will bring us to the next stage of creating and setting up the VOIP certificates.
Setting up VOIP certificate
Creating and adding your VOIP certificate
VOIP certificate is required for sending incoming call notification from Applozic to your app
- Visit your Apple developer account, and create a VoIP Services Certificate. It should look like this:
Once the certificate is created in developer console,
- Download the certificate and export the p12 file with password from the downloaded certificate using Keychain Access in Mac.
- Contact email@example.com via email for uploading this VOIP certificate as we dont have the option to upload this from the Applozic console right now.
Note: You will need to send an email to firstname.lastname@example.org with your Applozic APP-ID and p12 VOIP certificate and password for uploading the p12 VOIP certificate as we don't have the option to upload this from the Applozic console right now.
Configuring Your App
Adding Capabilities to Your App
The next step is to set up capabilities to configure app services from Apple, such as push notifications, background modes, VOIP, etc.
- On the Xcode project’s Signing & Capabilities tab, Click (+ Capability) to add “Push Notifications”.
- Next Click (+ Capability) to add "Background modes" enable the following four options from Background Modes:
- Audio, AirPlay and Picture in Picture
- Voice over IP
- Background fetch
- Remote notifications
Your screen should look like the following screenshot:
Configure the push notification in the Appdelegate file of your project
NOTE: Without push notifications set-up, calls won't work as call notification requires a VOIP notification. Please make sure the push notifications are set-up properly.
Add the below imports in the Appdelegate file:
Register PushRegistry for VOIP notification
The below code can be used to register the push notifications.
If you have added the method registerForNotification
from the basic notification setup then you can replace
it with the below registerForNotification method code.
Add the notification handler for VOIP
In your Appdelegate file find the method didFinishLaunchingWithOptions and add the below code just below the ALAppLocalNotifications handler:
Sending an APNs and VOIP device token to Applozic server
The below code will enable you to send the APNs and VOIP device token to Applozic server.
If you added the code from the basic push notification
setup before for didRegisterForRemoteNotificationsWithDeviceToken
you will need to remove that and add the following code:
Receiving push notification
Once your app receives notification, you need to pass it to the Applozic handler for chat notification processing.
If you have added the didReceiveRemoteNotification
UIBackgroundFetchResult method from the basic push notification
please remove that UIBackgroundFetchResult method and replace it
with the below code in the Appdelegate file:
We began this article by discussing the essential need behind enabling real time communication in your application with voice and video capabilities. A few key features that we wanted to implement were secure 1 to 1 voice and video calls, push notifications and capability to integrate these with your existing application.
In order to implement these features, first we began by installing the building blocks for audio and video capabilities and set up your application with the required permissions.
Next, we integrated a few critical development blocks by setting up authentication and push notification services.
Finally, we have walked through the configuration pieces of the capabilities that can be added to your application and explained how we can customize them as well.
As we end this tutorial, you should be all set to continue experimentation with your application and add more features like rich messaging, multi-format attachments, etc.