MacOS


Downloading and using the Zoom Mac SDK

Login to the Zoom App Marketplace using your Zoom account, click the Develop option in the dropdown on the top-right corner and select Build App. Next, click the Create button and provide the required details if you haven’t already created an SDK app. If you previously created an SDK app on the Marketplace, click the View here option and navigate to the Download page. Click macOS to download the macOS SDK.

  • If you have Xcode installed, launch the ZoomSDKSample.xcodeprojfile – this will launch Xcode with the sample code bundled with our SDK. The sample app will be created in the Bin/Release folder.

  • Get the SDK key and Secret from here.

  • Depending on what your app’s authentication options are, you might need to use the REST APIs to get the User ID and User Token.

    If your app is authenticating users with Zoom login credentials then you can ignore this step.

  • Use our APIs in your app to get the user ID and user token or call the REST API with a tool like Postman. The REST API “getbyemail” should provide the user ID and user token.

  • Change the domain (kZoomSDKDomain) to “zoom.us.”

  • If you have a pre-scheduled meeting, get the Meeting ID.

  • Go to AppDelegate.m and change the following constants:

    • Change the kZoomSDKAppKey and kZoomSDKAppSecret to the App key and Secret you got from your account.

    • Change the domain (kZoomSDKDomain) to “zoom.us.”

    • Change the user ID (kSDKUserID) and user token (kSDKUserToken) from what you obtained in the previous steps.

    • Define a username (kSDKUserName) – this username will be displayed in the Meeting UI (for the roster).

  • Run the sample application. You should see the sample launching in the emulator.

  • Explore the available controls and functions in the AppDelegate.h file and define your application flow.

Our Mac SDK exposes four different services. Details on how to use them are documented in the Developer Guide that is bundled inside the download.

The following is a description of the four 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.)

The app can follow the same steps 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.

iOS Supported SDK version

See the Developer changelog for the latest supported version.

Xcode requirements

There are two SDK packages, Universal and Intel. Use Xcode 12.2 or higher for either package.

Troubleshooting

Verifying the MacOS SDK package was correctly added to your project

You can ensure that the SDK can be referenced in your project by simply trying to import ZoomSDK in your AppDelegate:

Swift:

import ZoomSDK

Objective-C:

#import <ZoomSDK/ZoomSDK.h>

If this does not produce any errors, try to build the project. If you are able to build and run your project, then everything is added properly.

If this fails, one or more of the following may help to diagnose the issue:

  1. 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.

  2. 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.)

  3. 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.

Sample Apps

For sample code, please refer to the Zoom SDK package downloaded from the App Marketplace.

More Information

For a list of new features and known issues please see the Release Notes.