Windows


Windows SDK Quickstart

The Zoom Windows SDK allows you to implement Zoom video sessions into the apps you build for the Windows operating system.

Downloading and Using the Zoom Windows SDK

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

You will find five folders in the Zoom Windows SDK:

The Developer Guide is a PDF file in the root. The sdk_demo contains a sample app using the SDK. You can open the file sdk_demo.vcproj in your visual studio. The same folder contains a ReadMe.txt file that has the build instructions. The demo.cpp file includes a high-level application which you can reference to understand how to call the stack functions and register call backs.

The Zoom SDK runs as a DLL in the context of the calling application process.

Previous versions of the SDK are available here.

A changelog is available here.

Pre-Requisites

To use the SDK, you need to make sure that the REST API and the mobile SDK is enabled in your account. If not, please contact your account admin. Our windows SDK is written in C++. If you are writing a C#/.NET application, you need to make sure that you can call the C++ library functions from within your application space.

Note

Our SDK supports meeting services but does not currently support messaging at this time.

Get your SDK Key and Secret from here.

Note

Depending on what your app authentication option is you might need to use the REST APIs to get the user ID and user token. If your app is authenticating users using Zoom login credentials then you can ignore this step. If not, use our APIs in your app to get the user ID and user token or by calling the REST API with a tool like Postman. The REST API function getbyemail should provide the user ID and user token.

Windows App Design Constraints

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

If you want to insert a splash screen with a custom image to the meeting or webinar, your app will need to open a static image, create a window and share that window handle to the stack.

The stack creates an empty log folder in APPDIR\..\logs\audio – this folder will not affect any functions so don’t be alarmed.

System Requirements

The Zoom Windows SDK is supported in Windows XP or higher. If you want to develop using the Win XP framework. please install the vcredist_x86.exe file, which is included in the package. We do not currently support the Windows 10 UWP framework.

Sample Apps

For sample code please refer to the sdk_demo directory.

More Information

For a list of new features and known issues, see the changelogs.