OpenTok 2.23.0

OpenTok 2.23.0

License Commercial
ReleasedLast Release Jul 2022

Maintained by Jose Antonio Olivera Ortega, Sridhar Bollam, Client Platform Team - Video Engineering - Vonage.



OpenTok 2.23.0

  • By
  • TokBox, Inc.

OpenTok iOS SDK

The OpenTok iOS SDK lets you use OpenTok-powered video sessions in apps
you build for iPad, iPhone, and iPod touch devices.

All OpenTok applications are composed of two parts:

  • The client-side, which uses the OpenTok client
    SDKs
    and runs in a user's
    browser or mobile app
  • The server-side, which uses the OpenTok server
    SDKs
    and runs on your server
    to pass authentication information to the client.

The client SDK for building iOS apps is the OpenTok iOS SDK, which provides
most of the core functionality for your app, including:

  • Connecting to an OpenTok session
  • Publishing streams to a session
  • Subscribing to streams in a session

Client SDKs are also available for
Android and
web. All OpenTok client SDKs can interact with one another.

You can learn more about the basics of OpenTok clients, servers, sessions, and
more on the OpenTok Basics page.

Learning to build with the OpenTok iOS SDK

The best way to learn how to use the OpenTok iOS SDK is to follow the OpenTok
Basic Video Chat tutorial.

Once you understand the basics of building with the OpenTok iOS SDK, you
can get more detailed information and learn how to customize your application
with the OpenTok developer guides.
To investigate specific API classes and methods, see the OpenTok iOS SDK API
reference
.

Code samples

For samples using Swift, visit our Swift sample app
repo

on GitHub.

For samples using Objective-C, visit our Objective-C sample app
repo

on GitHub.

Interoperability

Apps written with the OpenTok iOS SDK 2.11.5 can interoperate with OpenTok apps
written with version 2.9+ of the OpenTok client SDKs:

  • OpenTok.js
  • OpenTok Android SDK
  • OpenTok iOS SDK
  • OpenTok Windows SDK

Using the SDK

The OpenTok.framework directory contains the OpenTok iOS SDK.

The OpenTok iOS SDK is available as the Pod "OpenTok", for use with
CocoaPods.

The OpenTok iOS SDK requires Xcode 7 or higher.

The OpenTok iOS SDK requires the following frameworks and libraries:

  • AudioToolbox.framework
  • AVFoundation.framework
  • CoreGraphics.framework
  • CoreMedia.framework
  • CoreTelephony.framework
  • CoreVideo.framework
  • Foundation.framework
  • GLKit.framework
  • libc++.dylib (libc++.tbd in Xcode 7+)
  • libsqlite3.dylib (libsqlite3++.tbd in Xcode 7+)
  • OpenGLES.framework
  • QuartzCore.framework
  • SystemConfiguration.framework
  • UIKit.framework
  • VideoToolbox.framework

The OpenTok iOS SDK links to the libc++ standard library. If another library
that links to the libc++ standard library was compiled in a version of Xcode
older than 6.0.0, it may result in segfaults at run time when using it with the
OpenTok iOS SDK. Known incompatible libraries include, but are not limited to,
Firebase (versions earlier than 2.1.2 -- see
https://code.google.com/p/webrtc/issues/detail?id=3992) and Google Maps
(versions earlier than 1.9.0). To fix this issue, download a version of the
other library that was compiled using XCode 6.0.0 or later.

If you are using a version of Xcode prior to 7.2.0, do not use the -all_load
linker flag. Instead, use the -force_load linker flag to load specific
libraries that require it.

In order to access the camera and microphone, iOS 10 requires you to set values
for the NSCameraUsageDescription and NSMicrophoneUsageDescription keys in
the Info.plist file. These define strings that appear in the app installer to
inform the user why your app uses the camera and microphone. For more
information see the Apple documentation on Cocoa
keys
.

See the release notes for information on the latest version
of the SDK and for a list of known issues.

See this document
for information on using the SDK in apps running in the background mode.

System requirements

The OpenTok iOS SDK is supported on the following devices:

iPhone

  • iPhone 7
  • iPhone 7 Plus
  • iPhone 6s
  • iPhone 6s Plus
  • iPhone 6
  • iPhone 6 Plus
  • iPhone SE
  • iPhone 5s
  • iPhone 5c
  • iPhone 5

iPad

  • iPad Pro 12.9-inch
  • iPad Pro 9.7-inch
  • iPad Air 2
  • iPad Air
  • iPad 4th generation
  • iPad mini 4
  • iPad mini 3
  • iPad mini 2

iPod

  • iPod touch 6th generation

The OpenTok iOS SDK is supported in iOS 9 or higher.

The OpenTok iOS SDK is supported on Wi-Fi and 4G/LTE connections.

The OpenTok iOS SDK supports one published audio-video stream, one
subscribed audio-video stream, and up to three additional subscribed
audio-only streams simultaneously on the iPhone 5 (the lowest-end
device supported). On the iPhone 7, tests have shown support for
subscribing to as many as 20 simultaneous low-resolution (200x200 pixel,
15 frames per second) streams. To connect more than two clients in a
session using the OpenTok iOS SDK, create a session that uses the OpenTok
Media Router (a session with the media mode set to routed). See
The OpenTok Media Router and media
modes
.

Documentation

Reference documentation is included in the doc subdirectory of the SDK and at
http://www.tokbox.com/developer/sdks/ios/reference/index.html.

More information

For a list of new features and known issues, see the release notes.