/windows

name: zoom-meeting-sdk-windows
description: |
  Zoom Meeting SDK for Windows - Native C++ SDK for embedding Zoom meetings into Windows desktop
  applications. Supports custom UI architecture with raw video/audio data, headless bots, and deep
  integration with meeting features. Includes SDK architecture patterns and Windows message loop handling.
user-invocable: false
triggers:
  - "meeting sdk windows"
  - "windows meeting sdk"
  - "windows meeting bot"
  - "c++ meeting sdk windows"
  - "custom ui meeting windows"

Zoom Meeting SDK (Windows)

Embed Zoom meeting capabilities into Windows desktop applications for native C++ integrations and headless bots.

New to Zoom SDK? Start Here!

**The fastest way to master the SDK:**

1. **[SDK Architecture Pattern](concepts/sdk-architecture-pattern.md)** - Learn the universal pattern that works for ALL 35+ features 2. **[Authentication Pattern](examples/authentication-pattern.md)** - Get a working bot joining meetings 3. **[Windows Message Loop](troubleshooting/windows-message-loop.md)** - Fix the #1 reason callbacks don't fire

**Building a Custom UI?**

• [Custom UI Architecture](concepts/custom-ui-architecture.md) - How SDK rendering actually works (child HWNDs, D3D, etc.)
• [Custom UI Video Rendering Example](examples/custom-ui-video-rendering.md) - Complete working code
• [SDK-Rendered vs Self-Rendered](concepts/custom-ui-vs-raw-data.md) - Choose the right approach
• [Custom UI Interface Methods](references/interface-methods.md) - All 13 required virtual methods

**Having issues?**

• Build errors → [Build Errors Guide](troubleshooting/build-errors.md)
• Callbacks not firing → [Windows Message Loop](troubleshooting/windows-message-loop.md)
• Quick diagnostics → [Common Issues](troubleshooting/common-issues.md)
• Performance / service quality → [service-quality.md](examples/service-quality.md)
• Deployment notes → [deployment.md](references/deployment.md)
• MSBuild from git bash → [Build Errors Guide](troubleshooting/build-errors.md#msbuild-command-pattern)
• Complete navigation → [SKILL.md](SKILL.md)

Prerequisites

• Zoom app with Meeting SDK credentials (Client ID & Secret)
• Visual Studio 2019/2022 or later
• Windows 10 or later
• C++ development environment
• vcpkg for dependency management

> **Need help with authentication?** See the **[zoom-oauth](../../oauth/SKILL.md)** skill for JWT token generation.

Project Preferences & Learnings

> **IMPORTANT**: These are hard-won preferences from real project experience. Follow these when creating new projects.

Do NOT use CMake — Use native Visual Studio `.vcxproj`

**Always create a native Visual Studio `.sln` + `.vcxproj` project**, not a CMake project. Reasons:

• More standard and familiar for Windows C++ developers
• Developers can double-click the `.sln` to open in Visual Studio immediately
• Project settings (include dirs, lib dirs, preprocessor defines) are easier to see and edit in the VS Property Pages UI
• No extra CMake tooling or configuration step required
• Friendlier and easier for developers to understand and maintain

`config.json` must be visible in Solution Explorer

The `config.json` file (containing `sdk_jwt`, `meeting_number`, `passcode`) must be: 1. **Included in the `.vcxproj`** as a `<None>` item with `<CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>` 2. **Placed in a "Config" filter** in the `.vcxproj.filters` file so it appears under a "Config" folder in Solution Explorer 3. **Easily editable** by developers directly from Solution Explorer — they should never have to hunt for it in File Explorer

Example `.vcxproj` entry:

<ItemGroup>
  <None Include="config.json">
    <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
  </None>
</ItemGroup>

Example `.vcxproj.filters` entry:

<ItemGroup>
  <Filter Include="Config">
    <UniqueIdentifier>{GUID-HERE}</UniqueIdentifier>
  </Filter>
</ItemGroup>
<ItemGroup>
  <None Include="config.json">
    <Filter>Config</Filter>
  </None>
</ItemGroup>

Overview

The Windows SDK is a **C++ native SDK** designed for:

• **Desktop applications** - Native Windows apps with full UI control
• **Headless bots** - Join meetings without UI
• **Raw media access** - Capture/send audio/video streams
• **Local recording** - Record meetings locally or to cloud

Key Architectural Insight

The SDK follows a **universal 3-step pattern** for every feature: 1. **Get controller** (singleton): `meetingService->Get[Feature]Controller()` 2. **Implement event listener**: `class MyListener : public I[Feature]Event { ... }` 3. **Register and use**: `controller->SetEvent(listener)` then call methods

**This works for ALL features**: audio, video, chat, recording, participants, screen sharing, breakout rooms, webinars, Q&A, polling, whiteboard, and 20+ more!

Learn more: **[SDK Architecture Pattern Guide](concepts/sdk-architecture-pattern.md)**

Quick Start

1. Download Windows SDK

Download from [Zoom Marketplace](https://marketplace.zoom.us/):

• Extract `zoom-meeting-sdk-windows_x86_64-{version}.zip`

2. Setup Project Structure

your-project/
  YourApp/
    SDK/
      x64/
        bin/          # DLL files and dependencies
        h/            # Header files
        lib/          # sdk.lib
      x86/
        bin/
        h/
        lib/
    YourApp.cpp
    YourApp.vcxproj
    config.json

Copy SDK files:

xcopy /E /I sdk-package\x64 your-project\YourApp\SDK\x64\
xcopy /E /I sdk-package\x86 your-project\YourApp\SDK\x86\

3. Install Dependencies (vcpkg)

# Install vcpkg
git clone https://github.com/Microsoft/vcpkg.git C:\vcpkg
cd C:\vcpkg
.\bootstrap-vcpkg.bat
.\vcpkg integrate install

# Install dependencies
.\vcpkg install jsoncpp:x64-windows
.\vcpkg install curl:x64-windows

4. Configure Visual Studio Project

**Project Properties → C/C++ → General → Additional Include Directories:**

$(SolutionDir)SDK\$(PlatformTarget)\h
C:\v