Last verified on SDK version: 5.4.54528.1230
The macOS SDK package has a bit more complexity in comparison to our other SDK offerings. Consequently, the process of importing this SDK is the most error prone, and can result in the SDK misbehaving in some cases if done incorrectly.
In this short guide, we will cover:
- How to add the SDK to your Xcode project
- Verification that the SDK has been correctly added
- Basic debugging steps if something isn't working
Prerequisites
- A Zoom developer account
- Zoom Meeting SDK developer credentials
- Xcode 10
- The macOS Zoom Meeting SDK
Integrating the SDK
After downloading the SDK package, navigate to the ZoomSDK folder and verify that all of the following files are present:
- zmb.bundle
- zmLoader.bundle
- zWebService.bundle
- zVideoApp.bundle
- zSDKRes.bundle
- zKBCrypto.bundle
- zData.bundle
- zChatApp.bundle
- zAutoUpdate.bundle
- xmpp_framework.framework
- viperex.bundle
- viper.framework
- util.framework
- tp.framework
- ssb_sdkk.bundle
- protobuf.framework
- nydus.framework
- mphost.app
- mcm.bundle
- libssl.dylib
- libjson.dylib
- libcrypto.dylib
- curl64.framework
- cmmlib.framework
- capHost.app
- asproxy.framework
- aomhost.app
- aomagent.bundle
- annoter.bundle
- airhost.app
- ZoomSDKVideoUI.framework
- ZoomSDKChatUI.framework
- ZoomSDK.framework
- ZCommonUI.framework
- SDK_Transcode.app
- RingtoneRes.bundle
- CptHost.app
If you notice that any of these files are missing, please try to download a fresh copy of the SDK package.
Now you must import all of the files to your project. There is more than one way of doing this, but for the sake of this guide, we will add them through the General tab in your project's settings. Click on the + sign under the Embedded Binaries section and navigate to the ZoomSDK folder from the previous step. Select all of the SDK files and add them to the project. If this was done correctly, the files should now show up under the Embedded Binaries section.
Next, navigate to the Build Phases tab. Depending on your project's settings, you may need to add a Copy Files phase if one is not already present. All SDK files should be added to this phase, with a destination of Frameworks selected.
Lastly, a few of the files need to be added to the Link Binary With Libraries phase. The SDK files that must be present here are ZoomSDK.framework, libssl.dylib, libjson.dylib, and libcrypto.dylib.
SDK files can be safely removed from other build phases as they are not required.
Verification
Now that you have added all of the SDK files to your project, the next step is to ensure that the SDK can be referenced in your code and the project can successfully build.
To verify that the SDK can be referenced, simply importing ZoomSDK in your AppDelegate will suffice:
Swift:
import ZoomSDK
Objective-C
#import <ZoomSDK/ZoomSDK.h>
If this does not produce any errors, you should be able to build the project to verify that everything is in working order. If you are able to build and run your project, then everything is working properly!
Any errors encountered in either verification step probably means there are some misaligned build settings in your project. proceed to the final section of this guide to troubleshoot.
Troubleshooting
There are a few areas in which the build settings can be a little tricky, and are likely to require some configuration if you have not previously added frameworks through this route. First, we will need to 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 previously recorded 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).
Next, navigate back to the General tab. Right-click any of the SDK files and click the Show in Finder option. This should have the same path as the previous steps of this section.