The SDK described here is deprecated. Please consider upgrading your app to our new SDK. 

The VideoEngager SDK for iOS allows to integrate SmartVideo application in your own iOS mobile applications. This way, you would enable your customers to call your agents directly from your iOS application. 

Install

SDK is distributed as a dynamic iOS framework that you can drag and drop into your existing projects.

Once you've downloaded and unpacked the framework, navigate to your Xcode project's General settings page. Drag and drop VideoEngager.framework onto the Embedded Binaries section. Ensure that "Copy items if needed" is checked and press Finish. This will add VideoEngager.framework to both the Embedded Binaries and Linked Frameworks and Libraries sections. You'll also need to add -ObjC to the Other Linker Flags in your app project settings. You will need to add the provided SocketRocket.framework as well.

SDK API

Obtain instance

The recommended way to install VideoEngager into your application is to place a call to +startWithContainerPath:andServerAddress: in your -application:didFinishLaunchingWithOptions: or -applicationDidFinishLaunching: method.

NSURL* serverAddress = [NSURL URLWithString:@"https://videome.leadsecure.com"];

NSURL* containerPath = [NSURL fileURLWithPath: [self supportDirectory]];

VideoEngager *videoEngager = [VideoEngager startWithContainerPath:containerPath andServerAddress:serverAddress];

Join an agent

Joins the agent by the given path. The process is asynchronous.

@param agentPath The agent's path (e.g. "john" or "sales/john")
@param name Optional visitor's name
@param email Optional visitor's email address
@param phone Optional visitor's phone number
@param completionHandler A callback called once the join process has been completed

- (void) joinWithAgentPath: (NSString*) agentPath
                  withName: (NSString*) name
                 withEmail: (NSString*) email
                 withPhone: (NSString*) phone
            withCompletion: (void (^__nonnull)(NSError* __nullable error, VDEAgent* __nullable agent)) completionHandler;

Joins the agent by the given url. The process is asynchronous.

Joins the agent by the given path. The process is asynhcronous.
@param agentPath The agent's path (e.g. "john" or "sales/john")
@param pureCloud Mandatory PureCloudParameters
@param completionHandler A callback called once the join process has been completed

- (void) joinWithAgentPath: (NSString*) agentPath
     pureCloud: (VDEPureCloudParameters*) parameters
withCompletion: (void (^__nonnull)(NSError* __nullable error, VDEAgent* __nullable agent)) completionHandler;

Disconnect

Disconnects from the connected agent if any. The process is asynhcronous.

@param completionHandler A callback called once the disconnect process has been completed

- (void) disconnectWithCompletion: (void (^__nonnull)(NSError* __nullable error)) completionHandler;

UX/UI

SDK provide a high level API to present agent's In Call functionality To get the View controller with this functionality invokde the VideoEngager's agentViewController API

- (VDEAgentViewController*) agentViewController;

Minimum Supported Version 

We support iOS 11.0 onwards.

Demo App

We also offer a demo app as part of the SDK that is supposed to facilitate the integration process and demonstrate how our SDK works. 

If you have any questions, please contact our support team, and we will be happy to help.