Get Started

Quick Start

MeetTalk iOS SDK provides all of the features available in the PowerTalk SDK, with the addition of voice and video call feature. This page presents a brief overview of the SDK’s structure and abilities, then lets you go through the preliminary steps of implementing the SDK in your own app.

Configure and Initialize TapTalk.io iOS SDK

The first step to configure MeetTalk SDK will be the same as configuring PowerTalk SDK, if you have completed this step, you can skip to Step 2.

Step 1: Create a new application from your dashboard

1. Login to TapTalk.io Dashboard, then choose Development -> Apps

2. Click New App Button, input App Name and choose Platform, and then click Create New App Button.

3. A pop-up dialog will be shown with provided App Key ID & App Key Secret

Note: Please remember to save your App Key ID & your App Key Secret because it will only be shown once and will be used in TapTalk.io initialization

Step 2: Install MeetTalk SDK

You can install the MeetTalk iOS SDK using CocoaPods like the following. If you are new to CocoaPods, you can see more information in Cocoapods guides. To create a Podfile, open a terminal window, navigate to your project directory, and then create a Podfile by running the following command:

$ pod install

Then Podfile will be created in your project directory. Open the Podfile and add the following lines to the Podfile.

# Please make sure you define platform on your Podfile
# Make sure to use ios 12.0 for minimum deployment target

platform :ios, '12.0'

target "YourProjectName" do
    pod 'MeetTalk'
    pod 'AFNetworking', '~> 4.0.0', :modular_headers => true
    pod 'JSONModel', '~> 1.1', :modular_headers => true
end

Since TapTalk.io use uses git-lfs (Git Large Files Storage) you will need to install GIT LFS to clone/install TapTalk.io SDK through Cocoapods.

Note: Make sure to install git-lfsbefore pod install, otherwise the pod install / pod update will return an error

Easiest way to install git-lfs is using brew:

brew install git-lfs
git lfs install

Next, after the git-lfs is installed, install the MeetTalk SDK through CocoaPods.

$ pod install

Step 3: Grant permission in your application project

To make sure TapTalk.io has all permission to access the user's media, file, location, and contact, the application needs to ask for permission. Go to your info.plist, and add the following key-value pairs.

Information Property Key

Information Property Value

Privacy - Camera Usage Description

$(PRODUCT_NAME) needs to request access to your camera to take profile picture and to send image chat.

Privacy - Contacts Usage Description

$(PRODUCT_NAME) need your permission to access your contact, we will sync your contact to our server and automatically find your friend so it is easier for you to find your friends.

Privacy - Photo Library Additions Usage Description

$(PRODUCT_NAME) needs to request access to your photo library to save photo.

Privacy - Photo Library Usage Description

$(PRODUCT_NAME) needs to request access to your photo library to take profile picture and to send image chat.

Privacy - Location When In Use Usage Description

$(PRODUCT_NAME) needs to request access to your location to send location chat.

Privacy - Microphone Usage Description

$(PRODUCT_NAME) needs to request access to your microphone to record audio and send voice chat

Privacy - Calendars Usage Description

$(PRODUCT_NAME) needs to request access to your calendar

Note: You can change Information Property Value with your preferred words, the string value will be displayed when the application requests the permission.

Step 4: Enable background modes

Background modes is required to handle background process in TapTalk.io. It is used to run some processes in the background before the app is killed. For more information about the processes, check out the background process section. To enable background modes, go to Target -> Capabilities, then turn Background Modes toggle to ON, next select Background fetch, Remote notifications, and Voice over IP.

Step 5: Disable Bitcode for your Project Target

MeetTalk iOS SDK currently requires bitcode to be disabled in the project target's Build Settings.

To disable bitcode, go to your Project in the project navigator on the left panel of the Xcode screen, select your Target, then select Build Settings and search for "bitcode", then set the value to No.

Step 6: Initialize MeetTalk in your Application class

In order to use MeetTalk, you must first initialize a MeetTalk instance by passing the APP_KEY_ID, APP_KEY_SECRET, APP_BASE_URL, and IMPLEMENTATION_TYPE assigned to your application to the initWithAppKeyID:appKeySecret:apiURLString:implementationType: method as a parameter. Generally, initialization is implemented in the appDelegate application:didFinishLaunchingWithOptions: method.

Note: To get BASE_URL you can follow our documentation on how to get Base URL on TapTalk.io.

AppDelegate.m

// import MeetTalk
#import <MeetTalk/MeetTalk.h>

@interface AppDelegate() <MeetTalkDelegate, ...>

- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
 
  //Initialize TapTalk.io
  [[MeetTalk sharedInstance] initWithAppKeyID:APP_KEY_ID appKeySecret:APP_KEY_SECRET apiURLString:APP_BASE_URL implementationType:IMPLEMENTATION_TYPE];
  [[MeetTalk sharedInstance] setDelegate:self];
}

Parameters APP_KEY_ID: (String) application key ID APP_KEY_SECRET: (String) application key Secret APP_BASE_URL: (String) base API URL IMPLEMENTATION_TYPE: (enum) found in TapTalkImplentationType, more detailed information below

IMPLEMENTATION_TYPE TapTalkImplementationType consists of 3 types which are: TapTalkImplementationTypeUI: used for implementation with only TapUI TapTalkImplementationTypeCore: used for implementation with only TapCore TapTalkImplementationTypeCombine: used for implementation with both of TapCore and TapUI combined

Note: In the Event Delegate page, you can find detailed information on the usages of TapTalk iOS SDK's delegates and callbacks.

You may also call initWithAppKeyID:appKeySecret:apiURLString:implementationType:success: to obtain callback once the initialization is finished.

AppDelegate.m

// import MeetTalk
#import <MeetTalk/MeetTalk.h>

@interface AppDelegate() <MeetTalkDelegate, ...>

- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
 
  //Initialize MeetTalk
  [[MeetTalk sharedInstance] initWithAppKeyID:APP_KEY_ID 
                                 appKeySecret:APP_KEY_SECRET 
                                 apiURLString:APP_BASE_URL 
                           implementationType:IMPLEMENTATION_TYPE
                                      success:^{
        // Initialization finished
  }];
  [[MeetTalk sharedInstance] setDelegate:self];
}

Note: MeetTalk initWithAppKeyID: will also initialize a TapTalk instance, so If you have previously used PowerTalk in your application, replace TapTalk initWithAppKeyID: with MeetTalk initWithAppKeyID:

Step 7: Implement application delegate

To allow the iOS SDK to respond to the connection and state changes in your iOS client app, you have to implement all of our application delegate methods in your UIApplicationDelegate methods in appDelegate file. You can follow the instructions in Implement Application Delegate page.

Step 8: Authenticate to TapTalk.io

In order to use the abilities of the iOS SDK in your client app, a TapTalk instance must be initiated in each client app through user authentication with TapTalk.io server. An authenticated user account allows the instance to communicate and interact with the server. To authenticate your user with the server, follow the instructions in Authentication page.

Initialize Google Places API Key (Optional)

To enable location search result preview while sending location message, a Google Places API Key is required. To obtain the API key for your application, you can check the documentation provided by Google. To initialize, insert your obtained key using the initializeGooglePlacesApiKey() method.

#import <TapTalk/TapTalk.h>
  
- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
  
    //Initialize Google Places API Key
    [[TapTalk sharedInstance] initializeGooglePlacesAPIKey:GOOGLE_PLACES_API_KEY]; 
}

Parameters GOOGLE_PLACES_API_KEY: (String) Google Places API Key

Initiate New Call

Initiating a call in MeetTalk requires data from TAPRoomModel. which will then be used to construct a conference data for the call. To initiate a call, use the initiateNewConferenceCall method from MeetTalk class.

You may also customize the outgoing call using the provided parameters.

// Initiate a voice call (participants will enter call with video muted)
[[MeetTalk sharedInstance] initiateNewConferenceCallWithRoom:ROOM];

// Initiate a call with custom audio/video state
[[MeetTalk sharedInstance] initiateNewConferenceCallWithRoom:ROOM 
                                         startWithAudioMuted:START_WITH_AUDIO_MUTED 
                                         startWithVideoMuted:START_WITH_VIDEO_MUTED];

// Initiate a call with custom audio/video state and recipient display name
[[MeetTalk sharedInstance] initiateNewConferenceCallWithRoom:ROOM 
                                        recipientDisplayName:RECIPIENT_DISPLAY_NAME
                                         startWithAudioMuted:START_WITH_AUDIO_MUTED 
                                         startWithVideoMuted:START_WITH_VIDEO_MUTED];

Parameters ROOM: (TAPRoomModel) the chat room where the call will be initiated START_WITH_AUDIO_MUTED: (BOOL) initial state of the participants' microphone START_WITH_VIDEO_MUTED: (BOOL) initial state of the participants' front camera RECIPIENT_DISPLAY_NAME: (NSString) custom display name/nickname for the recipient that will be displayed during the call

When this method is called in personal chat room, the active user will start and enter the voice call, and send a notification to the recipient, which will then receive an incoming call. The recipient will join the voice call once the incoming call is answered.

Participants will still be able to mute/unmute their microphone/camera during the call regardless of the START_WITH_AUDIO_MUTED and START_WITH_VIDEO_MUTED parameter.

Note: Initiating a call is currently only available in personal chat rooms.

Note: You can check a more complete implementation guide in the PowerTalk iOS section.

PreviousMeetTalk iOS NextImplement Application Delegate

Last updated 11 months ago