Set up a voice app with the Speebly Client SDK

Follow the instructions below to install the iOS SDK into your app.

Get support in the Speebly Facebook Group

System Requirements

The Speebly SDK for iOS supports the following:

  • iOS 13+
  • XCode 11+
  • Git
  • Cocoapods
  • iOS device or simulator running iOS 13 +

Introduction

Objective

  • To demonstrate how to add voice to an iOS app using the SpeeblyClientSDK (Note that Speebly does not add any UI views to your app)

Project setup

Step 1: Request your Speebly Client ID

Step 2: Get the sample app from github

Step 3: Add Speebly Client SDK to the sample app using CocoaPods

Step 4: Use Xcode and configure the Speebly Client SDK

Step 5: Run app and wait for voice response

Step 1: Request a Client ID from Speebly

Step 2: Get the sample app from github

In Terminal clone the ios-basic-voice-app

Open a new Terminal window

root directory 

  • When you open a new Terminal window it opens to the root directory.

in your root make a folder called speebly

  • Run: mkdir speebly

Change directory to speebly

  • Run: cd speebly

Clone sample app

Change directory to 

Run: cd ios-basic-voice-app/begin/BasicVoiceApp 

Your ios-basic-voice-app/begin/BasicVoiceApp directory should look like this:

Step 3: Add Speebly Client SDK to the BasicVoiceApp using CocoaPods

Using the same terminal as above. (if you have closed the above terminal window open a new terminal window and navigate to speebly/ios-basic-voice-app/begin/BasicVoiceApp)

Speebly uses CocoaPods to install and manage dependencies. 

  • Create a Podfile 
    • In speebly/ios-basic-voice-app/begin/BasicVoiceApp run; Pod init
  • After running pod init your BasicVoiceApp directory should look like this
  • In Finder navigate to speebly/ios-basic-voice-app/begin/BasicVoiceApp
  • Open the Podfile with your favourite text editor. (I’m using Visual Studio Code)
  • When you open the podfile it should look like this:
  • Copy the following text and paste under # use_frameworks
pod 'speeblyclientsdk', '0.2.0', :source => "https://github.com/speebly/ios-client-framework-podspec.git"
pod 'SwiftGRPC'
  • In line 2,  # platform : ios, ‘9.0’, replace with platform : ios, ‘13.2’
  • Save the file 
  • Your Podfile should now look like this
  • In the Terminal window
    • Run: pod install
    • This creates an Xcode workspace project file called BasicVoiceApp.xcworkspace. 
  • After you run pod install your Terminal window should look like this:

Step 4: Use Xcode to configure the Speebly Client SDK

  • In Finder navigate to speebly/ios-basic-voice-app/begin/BasicVoiceApp directory
  • Your BasicVoiceApp directory should look like this
  • Click on BasicVoiceApp.xcworkspace and Xcode will open with the SpeeblyClientSDK added to the project
  • Open AppDelegate.swift
  • Add your client Id and client key 

Step 5: Run app and wait for voice response

The simulator should look like the below:

If you have an error related to your plist, add a build and version number as per below:

Get support in the Speebly Facebook Group