Getting Started with the Temasys SDK for iOS

A step-by-step guide to embedding Real-Time Communication features into your iOS application

This document is designed to help developers get started using the Temasys SDK for iOS to add video & voice calling, secure messaging, and more to their iOS application. Let’s get started!

Step 1: Create an Account on the Temasys Console (Skip to Step 5 if you have already created an account and generated an App key)

The first step to getting started is to create an account on the Temasys Console here: https://console.temasys.io/register.

The Temasys Console is where you’ll be able to create an App Profile and get an App Key.Once you create an account, you will receive a verification email.

Click the link in the verification email, and then log into the Temasys Console to let the fun begin.

Step 2: Create an App Profile

 
    Once you’ve logged into the Temasys Console, choose Manage Apps.
    Here you will see the Create App form where you can create your App Profile.
    Add your Application’s name, brief description, related website, the category and how many users you expect to be using your app.
    Click Create.

Step 3: Select a Billing Option

You’ll see a Billing screen with two options.

Whichever billing plan you select, you will have at least 30 days of a Free trial while you’re creating and testing your app.

Click Subscribe to confirm your billing option.

Once you’re ready to roll-out your app, you may want to come back to this screen and select the option that best fits your needs.

Step 4: Get an App Key

    Once you’ve logged into the Temasys Console, choose Manage Apps.
    Here you will see the Create App form where you can create your App Profile.
    Add your Application’s name, brief description, related website, the category and how many users you expect to be using your app.
    Click Create.

Step 5: Set up a new Xcode project workspace

These are the simple steps to set up an empty Xcode project.

We recommend you install the SDK via Cocoapods. If you don’t have Cocoapods installed, please follow these steps:

Step 6: Install the Temasys SDK for iOS

Step 7: Configure Settings

STEP 8: Initializing the Temasys SDK for iOS

The main idea is to prepare and create a connection to a room via the Temasys platform. After that, you will be able to send messages to the connection and implement the desired protocols to control what happens between the local device and the peers.

Temasys SDK for iOS provides 3 classes:

Here is an example connection code:

// Creating configuration
SKYLINKConnectionConfig *config = [SKYLINKConnectionConfig new];
config.video = YES;
config.audio = YES;

// Creating SKYLINKConnection
self.skylinkConnection = [[SKYLINKConnection alloc] initWithConfig:config appKey:self.skylinkApiKey];
self.skylinkConnection.lifeCycleDelegate = self;
self.skylinkConnection.mediaDelegate = self;
self.skylinkConnection.remotePeerDelegate = self;

// Connecting to a room
[self.skylinkConnection connectToRoomWithSecret:self.skylinkApiSecret roomName:ROOM_NAME userInfo:nil];

Step 9: Implement Protocols

The common next step is to implement protocols. The Temasys SDK for iOS provides 6 protocols:

The SKYLINKConnectionLifeCycleDelegate and the SKYLINKConnectionRemotePeerDelegate are the most important. These will give you general details about the lifecycle and the peers that are joining and leaving your application. It is advised to implement them for all applications.

MediaDelegates need to be implemented if you are using the Temasys SDK for simply adding video/voice communication capabilities. Similarly, MessagesDelegate and FileTransferDelegate can be implemented based on whether you require messaging and data transfer capabilities for your application. You get the idea!

That’s about it. We can’t wait to see what you’ll create with Temasys technology!

We hope you enjoy getting started with the Temasys SDK for iOS! Have fun, share this and let us know if you run into any issues!

ADDITIONAL RESOURCES

Here are some useful links:

Temasys Developer Console

How to get support or contribute

Sample App

Have a look at the iOS Sample App and its readme on Github. It provides simple example ways to build video calls, multi-party video calls, audio calls, chat rooms and file transfer rooms. https://github.com/Temasys/SkylinkSDK-iOS-Sample

This document applies to Temasys SkylinkSDK for iOS version 1.2.0

Leave a Reply

Your email address will not be published. Required fields are marked *

Comments

No comments yet.