MacOS


Getting Started With the Mac SDK

Downloading and using the Zoom Mac SDK

You can download the latest edition of the Zoom Mac SDK directly from git.

You will find five folders in the download. The ZoomSDKSample folder contains a sample app that uses the SDK. You can open the ZoomSDKSample.xcodeproj file in your Xcode. The same folder contains a ReadMe.txt file that has the build instructions. The AppDelegate.m file contains a high-level application that you can reference to understand how to call stack functions and register callbacks.

  • Download or git clone the package.

  • Go to the download folder -> ZoomSDKSample

  • Place the Zoom SDK folder in the same directory as the ZoomSDKSample.xcodeproj file.

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

SDK Footprint

The size of our Mac stack Zip is about 26.1 MB.

System Requirements

The Zoom Mac SDK is supported in MacOS 10.6 or higher.

Sample Apps

For sample code, please refer to the Zoom SDK Sample Directory.

More Information

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