A developer friendly sample implementation of Spark client SDK and showcases all SDK features.
Switch branches/tags
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
KitchenSink.xcodeproj fix pod file Apr 28, 2018
KitchenSink
KitchenSinkBroadcastExtension
KitchenSinkBroadcastExtensionSetupUI update for message api changed Apr 23, 2018
ScreenShots update readme img Apr 23, 2018
.gitignore
LICENSE Use master branch of SDK May 19, 2017
Podfile [COLLAB-3990]fix buuild failed Aug 9, 2018
README.md Update README.md Jul 6, 2018

README.md

Kitchen Sink

Kitchen Sink is a developer friendly sample implementation of Spark client SDK and showcases all SDK features. It focuses on how to call and use "Spark-SDK" APIs. Developers could directly cut, paste, and use the code from this sample. It basically implements “Spark-SDK” APIs by sequence.

Screenshots

  1. ScreenShot-1: Main page of Application, listing main functions of this demo.
  2. ScreenShot-2: Calling people/room page.
  3. ScreenShot-3: Iniciate call page, contains call recent/search/email/group.
  4. ScreenShot-4: Show messaing APIs with present payloads.

Download App

You can download our Demo App from TestFlight.

  1. Download TestFlight from App Stroe.
  2. Use this portal to register as our external tester:register portal
  3. Check your Email to get your test Redeem code,put this code into TestFlight.
  4. Install Ktichen Sink App from TestFlight.

Setup

Here are the steps to setup Xcode project using CocoaPods:

  1. Install CocoaPods:

    gem install cocoapods
  2. Setup Cocoapods:

    pod setup
  3. Install SparkSDK and other dependencies from your project directory:

    pod install

Example

The "// MARK: " labels in source code have distinguished the SDK calling and UI views paragraphes.
Below is code snippets of the SDK calling in the demo.

  1. Setup SDK with app infomation, and authorize access to Spark service

    class SparkEnvirmonment {
        static let ClientId = "your client ID"
        static let ClientSecret = ProcessInfo().environment["CLIENTSECRET"] ?? "your secret"
        static let Scope = "spark:all"
        static let RedirectUri = "KitchenSink://response"
     }
  2. Register the device to send and receive calls.

    var sparkSDK: Spark?
    /*  
    Register phone to Cisco cloud on behalf of the authenticated user.
    It also creates the websocket and connects to Cisco Spark cloud.
    - note: make sure register phone before calling
    */
    sparkSDK?.phone.register() { [weak self] error in
        if let strongSelf = self {
            if error != nil {
                //success...
            } else {
                //fail...
            }
        }
    }
  3. Spark calling API

     // Self video view and Remote video view
     @IBOutlet weak var selfView: MediaRenderView!
     @IBOutlet weak var remoteView: MediaRenderView!
    
     var sparkSDK: Spark?
     // currentCall represents current dailing/received call instance
     var currentCall: Call?
     
     // Make an outgoing call.
     // audioVideo as making a Video call,audioOnly as making Voice only call.The default is audio call.
         var mediaOption = MediaOption.audioOnly()
         if globalVideoSetting.isVideoEnabled() {
             mediaOption = MediaOption.audioVideo(local: self.selfView, remote: self.remoteView)
         }
         // Makes a call to an intended recipient on behalf of the authenticated user.
         sparkSDK?.phone.dial(remoteAddr, option: mediaOption) { [weak self] result in
             if let strongSelf = self {
                 switch result {
                 case .success(let call):
                     self.currentCall = call
                     // Callback when remote participant(s) is ringing.
                     call.onRinging = { [weak self] in
                         if let strongSelf = self {
                             //...
                         }
                     }
                     // Callback when remote participant(s) answered and this *call* is connected.
                     call.onConnected = { [weak self] in
                         if let strongSelf = self {
                             //...
                         }
                      }
                     //Callback when this *call* is disconnected (hangup, cancelled, get declined or other self device pickup the call).
                     call.onDisconnected = {[weak self] disconnectionType in
                         if let strongSelf = self {
                             //...
                         }
                     }
                     // Callback when the media types of this *call* have changed.
                     call.onMediaChanged = {[weak self] mediaChangeType in
                         if let strongSelf = self {
                             strongSelf.updateAvatarViewVisibility()
                             switch mediaChangeType {
                             //Local/Remote video rendering view size has changed
                             case .localVideoViewSize,.remoteVideoViewSize:
                                 break
                             // This might be triggered when the remote party muted or unmuted the audio.
                             case .remoteSendingAudio(let isSending):
                                 break
                             // This might be triggered when the remote party muted or unmuted the video.
                             case .remoteSendingVideo(let isSending):
                                 break
                             // This might be triggered when the local party muted or unmuted the video.
                             case .sendingAudio(let isSending):
                                 break
                             // This might be triggered when the local party muted or unmuted the aideo.
                             case .sendingVideo(let isSending):
                                 break
                             // Camera FacingMode on local device has switched.
                             case .cameraSwitched:
                                 break
                             // Whether loud speaker on local device is on or not has switched.
                             case .spearkerSwitched:
                                 break
                             default:
                                 break
                             }
                         }
                     }
                 case .failure(let error):
                     _ = strongSelf.navigationController?.popViewController(animated: true)
                     print("Dial call error: \(error)")
                 }
             }
         }
         
     // Receive a call
     if let phone = self.spark?.phone {
             // Callback when call is incoming.
             phone.onIncoming = { [weak self] call in
                 if let strongSelf = self {
                     self.currentCall = call
                     //...
                 }
             }
     }
     
     /* 
      Answers this call.
      This can only be invoked when this call is incoming and in rining status.
      Otherwise error will occur and onError callback will be dispatched.
      */
      self.currentCall?.answer(option: mediaOption) { [weak self] error in
          if let strongSelf = self {
              if error != nil {
                     //...
              }
          }
      }
     
     /* 
      Rejects this call. 
      This can only be invoked when this call is incoming and in rining status.
      Otherwise error will occur and onError callback will be dispatched. 
     */
     self.currentCall?.reject() { error in
             if error != nil {
                 //...
             }
     }
     
     /* 
      Sharing screen in this call
     */
     self.currentCall?.oniOSBroadcastingChanged = {
         event in
         if #available(iOS 11.2, *) {
             switch event {
             case .extensionConnected :
                 call.startSharing() {
                     error in
                     // ...
                 }
                 break
             case .extensionDisconnected:
                 call.stopSharing() {
                     error in
                     // ...
                 }
                 break
             }
         }
     }
  4. Enable and using screen share on your iPhone

    4.1 Add screen recording to control center:

     4.1.1 Open Settings -> Control Center -> Customize Controls
     
     4.1.2 Tap '+' on Screen Recording
    

    4.2 To share your screen in KitchenShink:

     4.2.1 Swipe up to open Control Center
     
     4.2.2 Long press on recoridng button
     
     4.2.3 select the KitchenSinkBroadcastExtension, tap Start Broadcast button
    

Buddies-App

Here is another demo app-"Buddies", which is more implemented as production application, combined call functionalities with CallKit, included message/call UI-implementation which could be used as widgets. GitHub-Buddies