iOS - Swift

Overview

Follow this step by step tutorial to implement the video playback Synchronization SDK.

While the client-side SDK will take care of most of the functionality, in order to make this sample application work, you will need to use the API_KEY provided to you.

• Full code samples can be found here

  • Swift code sample

  • Objective-c adapter code samples

Requirements

To complete this guide successfully the following prerequisites are required:

• A Sceenic account

• Xcode

• Access key for Synch SDK

Authentication

To instantiate the synch SDK you will need to use the API_KEY in order to create a synchronization group.

Using the API_KEY we will identify you as a customer and allow the client to connect to the synchronization session.

The API_KEY can be acquired - here.

Create a project

• Open Xcode and create a new project

• Choose a Single View application

• Configure your product organization, bundle, and team names

• Set the application location on your computer and press “create”

Adding iOS SynchSDK library to the project

You can drag SynchSDK.framework to the project tree and use this library manually.

Cocoapods

• Download library (Private area) package and unpack it

• Create a folder with the name "SynchSDK" at the root of the project

• Copy all files ("SynchSDK.framework","SynchSDK.podspec") to the folder

• You can use Cocoapods to install SynchSDK by adding it to your Podfile pod 'SynchSDK', :path => './SynchSDK'

Instantiating the SDK

• Initialize SynchSDK object:

Swift

let synchSDK = SynchSDK(accessToken: token) //token - authorization token
    synchSDK.createGroup(groupId, clientName: clientName)// groupId - group identificator
                                                        // clientName - username
    synchSDK.attachListener(self)// self - SynchListener object

• Start synchronization - To start using the SynchSDK object you will require a SynchSdk’s URL and a valid Access Token to be available before connecting.

Swift

synchSDK.startSynchronize()

• Stop synchronization

Swift

synchSDK.stopSynchronize()

Managing synchronization logic

To manage the synchronization logic we provided several callbacks and will allow you to customize the interactions you need.

• The SynchListener interface, which the StreamView implements in the sample application, will allow you to control the flow of logic of the Synchronization you are managing

Swift

extension StreamView: SynchListener{
    func onClientList(clientList: [Client]) {
        // remote client joined to the group, update ui using adapter
    }
    
    func onSetPlaybackRate(rate: Float) {
        // setting playback rate
    }
    
    func onPlaybackFromPosition(position: Int) {
        // playback from position
    }
    
    func onGetPlayerPosition() -> Int {
        // getting player position
    }
    
    func onGetPlaybackRate() -> Float {
        // getting playback rate
    }
    
    func onSyncInfo(accuracy: Float, delta: Int) {
        // information about synchronization's accuracy and delta
    }
}

Support

Need technical support? contact us at [email protected].