Zoom MacOS Software Development Kit (SDK)

Latest SDK Notifications

1. When you are deploying your app with Zoom macos SDK, please don't forget to re-sign the frameworks in ZoomSDK and please don't re-sign the files in Plugins.

2. Due to the enhanced security requirements added in Mac OS 10.14, if you are planning to use Mac OS SDK in Mac OS 10.14 or above, please add Camera and Microphone privacy settings in your .plist file.

3. Variable Name Changes: Since v4.3.1.47193.0321, we have renamed the term "APP" to "SDK" in our demo to avoid confusion between the term "API" and "APP".

4. Unfortunately, our Mac OS SDK does not support Xcode 11 at this point. Please do not compile and build your application with Xcode 11. We are working on the Xcode 11 support and it is a priority for us. Pardon the inconvenience. Until then, please use Xcode 10 and here are the options for installing or using Xcode 10:

   • Working with multiple versions of Xcode. Make sure to follow instructions carefully, before launching for the first time.
   • Use a hosted service supporting many versions of Xcode.

5. Please be aware that some of our interfaces are deprecated in the latest release, please check out our CHANGELOG for more detail

6. Our brand new Zoom Developer Community Forum is now online!!! Check it out! We are here to help! :D

Full Documentation && Community Support

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

What is Zoom Mac SDK?

Zoom SDK makes it easy to integrate Zoom with your MacOS 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 we will take care all video conferencing related stuffs for you.
• Localizable: Our SDK naturally supports 7 major languages, and you can add more to grow your applications internationally.
• Custom Meeting UI: If you want to add your own decorations to your Zoom meeting rooms, try our Custom UI feature to make your meeting room 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/macos;
• 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 Zoom Account: If you do not have one, you can sign up at https://zoom.us/signup.
  • Once you have your Zoom Account, sign up for a 60-days free trial at https://marketplace.zoom.us/
• A device with Mac OS:
  • OS: MacOS 10.6 or later.

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
├── Plugins
├── README.md
├── SDK\ Resources
├── ZoomSDK
├── [ZoomSDKSample] <-- demo app is inside
└── version.txt

Once you have the files ready, please following the instructions to build and run your demo app: https://marketplace.zoom.us/docs/sdk/native-sdks/macos.

Documentation

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

SDK Reference

You may find the SDK interface reference at https://marketplace.zoom.us/docs/sdk/native-sdks/macos/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️⃣ SDK_Transcode.app, airhost.app, and aomhost.app must be rebuilt with support for the Hardened Runtime...
  • When you are deploying your app with Zoom macos SDK, please don't forget to re-sign the frameworks in ZoomSDK. Append your own credentials onto the frameworks and try again.
• 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

Use of this software is subject to important terms and conditions as set forth in the License file

Please refer to LICENSE.md 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;

---

Copyright ©2019 Zoom Video Communications, Inc. All rights reserved.