Home

Awesome

OpenTok Annotations Accelerator Pack for iOS

<img src="https://assets.tokbox.com/img/vonage/Vonage_VideoAPI_black.svg" height="48px" alt="Tokbox is now known as Vonage" />

This project is deprecated

The OpenTok Annotations Accelerator Pack for iOS project is now a part of Accelerator Core iOS

This document describes how to use the OpenTok Annotations Accelerator Pack for iOS.

Inside it you will find the following sections:

Prerequisites

To be prepared to develop with the OpenTok Annotations Accelerator Pack for iOS:

  1. Get values for API Key, Session ID, and Token. See Obtaining OpenTok Credentials for important information.
  2. Install Xcode version 5 or later, with ARC enabled.
  3. Your device must be running iOS 8 or later.

Obtaining OpenTok Credentials

To use OpenTok's framework you need a Session ID, Token, and API Key you can get these values at the OpenTok Developer Dashboard . For production deployment, you must generate the Session ID and Token values using one of the OpenTok Server SDKs.

Quickstart

To get up and running quickly with your app, go through the following steps:

  1. Add the library.
  2. Configure and build the app.

Add the library

To add the library and start with your development, go through the following steps using CocoaPods:

  1. Add the following line to your pod file: pod 'OTAnnotationAccelerator'
  2. In a terminal prompt, navigate into your project directory and type pod install. (Sometimes, pod update is magical)
  3. Reopen your project using the new *.xcworkspace file.

NOTE: For more information about CocoaPods, including installation instructions, visit CocoaPods Getting Started.

Configure and build the app

Configure the sample app code. Then, build and run the app.

  1. Have at hand your values for API Key, Session ID, and Token. See Obtaining OpenTok Credentials.

  2. Replace the following empty strings with the corresponding API Key, Session ID, and Token values in AppDelegate.m:

    - (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {

    // Override point for customization after application launch.    
    [OTAcceleratorSession setOpenTokApiKey:@""
                                 sessionId:@""
                                     token:@""];
    return YES;
}

  3. Use Xcode to build and run the app on an iOS simulator or a device.

Exploring the code

For detail about the APIs used to develop this accelerator pack, see the OpenTok iOS SDK Reference.

NOTE: This accelerator pack collects anonymous usage data for internal TokBox purposes only. Please do not modify or remove any logging code from this sample application.

Class design

The following classes represent the software design for the OpenTok Annotations Accelerator Pack.

ClassDescription
OTAnnotatorThe core component for enabling remote annotation across devices and platforms.
OTAnnotationScrollViewProvides essentials components for annotating on either the entire screen or a specified portion of the screen.
OTAnnotationToolbarViewA convenient annotation toolbar that is optionally available for your development. As an alternative, you can create your own toolbar using OTAnnotationScrollView.
OTFullScreenAnnotationViewControllerA convenient view controller enables you to annotate the whole screen immediately.

Annotation features

The OTAnnotationScrollView class is the backbone of the annotation features in this Sample.

self.annotationView = [[OTAnnotationScrollView alloc] init];
self.annotationView.frame = <# desired frame #>;
[self.annotationView initializeToolbarView];
self.annotationView.toolbarView.frame = <# desired frame #>;

If you would like to be annotated on either the entire screen or a specified portion of the screen:

self.annotator = [[OTAnnotator alloc] init];
[self.annotator connectForReceivingAnnotationWithSize:<# desired size #>
                                    completionHandler:^(OTAnnotationSignal signal, NSError *error) {
                                        if (signal == OTAnnotationSessionDidConnect){
                                            self.annotator.annotationScrollView.frame = self.view.bounds;
                                            [self.view addSubview:self.annotator.annotationScrollView];
                                        }
                                    }];

self.annotator.dataReceivingHandler = ^(NSArray *data) {
    NSLog(@"%@", data);
};

If you would like to annotate on a remote client's screen:

self.annotator = [[OTAnnotator alloc] init];
[self.annotator connectForSendingAnnotationWithSize:self.sharer.subscriberView.frame.size
                                completionHandler:^(OTAnnotationSignal signal, NSError *error) {
    
                                    if (signal == OTAnnotationSessionDidConnect){
        
                                        // configure annotation view
                                        self.annotator.annotationScrollView.frame = self.view.bounds;
                                        [self.view addSubview:self.annotator.annotationScrollView];

                                        // self.sharer.subscriberView is the screen shared from a remote client.
                                        // It does not make sense to `connectForSendingAnnotationWithSize` if you don't receive a screen sharing.
                                        [self.annotator.annotationScrollView addContentView:self.sharer.subscriberView];
        
                                        // configure annotation feature
                                        self.annotator.annotationScrollView.annotatable = YES;
                                        self.annotator.annotationScrollView.annotationView.currentAnnotatable = [OTAnnotationPath pathWithStrokeColor:[UIColor yellowColor]];
                                    }
                                }];

self.annotator.dataSendingHandler = ^(NSArray *data, NSError *error) {
    NSLog(@"%@", data);
};

3rd Party Libraries

Development and Contributing

Interested in contributing? We :heart: pull requests! See the Contribution guidelines.

Getting Help

We love to hear from you so if you have questions, comments or find a bug in the project, let us know! You can either:

Further Reading