Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/opentok/opentok-ios-sdk-samples-swift
Sample applications using the OpenTok iOS SDK in Swift
https://github.com/opentok/opentok-ios-sdk-samples-swift
ios opentok opentok-ios-sdk swift tokbox video-capture webrtc
Last synced: 5 days ago
JSON representation
Sample applications using the OpenTok iOS SDK in Swift
- Host: GitHub
- URL: https://github.com/opentok/opentok-ios-sdk-samples-swift
- Owner: opentok
- License: mit
- Created: 2016-08-11T10:14:51.000Z (over 8 years ago)
- Default Branch: main
- Last Pushed: 2024-12-03T19:55:51.000Z (about 2 months ago)
- Last Synced: 2025-01-18T12:08:10.752Z (12 days ago)
- Topics: ios, opentok, opentok-ios-sdk, swift, tokbox, video-capture, webrtc
- Language: Swift
- Homepage: https://tokbox.com/
- Size: 1000 KB
- Stars: 138
- Watchers: 69
- Forks: 65
- Open Issues: 8
-
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-swift)
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.
1. Install CocoaPods as described in [CocoaPods Getting Started](https://guides.cocoapods.org/using/getting-started.html#getting-started).
1. In Terminal, `cd` to your project directory and type `pod install`.
1. Reopen your project in Xcode using the new `.xcworkspace` file.
1. In the ViewController.swift file, replace the following empty strings
with the corresponding API key, session ID, and token values:
```swift
// *** Fill the following variables using your own Project info ***
// *** https://tokbox.com/account/#/ ***
// Replace with your OpenTok API key
let kApiKey = ""
// Replace with your generated session ID
let kSessionId = ""
// Replace with your generated token
let kToken = ""
```
1. Use Xcode to build and run the app on an iOS simulator or device.
What's Inside
-------------
**Basic Video Chat** -- This basic application demonstrates a short path to
getting started with the OpenTok iOS SDK.
**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.
**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.
**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.
**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.
**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.
**Picture In Picture** -- This project demonstrates how to implement Picture In Picture on a
subcribed video stream.
**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