Zoom Meeting macOS SDK


Our Zoom Meeting macOS SDK makes it easy to incorporate Zoom within your macOS applications.

This document will help you understand our Zoom macOS Software Development Kit(SDK) and experience the power of Zoom on your macOS system in just few minutes.

Prerequisites

See the Changelog for the latest supported Zoom Meeting SDK version. See Minimum SDK version for the minimum supported version.

Supported versionsUniversal-Intel+M1Intel-Only
Minimum macOS version10.910.9
Maximum macOS version(See note below)15
Minimum Xcode version1212

Download the latest macOS Meeting SDK

To download the latest macOS Meeting SDK:

  1. Login to the Zoom App Marketplace using your Zoom account.

  2. Click Develop, Build App, and Create in the SDK app type area and fill out the form until you get to the Download section.

    • If you previously created an SDK app on the Marketplace, click Manage and choose your SDK app type from the list to edit it.
  3. Click Download, macOS, and Download to download the latest macOS SDK.

  4. Click App credentials to get your SDK Key and SDK Secret.

Run the sample app

Follow the steps below to quickly see the sample app in action. Be sure that you have the Zoom Client on your machine to start a meeting that the sample app can join. See below for details.

  1. Move the ZoomSDK folder into the ZoomSDKSample folder.

  2. Use Xcode 12.2 or higher for either package. Open ZoomSDKSample.xcodeproj in the appropriate ZoomSDKSample folder.

  3. Build the sample. It should open the ZoomSDKSample for Intel and M1 (universal) or Intel-only, depending on which one you opened.

  4. In the ZoomSDKSample window, enter https://zoom.us in the text box and click Set Domain.

  5. Enter a JWT token for authentication and click Auth. See How to create a sample JWT for the Meeting SDK and Authentication for details.

  6. In your Zoom client, start a meeting in your join client and in the toolbar, click Meeting, Invite to see the meeting ID and passcode. You can see this information when you click the green "Meeting information" shield in the top-left corner of the Meeting window.

  7. In the ZoomSDKSample window, choose the Join Only tab and enter the Meeting ID, a User Name, and the Meeting Password for the meeting you started and click Join.

The sample will ask permission to use your camera and microphone for the meeting. If you allow, you will be able to use these devices in the meeting. The sample app should display in your meeting.

Next steps

Use the RestAPI without Login tab to enter a User ID and Zoom Access Key (ZAK) to start a meeting. See Get a user's ZAK token for details.

Sample walkthrough

The Zoom Meeting macOS SDK exposes four different services:

  • The Auth service is used for authenticating users. This is done either by passing the account app key and secret or by passing the username and password.

  • The Pre-Meeting service is used to schedule, edit or delete meetings.

  • The Meeting service is used to create scheduled or impromptu meetings and exposes several controller interfaces to control the meetings.

  • The Setting service is used to enable or disable pre-meeting controls (such as selecting a specific camera, set recording path, etc.)

You can use the same services for managing webinars.

Design Constraints

The stack runs in the context of the calling process and the meeting engine will create several threads. Some of the function calls are async, so the app needs to register callbacks and process the events that come back from the stack.

Troubleshooting

If you're unable to run the sample app, try the steps below.

  • Confirm the location of the references to the SDK files in Xcode. To do this, right-click any of the SDK files and select Show in Finder. Make note of the absolute file path of this file. This should also contain the rest of the SDK files, but no need to verify this if you have not modified the folder in any way.

  • Once you have obtained the path, navigate to the Build Settings tab for your project and locate the Framework Search Paths and Library Search Paths settings. If the path you found in step 1 is not showing up, you must add it to both of these settings. (Tip: use ${PROJECT_DIR} to represent the root directory of your project.)

  • Navigate back to the General tab. Right-click any of the SDK files and click the Show in Finder option. This should have the path you found in step 1.

More information

See the Changelog for new features and known issues.

Need help?

If you're looking for help, try Developer Support or our Developer Forum. Priority support is also available with Premier Developer Support plans.