Zoom iOS Software Development Kit (SDK)

The version in this repo is a device-only version. If you would like to use the version that supports both device and simulator, you can download the version (ios-mobilertc-all-*.zip) from the release page: https://github.com/zoom/zoom-sdk-ios/releases

Latest SDK News
Full Documentation && Community Support
What is Zoom iOS SDK?
Disclaimer
Getting Started
- Prerequisites
- Installing
Running the tests
Documentation
Navigating SDK sample files
SDK Reference
Versioning
Change log
Frequently Asked Questions (FAQ)
Support
License
Acknowledgments

Latest SDK News

MobileRTCScreenShareService now requires that the following frameworks need to be added to the Broadcast Extension target in addition to ReplayKit:
```
* `CoreGraphics.framework`
* `CoreVideo.framework`
* `CoreMedia.framework`
* `VideoToolbox.framework`
```
MobileRTCScreenShareService also now requires that SampleHandler.m be SampleHandler.mm. If using swift instead, the linker flag -lc++ must be added to the Broadcast Extension’s build settings under “Other linker flags”
Starting from Client SDK 5.0, if you are using tokens to start a meeting, you will only need to retrieve ZAK from Zoom API. The user token has been deprecated.
To follow with Zoom client's recent changes, Zoom SDK has temporary remove the "Unmute All" interface in Client SDK 5.0.
To align with Zoom’s recent announcement pertaining to our security initiative, Zoom Client SDKs have added AES 256-bit GCM encryption support, which provides more protection for meeting data and greater resistance to tampering. The system-wide account enablement of AES 256-bit GCM encryption will take place on June 01, 2020. You are strongly recommended to start the required upgrade to this latest version 4.6.21666.0428 at your earliest convenience. Please note that any Client SDK versions below 4.6.21666.0428 will no longer be operational from June 01.
New way to retrieve and to send SDK logs. Now you may use the "Send Logs By Email" feature to send email with logs for troubleshooting. Our demo app includes this feature, you may refer to the implementation in the demo app for your SDK app.

Full Documentation && Community Support

You can find the full Zoom iOS SDK documentation and the community support forum here:

What is Zoom iOS SDK?

Zoom SDK makes it easy to integrate Zoom with your iOS applications, and boosts up your applications with the power of Zoom.

Easy to use: Our SDK is built to be easy to use. Just import the libraries, call a few functions, and the Zoom video service is now added to your application.
Localizable: Our SDK naturally supports multiple major languages, and you can add more to grow your applications internationally.
Customizable Meeting UI: If you want to add your own decorations to your Zoom meeting rooms, try our Custom UI feature to make your meeting UI special.

Disclaimer

Please be aware that all hard-coded variables and constants shown in the documentation and in the demo, such as Zoom Token, Zoom Access, Token, etc., are ONLY FOR DEMO AND TESTING PURPOSES. We STRONGLY DISCOURAGE the way of HARDCODING any Zoom Credentials (username, password, API Keys & secrets, SDK keys & secrets, etc.) or any Personal Identifiable Information (PII) inside your application. WE DON’T MAKE ANY COMMITMENTS ABOUT ANY LOSS CAUSED BY HARD-CODING CREDENTIALS OR SENSITIVE INFORMATION INSIDE YOUR APP WHEN DEVELOPING WITH OUR SDK.

Getting Started

The following instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

For detailed instructions, please refer to our documentation website: [https://marketplace.zoom.us/docs/sdk/native-sdks/iOS];
If you need support or assistance, please visit our Zoom Developer Community Forum;

Prerequisites

Before you try out our SDK, you would need the following to get started:

A valid Zoom Account: If you do not have one, you can sign up at https://zoom.us/signup and then create an SDK app on Marketplace
An iOS device running iOS 8.0 or later
- [Note]:The examples downloaded from here only works on the real device. If you want to try it on iOS simulator, or on all architectures (x86_64, i386, etc.), please use the version (ios-mobilertc-all-*.zip) from release page: https://github.com/zoom/zoom-sdk-ios/releases;

Installing

Clone or download a copy of our SDK files from GitHub. After you unzipped the file, you should have the following folders:

├── CHANGELOG.md
├── LICENSE.md
├── [MobileRTCSample] <- Libraries and examples are inside
├── README.md
├── lib
└── version.txt

Launch your Xcode, navigate to the "MobileRTCSample" folder, and open the MobileRTCSample.xcodeproj file.

├── MobileRTCSample
├── MobileRTCSample.xcodeproj
└── MobileRTCSampleScreenShare

We provide 2 examples for you:

MobileRTCSample: An iOS app that includes the implementation of different features in SDK.
MobileRTCSampleScreenShare: An iOS broadcast extension that enables screen sharing feature with ReplayKit.

Running the tests

Connect your iOS device to your computer and simply press "Run" on selected example, the example will run on your device.

Documentation

Please visit [https://marketplace.zoom.us/docs/sdk/native-sdks/iOS] for details of each features and functions.

Navigating SDK sample files

The following table provides the link to the implementation of each features in our demo app:

UI mode	Feature	Corresponding sample files
Essential features	SDK Initialization & Authentication	* SDKInitPresenter.m * SDKAuthPresenter.m * SDKAuthPresenter+AuthDelegate.m
	Authenticate with Zoom REST API and start a meeting as API user	* SDKStartJoinMeetingPresenter+RestApiuWithoutLoginUser.m * SDKStartJoinMeetingPresenter.m
	Login with email & password	* SDKAuthPresenter+Login.m * SDKAuthPresenter+AuthDelegate.m
	Login with SSO token	* SDKAuthPresenter+Login.m * SDKAuthPresenter+AuthDelegate.m
	Start an instant meeting(For Logged-in user)	* SDKStartJoinMeetingPresenter+LoginUser.m * SDKStartJoinMeetingPresenter.m
	Join a meeting	* SDKStartJoinMeetingPresenter+JoinMeetingOnly.m * SDKStartJoinMeetingPresenter.m
	Schedule a meeting (For logged-in user)	* SDKScheduleMeetingPresenter.m * SDKAuthPresenter+PremeetingDelegate.m
	Meeting callbacks	* SDKStartJoinMeetingPresenter+AudioServiceDelegate.m * SDKStartJoinMeetingPresenter+CustomizedUIMeetingDelegate.m * SDKStartJoinMeetingPresenter+MeetingServiceDelegate.m * SDKStartJoinMeetingPresenter+ShareServiceDelegate.m * SDKStartJoinMeetingPresenter+UserServiceDelegate.m * SDKStartJoinMeetingPresenter+VideoServiceDelegate.m * SDKStartJoinMeetingPresenter+WebinarServiceDelegate.m
	Settings	* SDKMeetingSettingPresenter.m
	Invitation	* InviteViewController.m
Custom UI	Audio	* SDKAudioPresenter.m
	Video	* SDKVideoPresenter.m
	Share	* SDKSharePresenter.m
	In-Meeting Action	* SDKActionPresenter.m
	Basic UI view	* CustomMeetingViewController.m * CustomMeetingViewController+MeetingDelegate.m
	Top Panel	* TopPanelView.m
	Bottom Panel	* BottomPanelView.m
	Video View	* VideoViewController.m
	Thumb View	* ThumbView.m * ThumbTableViewCell.m
	Share View	* RemoteShareViewController.m * LocalShareViewController.m
	QA View	* QAListVewController.m * QAListTableViewCell.m
	Remote Control	* CustomRemoteControl.m
	Breakout Room	* BOMeetingViewController.m
	Annotation Bar	* AnnoFloatBarView.m

SDK Reference

You may find the SDK interface reference at https://marketplace.zoom.us/docs/sdk/native-sdks/iOS/sdk-reference. If you would like to get a local copy of the SDK reference, you may download it here.

Versioning

For the versions available, see the tags on this repository.

Change log

Please refer to our CHANGELOG for all changes.

Frequently Asked Questions (FAQ)

1️⃣ The iOS SDK is written in
dyld: Library not loaded: /usr/lib/libstdc++.6.dylib:
libstdc++ is deprecated for 5+ years, Apple removes it in XCode 10. This issue has been resolved since release version v4.1.34076.1024.
2️⃣ dyld: Library not loaded: MobileRTC.framework/MobileRTC:
- Our iOS SDK is a dynamic library, please import the MobileRTC.framework into:
  - Link Binary With Libraries
  - Embedded Binaries
3️⃣ d:undefined symbols for architecture x86_64:
- The examples downloaded from here only works on real device. If you want to try it on iOS simulator, or on all architectures (x86_64, i386, etc.) , please use the version (ios-mobilertc-all-*.zip) from release page: https://github.com/zoom/zoom-sdk-ios/releases;
4️⃣ Unsupported Architecture. Your executable contains unsupported architecture '[x86_64, i386]
- As the answer on StackOverflow(https://stackoverflow.com/questions/42641806/check-and-remove-unsupported-architecture-x86-64-i386-in-ipa-archive) says:

Apple has started complaining if app contains simulator architectures during distribution.

So if you are going to publish your application through App Store, please use the device-only version(which is the version in the master branch of our Github repo or the one you downloaded from our SDK documentation).

5️⃣ App Crashed and log shows the crash point at TermSBPTUIModule(Cmm::ICmmMessageQueueClient*)
- This error appears becuase the instance of the MobileRTCMeetingServiceDelegate was not set to nil after you finish using our Zoom services. We defined the delegate as assign property, which needs to be set to nil manually.

@property (nullable, assign, nonatomic) id<MobileRTCMeetingServiceDelegate> delegate;

Setting the delegate to nil should fix this crash.

Not finding what you want? We are here to help! Please visit our Zoom Developer Community Forum for further assistance.

Support

For any issues regarding our SDK, please visit our new Community Support Forum at https://devforum.zoom.us/.

License

Please refer to LICENSE.pdf file for details

Acknowledgments

⭐ If you like our SDK, please give us a "Star". Your support is what keeps us moving forward and delivering happiness to you! Thanks a million! 😃
If you need any support or assistance, we are here to help you: Zoom Developer Community Forum;

cnxtech / zoom-sdk-ios Goto Github PK

zoom-sdk-ios's Introduction

Zoom iOS Software Development Kit (SDK)

Table of Contents