The Vonage Client SDK Video iOS lets you use Vonage-powered video sessions in apps you build for iPad, iPhone, and iPod touch devices.
All Vonage applications are composed of two parts:
- The client-side, which uses the Vonage client SDKs and runs in a user's browser or mobile app
- The server-side, which uses the Vonage server SDKs and runs on your server to pass authentication information to the client.
The client SDK for building iOS apps is the Vonage Client SDK Video iOS, which provides most of the core functionality for your app, including:
- Connecting to an Vonage session
- Publishing streams to a session
- Subscribing to streams in a session
Client SDKs are also available for Android and web. All Vonage client SDKs can interact with one another.
You can learn more about the basics of Vonage clients, servers, sessions, and more on the Vonage Basics page.
You can add the Vonage Client SDK Video iOS by adding the https://github.com/opentok/vonage-client-sdk-video.git repository as a Swift Package Dependency.
To add a package dependency to your Xcode project, select File > Swift Packages > Add Package Dependency and enter its repository URL.
The best way to learn how to use the Vonage Client SDK Video iOS is to follow the Basic Video Chat tutorial.
Once you understand the basics of building with the Vonage Client SDK Video iOS, you can get more detailed information and learn how to customize your application with the Vonage developer guides. To investigate specific API classes and methods, see the Vonage Client SDK Video API reference.
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.
Apps written with the Vonage Client SDK Video iOS 2.25.0 can interoperate with Vonage apps written with version 2.23+ of the Vonage client SDKs:
- Vonage.js
- Vonage Android SDK
- Vonage iOS SDK
- Vonage macOS SDK
- Vonage Windows SDK
- Vonage Linux SDK
The OpenTok.xcframework directory contains the Vonage Client SDK Video iOS.
The Vonage Client SDK Video iOS is available as Swift Package Manager, or the Pod "VonageXCFramework" for use with CocoaPods.
The Vonage Client SDK Video iOS requires Xcode 7 or higher.
The Vonage Client SDK Video iOS 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+)
- Metal.framework
- MetalKit.framework
- MetalPerformanceShaders.framework
- OpenGLES.framework
- QuartzCore.framework
- SystemConfiguration.framework
- UIKit.framework
- VideoToolbox.framework
The Vonage Client SDK Video iOS 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 Vonage Client SDK Video iOS. 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.
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.
The Vonage Client SDK Video iOS is supported on the following devices:
-
iPhone -- iPhone 5s and later
-
iPad -- iPad Pro 1st generation and later, iPad (2017), iPad Air (all models), iPad 4th generation, iPad mini 2 and later
-
iPod touch 6th generation and later
The Vonage Client SDK Video iOS is supported in iOS 13 or higher.
The Vonage Client SDK Video iOS is supported on Wi-Fi, 4G/LTE, and 5G connections.
The Vonage Client SDK Video iOS supports one published audio-video stream, one subscribed audio-video stream, and up to three additional subscribed audio-only streams simultaneously on the iPhone 5s (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 Vonage Client SDK Video iOS, create a session that uses the Vonage Media Router (a session with the media mode set to routed). See The Vonage Media Router and media modes.
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.