Skip to content

Latest commit

 

History

History
192 lines (135 loc) · 7.4 KB

README.md

File metadata and controls

192 lines (135 loc) · 7.4 KB
Raw

SkylinkSDK iOS SampleApp Swift

The Swift Sample Application(SA), which uses the latest version of the Skylink SDK for iOS, demonstrates its use to provide embedded real time communication in the easiest way. Excluding 'Settings', this App has 6 distinct view controllers, each of them demonstrating how to build the following features:

  • One to one video call with Screen Share
  • Multi party video call
  • Multi party audio call
  • Chatroom and custom messages
  • File transfer
  • Data transfer

Code introduction

The code should be self explanatory. Each view controller works by itself and there is minimal UI code due to to Storyboard usage. In each view controller, the main idea is to configure and instantiate a connection to a room with the Skylink iOS SDK. You will then be able to communicate with another peer joining the same room.

Sample Code
// SKYLINKConnection creation for video call room
lazy var skylinkConnection: SKYLINKConnection = {
    // Creating configuration
    let config = SKYLINKConnectionConfig()
    config.setAudioVideoSend(AudioVideoConfig_AUDIO_AND_VIDEO)
    config.setAudioVideoReceive(AudioVideoConfig_AUDIO_AND_VIDEO)  
    
    // Creating SKYLINKConnection
    if let skylinkConnection = SKYLINKConnection(config: config, callback: nil) {
        skylinkConnection.lifeCycleDelegate = self
        skylinkConnection.mediaDelegate = self
        skylinkConnection.remotePeerDelegate = self
        return skylinkConnection
    } else {
        return SKYLINKConnection()
    }
}()  

// Use SKYLINKConnection(with your key and secret) to connect to a room
skylinkConnection.connectToRoom(withAppKey: skylinkApiKey, secret: skylinkApiSecret, roomName: ROOM_NAME, userData: USER_NAME, callback: nil)

You can then control what happens in the room by sending messages to the SKYLINKConnection instance (like triggering a file transfer request for example), and respond to events by implementing the delegate methods from the 6 protocols. Always set at least the lifeCycleDelegate. For a list of all protocols, see here

Aditionally, in each view controller example's viewDidLoad/initWithCoder method, some properties are initialized. A disconnect button is set in the navigation bar (left corner) as well as its selector implementation (called disconnect). An info button is set on the right corner, as well as its implementation (called showInfos). Those 2 navigation bar buttons selectors are the same in every View Controller example.

The rest of the example view controllers gives you 6 example usages of the Temasys iOS SDK.

Swift Version Supported

Swift 5.1 and Swift 5.1.2

How to run the sample project

Step-by-step guide

Prerequisites

Please use Xcode version 11 or above.

STEP 1

It is recommended to install the SkylinkSDK for iOS via cocoapods. If you do not have it installed, follow the below steps:

Installing Cocoapods

Check that you have Xcode command line tools installed (Xcode > Preferences > Locations > Command line tools(?). If not, open the terminal and run xcode-select --install. Install cocoa pods in the terminal: $ sudo gem install cocoapods

STEP 2

Clone the repo or download the project.

STEP 3

Navigate to the Swift Sample App and Run pod install

STEP 4

Open the .xcworkspace file

STEP 5

Follow the instructions here to create an App and a key on the Temasys Console.

STEP 6

Set your App Key and secret in Constants.swift. You may also alter the room names here.

var APP_KEY = "ENTER APP KEY HERE"
var APP_SECRET = "ENTER SECRET HERE"
var ROOM_ONE_TO_ONE_VIDEO = "VIDEO-CALL-ROOM"
var ROOM_MULTI_VIDEO = "MULTI-VIDEO-CALL-ROOM"
var ROOM_AUDIO = "AUDIO-CALL-ROOM"
var ROOM_MESSAGES = "MESSAGES-ROOM"
var ROOM_FILE_TRANSFER = "FILE-TRANSFER-ROOM"
var ROOM_DATA_TRANSFER = "ROOMNAME_DATATRANSFER"
STEP 7

Build and Run. You're good to go!

Please Note

The XCode Simulator does not support video calls.
If you have connected a phone, ensure it is unlocked and the appropriate team is selected under Signing & Capabilities.

Resources

SDK documentation

For more information on the usage of the SkylinkSDK for iOS, please refer to SkylinkSDK for iOS Readme

Subscribe

Star this repo to be notified of new release tags. You can also view release notes on our support portal

Feedback

Please do not hesitate to reach get in touch with us if you encounter any issue or if you have any feedback or suggestions on how we can improve the Skylink SDK for iOS or Sample Applications. You can raise tickets on our support portal.

Copyright and License

Copyright 2019 Temasys Communications Pte Ltd Licensed under APACHE 2.0

Tutorials and FAQs

Getting started with Temasys iOS SDK for iOS
Handle the video view stretching
FAQs

Also checkout our Skylink SDKs for Web and Android

This document was edited for Temasys iOS SDK version 2.0.0

Persistent Message Caching

How to integrate persistent message cache feature to your application.

1. Change pod 'SKYLINK' entry in the Podfile.

Podfile

pod 'SKYLINK', '~> 2.3.1'
# pod 'SKYLINK', :git => 'https://github.com/Temasys/SKYLINK-iOS.git', :tag => '2.3.1'

2. Install updated CocoaPods dependency.

$ pod install

3. Enable message cache feature in SKYLINKConnectionConfig.

import SKYLINK_MESSAGE_CACHE

let config = SKYLINKConnectionConfig()
config.hasP2PMessaging = true
...

// Enable message cache feature
config.isMessageCacheEnabled = true

// Set maximum number of messages that will be cached per Skylink Room (default value is 50)
config.messageCacheLimit = 100

// Initialize SKYLINKConnection with message cache enabled config
let skylinkConnection = SKYLINKConnection(config: config, callback: nil)

Example : SampleAppSwift5/SampleApp_Swift/MessagesViewController : Line#97

4. Get cached messages.

import SKYLINK_MESSAGE_CACHE

// Message cache feature is enabled?
if (SkylinkMessageCache.instance().isEnabled) {
    // Get cached messages for the room "my-test-room"
    let cachedMessages = SkylinkMessageCache.instance().getReadableCacheSession(forRoomName: "my-test-room").cachedMessages()

    if (!cachedMessages.isEmpty) {
        for m in cachedMessages {
            if let dict = m as? [String: Any] {
                // dict["data"] as? String
                // dict["timeStamp"] as? Int64
                // dict["peerId"] as? String
            }
        }
    }
}

Example : SampleAppSwift5/SampleApp_Swift/MessagesViewController.swift : Line#237