The OpenTok iOS SDK lets you use OpenTok-powered video sessions in apps you build for iPad, iPhone, and iPod touch devices.
Apps written with the OpenTok iOS SDK 2.10.1 can interoperate with OpenTok apps written with the following OpenTok SDKs:
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:
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
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
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
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.
The OpenTok iOS SDK is supported on the following devices:
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-frame 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.
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.
Reference documentation is included in the doc subdirectory of the SDK and at http://www.tokbox.com/developer/sdks/ios/reference/index.html.
For a list of new features and known issues, see the release notes.