https://github.com/opentok/opentok-ios-sdk-samples
Example applications that use the OpenTok iOS SDK
https://github.com/opentok/opentok-ios-sdk-samples
audio communication ios objective-c opentok real-time real-time-video-streaming realtime realtime-audio screen-capture screencast screensharing tokbox video video-call video-communication webrtc
Last synced: 6 months ago
JSON representation
Example applications that use the OpenTok iOS SDK
- Host: GitHub
- URL: https://github.com/opentok/opentok-ios-sdk-samples
- Owner: opentok
- License: mit
- Created: 2013-12-16T18:36:22.000Z (almost 12 years ago)
- Default Branch: main
- Last Pushed: 2025-04-11T13:56:37.000Z (6 months ago)
- Last Synced: 2025-04-12T03:48:45.796Z (6 months ago)
- Topics: audio, communication, ios, objective-c, opentok, real-time, real-time-video-streaming, realtime, realtime-audio, screen-capture, screencast, screensharing, tokbox, video, video-call, video-communication, webrtc
- Language: Objective-C
- Homepage: https://tokbox.com/developer/sdks/ios
- Size: 5.06 MB
- Stars: 198
- Watchers: 79
- Forks: 116
- Open Issues: 17
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
[](https://travis-ci.org/opentok/opentok-ios-sdk-samples)
OpenTok iOS SDK Samples
=======================
This repository is meant to provide some examples for you to better understand
the features of the OpenTok iOS SDK. The sample applications are meant to be
used with the latest version of the
[OpenTok iOS SDK](https://tokbox.com/developer/sdks/ios/). Feel free to copy and
modify the source code herein for your own projects. Please consider sharing
your modifications with us, especially if they might benefit other developers
using the OpenTok iOS SDK. See the [License](LICENSE) for more information.
Quick Start
-----------
1. Get values for your OpenTok **API key**, **session ID**, and **token**.
See [Obtaining OpenTok Credentials](#obtaining-opentok-credentials)
for important information.
2. Install CocoaPods as described in [CocoaPods Getting Started](https://guides.cocoapods.org/using/getting-started.html#getting-started).
3. In Terminal, `cd` to your project directory and run `pod install`.
4. Open your project in Xcode using the new `.xcworkspace` file in the project directory.
5. Set up some config settings for the app. This varies, depending on the project.
* For the Archiving, Basic-Video-Chat, and Signaling projects, in the Config.h file,
replace the following empty strings with the base URL of the server that implements the
[learning-opentok-php](https://github.com/opentok/learning-opentok-php) or [learning-opentok-node](https://github.com/opentok/learning-opentok-node) projects:
```objc
#define SAMPLE_SERVER_BASE_URL @"https://YOUR-SERVER-URL"
```
For more information, see the instructions on setting up these servers in the
[OpenTok tutorials](https://tokbox.com/developer/tutorials/ios/basic-video-chat/#server)
at the OpenTok developer center
* For all other projects, in the ViewController.m file, replace the following empty strings
with the corresponding API key, session ID, and token values:
```objc
// *** Fill the following variables using your own Project info ***
// *** https://dashboard.tokbox.com/projects ***
// Replace with your OpenTok API key
static NSString* const kApiKey = @"";
// Replace with your generated session ID
static NSString* const kSessionId = @"";
// Replace with your generated token
static NSString* const kToken = @"";
```
6. Use Xcode to build and run the app on an iOS simulator or device.
What's Inside
-------------
**Archiving** - This application shows you how to record an OpenTok session.
**Basic Video Chat** - This basic application demonstrates a short path to
getting started with the OpenTok iOS SDK.
**Custom Video Driver** - This project provides classes that implement
the OTVideoCapture and OTVideoRender interfaces of the core Publisher and
Subscriber classes. Using these modules, we can see the basic workflow of
sourcing video frames from the device camera in and out of OpenTok, via the
OTPublisherKit and OTSubscriberKit interfaces.
**Custom Audio Driver** - This project demonstrate how to use an external
audio source with the OpenTok SDK. This project utilizes CoreAudio and the
AUGraph API to create an audio session suitable for voice and video
communications.
**Screen Sharing** - This project demonstrates how to use a custom video
capturer to publish a stream that uses a UI view (instead of a camera) as
the video source.
**Live Photo Capture** - This project extends the video capture module
implemented in project 2, and demonstrates how the AVFoundation media
capture APIs can be used to simultaneously stream video and capture
high-resolution photos from the same camera.
**Simple Multiparty** - This project demonstrates how to use the OpenTok iOS
SDK for a multi-party call. The application publishes audio/video from an
iOS device and can connect to multiple subscribers. However it shows only
one subscriber video at a time due to CPU limitations on iOS devices.
**Signaling** - This project shows you how to implement text chat using
the OpenTok signaling API.
**Overlay Graphics** - This project shows how to overlay graphics for the following:
* A button for muting the publisher microphone
* A button for muting the subscriber audio
* Stream quality notification icons for the subscriber video
* Archive recording icons
This project barrows publisher and subscribers modules implemented in
project 2.
**Audio Levels** - This project demonstrates how to use the OpenTok iOS SDK
for audio-only multi party calls. Both publisher and subscribers are
audio-based only. This application also shows how to use the audio level API
along with an audio meter UI for visualization of publisher and subscriber
audio levels.
**Ringtones** - This project extends on the work done in Project 3
(Custom Audio Driver) by extending the sample audio driver with an
AVAudioPlayer controller, which will play a short ringtone while waiting for
the subscriber to connect to the client device.
**FrameMetadata** -- This project shows how to set metadata (limited to 32 bytes) to a video frame, as well as how to read metadata from a video frame.
## Obtaining OpenTok Credentials
To use the OpenTok platform you need a session ID, token, and API Key.
You can get these values by creating a project on your [OpenTok Account
Page](https://tokbox.com/account/) and scrolling down to the Project Tools
section of your Project page. For production deployment, you must generate the
session ID and token values using one of the [OpenTok Server
SDKs](https://tokbox.com/developer/sdks/server/).
## Development and Contributing
Interested in contributing? We :heart: pull requests! See the
[Contribution](CONTRIBUTING.md) 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:
- Open an issue on this repository
- See for support options
- Tweet at us! We're [@VonageDev](https://twitter.com/VonageDev) on Twitter
- Or [join the Vonage Developer Community Slack](https://developer.nexmo.com/community/slack)
## Further Reading
- Check out the Developer Documentation at