Zoom Video SDK Windows
OpenAIOfficialCreated by ZoomDistributed by OpenAI
- Skill
- Tool integration
- Software development
- MIT
- No issues found
AutoGineer summary
Written by AutoGineer from the skill’s own files, not by the author
The Zoom Video SDK for Windows provides a C++ library for building custom video applications on Windows platforms. It supports session management, raw audio and video capture or injection, screen sharing, cloud recording, and live transcription. The SDK offers two primary rendering approaches: the Canvas API for direct window rendering and a Raw Data Pipe for custom frame processing. It includes support for C# via a C++/CLI wrapper and requires specific implementation of Windows message loops and delegate callbacks to function correctly.
What it does
- Enables joining and managing Zoom video sessions
- Provides access to raw YUV420 video and PCM audio frames
- Supports custom audio and video injection into sessions
- Facilitates screen sharing and collaborative whiteboard features
- Allows for cloud recording and RTMP live streaming
- Integrates with .NET applications using C++/CLI
When to use it
- When building custom video conferencing interfaces on Windows
- When requiring raw access to audio or video streams for processing
- When integrating Zoom functionality into existing C++ or C# desktop applications
- When implementing custom screen sharing or virtual camera sources
Advantages
- Direct integration with Windows HWND for video rendering
- Flexible rendering options via Canvas API or Raw Data Pipe
- Comprehensive support for session lifecycle and user events
- Native C++ performance with C# interoperability
Usage examples
- “How do I join a Zoom session in my C++ Windows application?”
- Initialize the SDK object, add a delegate listener, and call joinSession with your session context, ensuring a Windows message pump is running to process callbacks.
- “How can I render video in my application?”
- Use the Canvas API to subscribe to a user's video directly to an HWND, or use the Raw Data Pipe to receive YUV420 frames for custom processing and rendering.
- “Why are my SDK callbacks not firing?”
- Ensure your application has a Windows message pump (using PeekMessage, TranslateMessage, and DispatchMessage) in the main loop to allow the SDK to deliver events.
- “How do I handle remote user video subscriptions?”
- Implement the onUserJoin and onUserVideoStatusChanged delegate methods to manually subscribe to remote users using their video canvas.
Install
Download the skill as a ZIP:
https://autogineer.com/agent-skills/openai/zoom-video-sdk-windows/downloadUnzip it into the cross-client skills folder of your project:
mkdir -p .agents/skills && unzip zoom-video-sdk-windows.zip -d .agents/skills
Documentation by Zoom
Zoom Video SDK - Windows Development
Expert guidance for developing with the Zoom Video SDK on Windows. This SDK enables custom video applications, raw media capture/injection, cloud recording, live streaming, and real-time transcription on Windows platforms.
Official Documentation: https://developers.zoom.us/docs/video-sdk/windows/ API Reference: https://marketplacefront.zoom.us/sdk/custom/windows/ Sample Repository: https://github.com/zoom/videosdk-windows-rawdata-sample
Quick Links
New to Video SDK? Follow this path:
SDK Architecture Pattern - Universal 3-step pattern for ANY feature
Session Join Pattern - Complete working code to join a session
Windows Message Loop - CRITICAL: Fix callbacks not firing
Video Rendering - Display video with Canvas API
Reference:
Singleton Hierarchy - 5-level SDK navigation map
API Reference - Methods, error codes, timing rules
Delegate Methods - All 80+ callback methods
Sample Applications - Official samples guide
windows.md - Secondary overview doc (pointer-style)
SKILL.md - Complete documentation navigation
Having issues?
Callbacks not firing → Windows Message Loop
Build errors → Build Errors Guide
Video subscribe fails → Video Rendering (subscribe in
onUserVideoStatusChanged)Quick diagnostics → Common Issues
Building a Custom UI?
Canvas vs Raw Data - Choose your rendering approach
Raw Video Capture - YUV420 frame processing
SDK Overview
The Zoom Video SDK for Windows is a C++ library that provides:
Session Management: Join/leave video SDK sessions
Raw Data Access: Capture raw audio/video frames (YUV420, PCM)
Raw Data Injection: Send custom audio/video into sessions
Screen Sharing: Share screens or inject custom share sources
Cloud Recording: Record sessions to Zoom cloud
Live Streaming: Stream to RTMP endpoints (YouTube, etc.)
Chat & Commands: In-session messaging and command channels
Live Transcription: Real-time speech-to-text
Subsessions: Breakout room support
Whiteboard: Collaborative whiteboard features
Annotations: Screen share annotations
C# Integration: C++/CLI wrapper for .NET applications
Prerequisites
System Requirements
OS: Windows 10 (1903 or later) or Windows 11
Architecture: x64 (recommended), x86, or ARM64
Visual Studio: 2019 or 2022 (Community, Professional, or Enterprise)
Windows SDK: 10.0.19041.0 or later
.NET Framework: 4.8 or later (for C# applications)
Visual Studio Workloads
Install these workloads via Visual Studio Installer:
Desktop development with C++
MSVC v142 or v143 compiler
Windows 10/11 SDK
C++ CMake tools (optional)
.NET desktop development (for C# applications)
.NET Framework 4.8 targeting pack
C++/CLI support
Quick Start
C++ Application
#include <windows.h>
#include "zoom_video_sdk_api.h"
#include "zoom_video_sdk_interface.h"
#include "zoom_video_sdk_delegate_interface.h"
USING_ZOOM_VIDEO_SDK_NAMESPACE
// 1. Create SDK object
IZoomVideoSDK* video_sdk_obj = CreateZoomVideoSDKObj();
// 2. Initialize
ZoomVideoSDKInitParams init_params;
init_params.domain = L"https://zoom.us";
init_params.enableLog = true;
init_params.logFilePrefix = L"zoom_win_video";
init_params.videoRawDataMemoryMode = ZoomVideoSDKRawDataMemoryModeHeap;
init_params.shareRawDataMemoryMode = ZoomVideoSDKRawDataMemoryModeHeap;
init_params.audioRawDataMemoryMode = ZoomVideoSDKRawDataMemoryModeHeap;
ZoomVideoSDKErrors err = video_sdk_obj->initialize(init_params);
// 3. Add event listener
video_sdk_obj->addListener(myDelegate);
// 4. Join session (IMPORTANT: set audioOption.connect = false)
ZoomVideoSDKSessionContext session_context;
session_context.sessionName = L"my-session";
session_context.userName = L"Windows User";
session_context.token = L"your-jwt-token";
session_context.videoOption.localVideoOn = false;
session_context.audioOption.connect = false; // Connect audio after join
session_context.audioOption.mute = true;
IZoomVideoSDKSession* session = video_sdk_obj->joinSession(session_context);
// 5. CRITICAL: Add Windows message pump for callbacks to work
bool running = true;
while (running) {
// Process Windows messages (required for SDK callbacks)
MSG msg;
while (PeekMessage(&msg, NULL, 0, 0, PM_REMOVE)) {
TranslateMessage(&msg);
DispatchMessage(&msg);
}
// Your application logic here
Sleep(10);
}C# Application
using ZoomVideoSDK;
var sdkManager = new ZoomSDKManager();
sdkManager.Initialize();
sdkManager.JoinSession("my-session", "jwt-token", "User Name", "");Key Features
| Feature | Description |
|---|---|
| Session Management | Join, leave, and manage video sessions |
| Raw Video (YUV I420) | Capture and inject raw video frames |
| Raw Audio (PCM) | Capture and inject raw audio data |
| Screen Sharing | Share screens or custom content |
| Cloud Recording | Record sessions to Zoom cloud |
| Live Streaming | Stream to RTMP endpoints |
| Chat | Send/receive chat messages |
| Command Channel | Custom command messaging |
| Live Transcription | Real-time speech-to-text |
| C# Support | Full .NET Framework integration |
Sample Applications
Official Repository: https://github.com/zoom/videosdk-windows-rawdata-sample
| Sample | Description |
|---|---|
| VSDK_SkeletonDemo | Minimal session join - start here |
| VSDK_getRawVideo | Capture YUV420 video frames |
| VSDK_getRawAudio | Capture PCM audio |
| VSDK_sendRawVideo | Inject custom video (virtual camera) |
| VSDK_sendRawAudio | Inject custom audio (virtual mic) |
| VSDK_CloudRecording | Cloud recording control |
| VSDK_CommandChannel | Custom command messaging |
| VSDK_TranscriptionAndTranslation | Live captions |
See complete guide: Sample Applications Reference
Critical Gotchas and Best Practices
⚠️ CRITICAL: Windows Message Pump Required
The #1 issue that causes session joins to hang with no callbacks:
All Windows applications using the Zoom SDK MUST process Windows messages. The SDK uses Windows messages to deliver callbacks like onSessionJoin(), onError(), etc.
Problem: Without a message pump, joinSession() appears to succeed but callbacks never fire.
Solution: Add this to your main loop:
while (running) {
// REQUIRED: Process Windows messages
MSG msg;
while (PeekMessage(&msg, NULL, 0, 0, PM_REMOVE)) {
TranslateMessage(&msg);
DispatchMessage(&msg);
}
// Your application logic
Sleep(10);
}Applies to:
Console applications (no automatic message pump)
Custom main loops
Applications that don't use standard WinMain/WndProc
GUI applications using WinMain with standard message loop already have this.
Audio Connection Strategy
Best Practice: Set audioOption.connect = false when joining, then connect audio in the onSessionJoin() callback.
// During join
session_context.audioOption.connect = false; // Don't connect yet
session_context.audioOption.mute = true;
// In onSessionJoin() callback
void onSessionJoin() override {
IZoomVideoSDKAudioHelper* audioHelper = video_sdk_obj->getAudioHelper();
if (audioHelper) {
audioHelper->startAudio(); // Connect now
}
}Why: This pattern is used in all official Zoom samples. It separates session join from audio initialization for better reliability and error handling.
All Delegate Callbacks Must Be Implemented
The IZoomVideoSDKDelegate interface has 70+ pure virtual methods. ALL must be implemented, even if empty:
// Required even if you don't use them
void onProxyDetectComplete() override {}
void onUserWhiteboardShareStatusChanged(IZoomVideoSDKUser*, IZoomVideoSDKWhiteboardHelper*) override {}
// ... etcTip: Check the SDK version's zoom_video_sdk_delegate_interface.h for the complete list. The interface changes between SDK versions.
Memory Mode for Raw Data
Always use heap mode for raw data memory:
init_params.videoRawDataMemoryMode = ZoomVideoSDKRawDataMemoryModeHeap;
init_params.shareRawDataMemoryMode = ZoomVideoSDKRawDataMemoryModeHeap;
init_params.audioRawDataMemoryMode = ZoomVideoSDKRawDataMemoryModeHeap;Stack mode can cause issues with large video frames.
Thread Safety
SDK callbacks execute on SDK threads, not your main thread:
Don't perform heavy operations in callbacks
Don't call
cleanup()from within callbacksUse thread-safe queues for passing data to UI thread
Use mutexes when accessing shared state
Consult Official Samples First
When SDK behavior is unexpected, always check the official samples before troubleshooting:
Local samples:
C:\tempsdk\Zoom_VideoSDK_Windows_RawDataDemos\VSDK_SkeletonDemo\(simplest)C:\tempsdk\sdksamples\zoom-video-sdk-windows-2.4.12\Sample-Libs\x64\demo\
Official samples show correct patterns for:
Message pump implementation ✓
Audio connection strategy ✓
Error handling ✓
Memory management ✓
Video Rendering - Two Approaches
The Zoom SDK provides two different ways to render video. Choose based on your needs.
🎯 Canvas API (Recommended for Most Use Cases)
Best for: Standard applications, clean video quality, ease of implementation
The SDK renders video directly to your HWND. No YUV conversion needed.
// Subscribe to a user's video with Canvas API
IZoomVideoSDKCanvas* canvas = user->GetVideoCanvas();
if (canvas) {
ZoomVideoSDKErrors ret = canvas->subscribeWithView(
hwnd, // Your window handle
ZoomVideoSDKVideoAspect_PanAndScan, // Fit to window, may crop
ZoomVideoSDKResolution_Auto // Let SDK choose best resolution
);
if (ret == ZoomVideoSDKErrors_Success) {
// SDK is now rendering directly to your window!
}
}
// Unsubscribe when done
canvas->unSubscribeWithView(hwnd);Advantages:
✅ Best quality - SDK uses optimized, hardware-accelerated rendering
✅ No artifacts - Professional video quality
✅ Simple code - 3 lines to subscribe
✅ Better performance - No CPU-intensive YUV conversion
✅ Automatic scaling - SDK handles window resizing
✅ Aspect ratio - Built-in aspect ratio handling
Example from official .NET sample:
// Self video preview
IZoomVideoSDKCanvas* canvas = myself->GetVideoCanvas();
canvas->subscribeWithView(selfVideoHwnd, aspect, resolution);
// Remote user video
IZoomVideoSDKCanvas* remoteCanvas = remoteUser->GetVideoCanvas();
remoteCanvas->subscribeWithView(remoteVideoHwnd, aspect, resolution);Video Aspect Options:
ZoomVideoSDKVideoAspect_Original- Letterbox/pillarbox, no croppingZoomVideoSDKVideoAspect_FullFilled- Fill window, may crop edgesZoomVideoSDKVideoAspect_PanAndScan- Smart crop to fill windowZoomVideoSDKVideoAspect_LetterBox- Show full video with black bars
Resolution Options:
ZoomVideoSDKResolution_90PZoomVideoSDKResolution_180PZoomVideoSDKResolution_360P- Good balanceZoomVideoSDKResolution_720P- HD qualityZoomVideoSDKResolution_1080PZoomVideoSDKResolution_Auto- Let SDK decide (recommended)
🔧 Raw Data Pipe (Advanced Use Cases)
Best for: Custom video processing, effects, recording, computer vision
You receive raw YUV420 frames and handle rendering yourself.
// 1. Create a delegate to receive frames
class VideoRenderer : public IZoomVideoSDKRawDataPipeDelegate {
public:
void onRawDataFrameReceived(YUVRawDataI420* data) override {
int width = data->GetStreamWidth();
int height = data->GetStreamHeight();
char* yBuffer = data->GetYBuffer();
char* uBuffer = data->GetUBuffer();
char* vBuffer = data->GetVBuffer();
// Convert YUV420 to RGB and render
ConvertYUVToRGB(yBuffer, uBuffer, vBuffer, width, height);
RenderToWindow(rgbBuffer, width, height);
}
void onRawDataStatusChanged(RawDataStatus status) override {
// Handle video on/off
}
};
// 2. Subscribe to raw data
IZoomVideoSDKRawDataPipe* pipe = user->GetVideoPipe();
VideoRenderer* renderer = new VideoRenderer();
pipe->subscribe(ZoomVideoSDKResolution_720P, renderer);YUV420 to RGB Conversion (ITU-R BT.601):
void ConvertYUV420ToRGB(char* yBuffer, char* uBuffer, char* vBuffer,
int width, int height) {
for (int y = 0; y < height; y++) {
for (int x = 0; x < width; x++) {
int yIndex = y * width + x;
int uvIndex = (y / 2) * (width / 2) + (x / 2);
int Y = (unsigned char)yBuffer[yIndex];
int U = (unsigned char)uBuffer[uvIndex];
int V = (unsigned char)vBuffer[uvIndex];
// YUV to RGB conversion
int C = Y - 16;
int D = U - 128;
int E = V - 128;
int R = (298 * C + 409 * E + 128) >> 8;
int G = (298 * C - 100 * D - 208 * E + 128) >> 8;
int B = (298 * C + 516 * D + 128) >> 8;
// Clamp to [0, 255]
R = (R < 0) ? 0 : (R > 255) ? 255 : R;
G = (G < 0) ? 0 : (G > 255) ? 255 : G;
B = (B < 0) ? 0 : (B > 255) ? 255 : B;
// Store RGB (BGR format for Windows)
rgbBuffer[yIndex * 3 + 0] = (unsigned char)B;
rgbBuffer[yIndex * 3 + 1] = (unsigned char)G;
rgbBuffer[yIndex * 3 + 2] = (unsigned char)R;
}
}
}Render with GDI:
void RenderToWindow(unsigned char* rgbBuffer, int width, int height) {
HDC hdc = GetDC(hwnd);
BITMAPINFO bmi = {};
bmi.bmiHeader.biSize = sizeof(BITMAPINFOHEADER);
bmi.bmiHeader.biWidth = width;
bmi.bmiHeader.biHeight = -height; // Negative for top-down
bmi.bmiHeader.biPlanes = 1;
bmi.bmiHeader.biBitCount = 24; // 24-bit RGB
bmi.bmiHeader.biCompression = BI_RGB;
RECT rect;
GetClientRect(hwnd, &rect);
StretchDIBits(hdc,
0, 0, rect.right, rect.bottom, // Destination
0, 0, width, height, // Source
rgbBuffer, &bmi,
DIB_RGB_COLORS, SRCCOPY);
ReleaseDC(hwnd, hdc);
}Disadvantages:
⚠️ CPU intensive - YUV conversion can cause frame drops
⚠️ Artifacts - Manual rendering may show tearing/artifacts
⚠️ Complex - More code to maintain
⚠️ Performance - Slower than Canvas API
Use Raw Data When:
Adding video filters/effects
Recording to custom formats
Computer vision processing
Custom compositing
Streaming to non-standard outputs
Self Video vs Remote Users
Self Video (your own camera):
Option A: Canvas API
IZoomVideoSDKSession* session = sdk->getSessionInfo();
IZoomVideoSDKUser* myself = session->getMyself();
IZoomVideoSDKCanvas* canvas = myself->GetVideoCanvas();
canvas->subscribeWithView(selfVideoHwnd, aspect, resolution);Option B: Video Preview (for self only)
IZoomVideoSDKVideoHelper* videoHelper = sdk->getVideoHelper();
videoHelper->startVideo(); // Start transmission
// For preview rendering
videoHelper->startVideoCanvasPreview(selfVideoHwnd, aspect, resolution);Remote Users (other participants):
Canvas API (recommended):
// In onUserJoin callback
void onUserJoin(IZoomVideoSDKUserHelper*, IVideoSDKVector<IZoomVideoSDKUser*>* userList) {
for (int i = 0; i < userList->GetCount(); i++) {
IZoomVideoSDKUser* user = userList->GetItem(i);
IZoomVideoSDKCanvas* canvas = user->GetVideoCanvas();
canvas->subscribeWithView(userVideoHwnd, aspect, resolution);
}
}Event-Driven Subscription Pattern
⚠️ CRITICAL: Video subscription must be event-driven and manual.
Key Events:
onSessionJoin- Subscribe to self videoonUserJoin- Subscribe to new remote usersonUserVideoStatusChanged- Re-subscribe when video turns on/offonUserLeave- Unsubscribe and cleanup
Complete Pattern:
class MainFrame : public IZoomVideoSDKDelegate {
private:
std::map<IZoomVideoSDKUser*, IZoomVideoSDKCanvas*> subscribedUsers_;
HWND videoWindow_;
public:
void onSessionJoin() override {
// Start your own video
IZoomVideoSDKVideoHelper* videoHelper = sdk->getVideoHelper();
videoHelper->startVideo();
// Subscribe to self video
IZoomVideoSDKUser* myself = sdk->getSessionInfo()->getMyself();
SubscribeToUser(myself);
}
void onUserJoin(IZoomVideoSDKUserHelper*,
IVideoSDKVector<IZoomVideoSDKUser*>* userList) override {
// Get current user to exclude self
IZoomVideoSDKUser* myself = sdk->getSessionInfo()->getMyself();
for (int i = 0; i < userList->GetCount(); i++) {
IZoomVideoSDKUser* user = userList->GetItem(i);
// IMPORTANT: Only subscribe to REMOTE users!
if (user != myself) {
SubscribeToUser(user);
}
}
}
void onUserVideoStatusChanged(IZoomVideoSDKVideoHelper*,
IVideoSDKVector<IZoomVideoSDKUser*>* userList) override {
IZoomVideoSDKUser* myself = sdk->getSessionInfo()->getMyself();
for (int i = 0; i < userList->GetCount(); i++) {
IZoomVideoSDKUser* user = userList->GetItem(i);
if (user != myself) {
// Re-subscribe when video status changes
SubscribeToUser(user);
}
}
}
void onUserLeave(IZoomVideoSDKUserHelper*,
IVideoSDKVector<IZoomVideoSDKUser*>* userList) override {
for (int i = 0; i < userList->GetCount(); i++) {
IZoomVideoSDKUser* user = userList->GetItem(i);
UnsubscribeFromUser(user);
}
}
void onSessionLeave() override {
// Cleanup all subscriptions
for (auto& pair : subscribedUsers_) {
IZoomVideoSDKCanvas* canvas = pair.second;
if (canvas) {
canvas->unSubscribeWithView(videoWindow_);
}
}
subscribedUsers_.clear();
}
private:
void SubscribeToUser(IZoomVideoSDKUser* user) {
if (!user || subscribedUsers_.find(user) != subscribedUsers_.end())
return;
IZoomVideoSDKCanvas* canvas = user->GetVideoCanvas();
if (canvas) {
ZoomVideoSDKErrors ret = canvas->subscribeWithView(
videoWindow_,
ZoomVideoSDKVideoAspect_PanAndScan,
ZoomVideoSDKResolution_Auto
);
if (ret == ZoomVideoSDKErrors_Success) {
subscribedUsers_[user] = canvas;
}
}
}
void UnsubscribeFromUser(IZoomVideoSDKUser* user) {
auto it = subscribedUsers_.find(user);
if (it != subscribedUsers_.end()) {
IZoomVideoSDKCanvas* canvas = it->second;
if (canvas) {
canvas->unSubscribeWithView(videoWindow_);
}
subscribedUsers_.erase(it);
}
}
};Key Points:
✅ Subscribe in response to events (onUserJoin, onUserVideoStatusChanged)
✅ Always exclude current user from remote subscriptions
✅ Unsubscribe on onUserLeave
✅ Clean up all subscriptions on onSessionLeave
✅ Track subscriptions in a map for lifecycle management
⚠️ Screen Share Subscription (DIFFERENT from Video!)
CRITICAL: Screen share subscription uses IZoomVideoSDKShareAction from the callback, NOT user->GetShareCanvas()!
// WRONG - This won't work for remote screen shares!
user->GetShareCanvas()->subscribeWithView(hwnd, ...);
// CORRECT - Use IZoomVideoSDKShareAction from onUserShareStatusChanged callback
void onUserShareStatusChanged(IZoomVideoSDKShareHelper* pShareHelper,
IZoomVideoSDKUser* pUser,
IZoomVideoSDKShareAction* pShareAction) {
if (!pShareAction) return;
ZoomVideoSDKShareStatus status = pShareAction->getShareStatus();
if (status == ZoomVideoSDKShareStatus_Start ||
status == ZoomVideoSDKShareStatus_Resume) {
// Subscribe to the share using Canvas API
IZoomVideoSDKCanvas* shareCanvas = pShareAction->getShareCanvas();
if (shareCanvas) {
shareCanvas->subscribeWithView(shareWindow_,
ZoomVideoSDKVideoAspect_Original);
}
}
else if (status == ZoomVideoSDKShareStatus_Stop) {
// Unsubscribe when share stops
IZoomVideoSDKCanvas* shareCanvas = pShareAction->getShareCanvas();
if (shareCanvas) {
shareCanvas->unSubscribeWithView(shareWindow_);
}
}
}Why is share different from video?
Video: Each user has one video stream → use
user->GetVideoCanvas()Share: A user can have multiple share actions (multi-share) → use
IZoomVideoSDKShareAction*from callbackThe
IZoomVideoSDKShareActionobject represents a specific share stream and contains the share status, type, and rendering interfaces
See also: Screen Share Subscription Example
Multi-User Video Layout
For multiple participants, you need one HWND per user:
// Create separate windows/panels for each user
HWND selfVideoWindow = CreateWindow(...); // Your video
HWND user1Window = CreateWindow(...); // User 1's video
HWND user2Window = CreateWindow(...); // User 2's video
// Subscribe each user to their own window
myself->GetVideoCanvas()->subscribeWithView(selfVideoWindow, ...);
user1->GetVideoCanvas()->subscribeWithView(user1Window, ...);
user2->GetVideoCanvas()->subscribeWithView(user2Window, ...);Layout Strategies:
Grid layout (2x2, 3x3)
Gallery view (scrollable)
Active speaker (large) + thumbnails
Picture-in-picture
Common Video Issues
| Issue | Cause | Solution |
|---|---|---|
| Video not showing | Not calling startVideo() | Call videoHelper->startVideo() in onSessionJoin |
| Artifacts/tearing | Using Raw Data Pipe | Switch to Canvas API |
| Poor performance | YUV conversion on UI thread | Use Canvas API or move conversion to worker thread |
| Video freezes | Not processing Windows messages | Add message pump to main loop |
| Can't see self | Subscribing to wrong user | Use session->getMyself() for self video |
| Seeing self in remote list | Not excluding self | Check if (user != myself) before subscribing |
Complete Documentation Library
This skill includes comprehensive guides organized by category:
Core Concepts (Start Here!)
SDK Architecture Pattern - Universal 3-step pattern for ANY feature
Singleton Hierarchy - 5-level navigation guide
Canvas vs Raw Data - Choose your rendering approach
Complete Examples
Session Join Pattern - JWT auth + session join with full code
Video Rendering - Canvas API video display
Screen Share Subscription - View remote screen shares (DIFFERENT from video!)
Raw Video Capture - YUV420 frame capture
Raw Audio Capture - PCM audio capture
Send Raw Video - Virtual camera (inject custom video)
Send Raw Audio - Virtual mic (inject custom audio)
Cloud Recording - Cloud recording control
Command Channel - Custom command messaging
Transcription - Live transcription/captions
UI Framework Integration
Win32 Native - Direct SDK usage with Canvas API (best performance)
WinForms (.NET) - C++/CLI wrapper + Raw Data Pipe
WPF (.NET) - C++/CLI wrapper + BitmapSource conversion
Production Quality Guidelines - Checklist and common issues
C++/CLI Wrapper Patterns (Wrapping ANY Native Library)
Complete Guide - 8 patterns for native→.NET interop
Pattern 1: Basic Structure - Project setup, class layout
Pattern 2: void* Pointers - Hide native types
Pattern 3: gcroot Callbacks - Native→Managed events
Pattern 4: IDisposable - Cleanup pattern
Pattern 5: Strings - String^ ↔ wstring/string
Pattern 6: Arrays - pin_ptr, Marshal::Copy
Pattern 7: Threading - UI thread dispatch
Pattern 8: LockBits - Fast image conversion
Common Errors - Troubleshooting
Troubleshooting
Windows Message Loop - CRITICAL: Why callbacks don't fire
Build Errors - SDK header dependency fixes
Common Issues - Quick diagnostics & error codes
References
API Reference - 5-level API hierarchy, methods, error codes
Delegate Methods - All 80+ callback methods
SKILL.md - Complete navigation guide
Most Critical Issues (From Real Debugging)
Callbacks not firing → Missing Windows message loop (99% of issues)
Video subscribe returns error 2 → Subscribing too early
See: Video Rendering - Subscribe in
onUserVideoStatusChanged
Abstract class errors → Missing virtual method implementations
See: Delegate Methods
Key Insight
Once you learn the 3-step pattern, you can implement ANY feature:
Get singleton → 2. Implement delegate → 3. Subscribe & use
Resources
Official Docs: https://developers.zoom.us/docs/video-sdk/windows/
API Reference: https://marketplacefront.zoom.us/sdk/custom/windows/
Dev Forum: https://devforum.zoom.us/
GitHub Samples: https://github.com/zoom/videosdk-windows-rawdata-sample
Working Sample:
C:\tempsdk\zoom-video-sdk-windows-sample\(complete implementation)
Need help? Start with SKILL.md for complete navigation.
Merged from video-sdk/windows/SKILL.md
Zoom Video SDK Windows - Complete Documentation Index
Quick Start Path
If you're new to the SDK, follow this order:
Overview → windows.md
Read the architecture pattern → concepts/sdk-architecture-pattern.md
Universal formula: Singleton → Delegate → Subscribe
Once you understand this, you can implement any feature
Fix build errors → troubleshooting/build-errors.md
SDK header dependencies
Required include order
Implement session join → examples/session-join-pattern.md
Complete working JWT + session join code
Fix callback issues → troubleshooting/windows-message-loop.md
CRITICAL: Why callbacks don't fire without Windows message loop
Implement video → examples/video-rendering.md
Canvas API (SDK-rendered) vs Raw Data Pipe
Troubleshoot any issues → troubleshooting/common-issues.md
Quick diagnostic checklist
Error code tables
Documentation Structure
video-sdk/windows/
├── SKILL.md # Main skill overview
├── SKILL.md # This file - navigation guide
├── windows.md # Secondary overview doc (pointer-style)
│
├── concepts/ # Core architectural patterns
│ ├── sdk-architecture-pattern.md # Universal formula for ANY feature
│ ├── singleton-hierarchy.md # 5-level navigation guide
│ └── canvas-vs-raw-data.md # SDK-rendered vs self-rendered choice
│
├── examples/ # Complete working code
│ ├── session-join-pattern.md # JWT auth + session join
│ ├── video-rendering.md # Canvas API video display
│ ├── screen-share-subscription.md # View remote screen shares
│ ├── raw-video-capture.md # YUV420 raw frame capture
│ ├── raw-audio-capture.md # PCM audio capture
│ ├── send-raw-video.md # Virtual camera (inject video)
│ ├── send-raw-audio.md # Virtual mic (inject audio)
│ ├── cloud-recording.md # Cloud recording control
│ ├── command-channel.md # Custom command messaging
│ ├── transcription.md # Live transcription/captions
│ └── dotnet-winforms/ # UI Framework integration
│ └── README.md # Win32, WinForms, WPF patterns
│ # C++/CLI wrapper patterns
│ # Production quality guidelines
│
├── troubleshooting/ # Problem solving guides
│ ├── windows-message-loop.md # CRITICAL - Why callbacks fail
│ ├── build-errors.md # Header dependency fixes
│ └── common-issues.md # Quick diagnostic workflow
│
└── references/ # Reference documentation
├── windows-reference.md # API hierarchy, methods, error codes
├── delegate-methods.md # All 80+ callback methods
└── samples.md # Official samples guideBy Use Case
I want to build a video app
SDK Architecture Pattern - Understand the pattern
Session Join Pattern - Join sessions
Video Rendering - Display video
Windows Message Loop - Fix callback issues
I'm getting build errors
Build Errors Guide - SDK header dependencies
Delegate Methods - Abstract class errors
Common Issues - Linker errors
I'm getting runtime errors
Windows Message Loop - Callbacks not firing
Common Issues - Error code tables
I want to view screen shares
Screen Share Subscription - DIFFERENT from video!
SDK Architecture Pattern - Event-driven pattern
Video Rendering - Compare with video subscription
I want to capture raw video/audio
Canvas vs Raw Data - Choose your approach
Raw Video Capture - YUV420 frame capture
Raw Audio Capture - PCM audio capture
SDK Architecture Pattern - Subscription pattern
I want to send custom video/audio (virtual camera/mic)
Send Raw Video - Inject custom video frames
Send Raw Audio - Inject custom audio
SDK Architecture Pattern - External source pattern
I want to record sessions
Cloud Recording - Start/stop cloud recording
API Reference - Recording helper methods
I want to use live transcription
Transcription - Enable live captions
Delegate Methods - Transcription callbacks
I want custom messaging between participants
Command Channel - Send custom commands
API Reference - Command channel methods
I want to build a Win32 native app
Win32 Integration - Direct SDK + Canvas API
Video Rendering - Canvas API patterns
Production Guidelines - Best practices
I want to build a WinForms (.NET) app
WinForms Integration - C++/CLI wrapper + Raw Data
C++/CLI Patterns - gcroot, Finalizer, LockBits
Production Guidelines - IDisposable, thread safety
I want to build a WPF (.NET) app
WPF Integration - C++/CLI + BitmapSource
Bitmap Conversion - Freeze(), Dispatcher
Production Guidelines - Performance optimization
I want to use C# / .NET Framework (general)
.NET Integration Overview - Complete C++/CLI wrapper guide
Raw Video Capture - YUV→RGB conversion patterns
Session Join Pattern - SDK initialization flow
I want to wrap ANY native C++ library for .NET
C++/CLI Wrapper Patterns - Complete 8-pattern guide
Pattern 1: Basic Structure - Project setup + class layout
Pattern 3: gcroot Callbacks - Native→Managed events
Pattern 4: IDisposable - Cleanup pattern
Common Errors - Troubleshooting
I want to implement a specific feature
SDK Architecture Pattern - START HERE!
Singleton Hierarchy - Navigate to the feature
API Reference - Method signatures
Most Critical Documents
1. SDK Architecture Pattern (MASTER DOCUMENT)
concepts/sdk-architecture-pattern.md
The universal 3-step pattern:
Get singleton (SDK, helpers, session, users)
Implement delegate (event callbacks)
Subscribe and use
2. Windows Message Loop (MOST COMMON ISSUE)
troubleshooting/windows-message-loop.md
99% of "callbacks not firing" issues are caused by missing Windows message loop.
3. Singleton Hierarchy (NAVIGATION MAP)
concepts/singleton-hierarchy.md
5-level deep navigation showing how to reach every feature.
Key Learnings
Critical Discoveries:
Windows Message Loop is MANDATORY
SDK uses Windows message pump for callbacks
Without it, callbacks are queued but never fire
Subscribe in onUserVideoStatusChanged, NOT onUserJoin
Video may not be ready when user joins
Wait for video status change callback
See: Video Rendering
Two Rendering Paths
Canvas API: SDK renders to your HWND (recommended)
Raw Data Pipe: You receive YUV frames (advanced)
See: Canvas vs Raw Data
Helpers Control YOUR Streams Only
videoHelper->startVideo()starts YOUR cameraTo see others, subscribe to their Canvas/Pipe
See: Singleton Hierarchy
UI Framework Integration Differs by Platform
Win32: Direct SDK, Canvas API (SDK renders to HWND) - best performance
WinForms: C++/CLI wrapper, Raw Data Pipe, YUV→Bitmap, InvokeRequired
WPF: Same wrapper + Bitmap→BitmapSource, Dispatcher, Freeze()
C++/CLI Wrapper Patterns (for ANY native library → .NET)
void*pointers - hide native types from managed headersgcroot<T^>- prevent GC from collecting managed references in native codeFinalizer + Destructor -
~Class()and!Class()for IDisposable cleanuppin_ptr+Marshal::Copy- array/buffer conversionLockBits- 100x faster than SetPixel for image manipulationThread marshaling - InvokeRequired (WinForms) / Dispatcher (WPF)
Audio Connection Timing
Set
audioOption.connect = falseduring joinCall
startAudio()inonSessionJoincallback
Quick Reference
"My code won't compile"
"Callbacks never fire"
"Video subscription returns error 2"
→ Video Rendering - Subscribe in onUserVideoStatusChanged
"Abstract class error"
"How do I implement [feature]?"
"How do I navigate to [controller]?"
"What error code means what?"
Document Version
Based on Zoom Video SDK for Windows v2.x
Happy coding!
Remember: The SDK Architecture Pattern is your key to unlocking the entire SDK. Read it first!
Operations
RUNBOOK.md - 5-minute preflight and debugging checklist.
Files
- ATTRIBUTION.mdAdded by AutoGineer886 B
- LICENSELicence file added by AutoGineer1.1 KiB
- RUNBOOK.md2.2 KiB
- SKILL.md39.8 KiB
- agents/openai.yaml277 B
- concepts/canvas-vs-raw-data.md10.0 KiB
- concepts/sdk-architecture-pattern.md8.6 KiB
- concepts/singleton-hierarchy.md22.2 KiB
- examples/cloud-recording.md8.8 KiB
- examples/command-channel.md8.8 KiB
- examples/dotnet-winforms/guide.md37.7 KiB
- examples/raw-audio-capture.md7.1 KiB
- examples/raw-video-capture.md12.8 KiB
- examples/screen-share-subscription.md18.0 KiB
- examples/send-raw-audio.md9.0 KiB
- examples/send-raw-video.md10.5 KiB
- examples/session-join-pattern.md17.6 KiB
- examples/transcription.md11.5 KiB
- examples/video-rendering.md13.1 KiB
- references/delegate-methods.md31.6 KiB
- references/samples.md7.7 KiB
- references/windows-reference.md42.5 KiB
- troubleshooting/build-errors.md6.0 KiB
- troubleshooting/common-issues.md7.2 KiB
- troubleshooting/windows-message-loop.md6.9 KiB
- windows.md1.9 KiB
references/delegate-methods.md
Delegate Methods Reference
Complete list of all IZoomVideoSDKDelegate callback methods. All 80+ methods must be implemented, even if empty.
Note: The callback count has grown significantly in SDK v2.4.x with additions for subsessions (breakout rooms), broadcast streaming, whiteboard, RTMS, and enhanced annotation support.
Quick Template
Copy this template and add your implementation:
class MyDelegate : public IZoomVideoSDKDelegate {
public:
// ═══════════════════════════════════════════════════════════════════════
// SESSION LIFECYCLE
// ═══════════════════════════════════════════════════════════════════════
void onSessionJoin() override {
// Called when successfully joined session
}
void onSessionLeave() override {
// Called when left session (no reason)
}
void onSessionLeave(ZoomVideoSDKSessionLeaveReason reason) override {
// Called when left session (with reason)
}
void onError(ZoomVideoSDKErrors errorCode, int detailErrorCode) override {
// Called on SDK errors
}
void onSessionNeedPassword(IZoomVideoSDKPasswordHandler* handler) override {
// Called when session requires password
}
void onSessionPasswordWrong(IZoomVideoSDKPasswordHandler* handler) override {
// Called when password is incorrect
}
// ═══════════════════════════════════════════════════════════════════════
// USER EVENTS
// ═══════════════════════════════════════════════════════════════════════
void onUserJoin(IZoomVideoSDKUserHelper* helper,
IVideoSDKVector<IZoomVideoSDKUser*>* userList) override {
// Called when users join session
}
void onUserLeave(IZoomVideoSDKUserHelper* helper,
IVideoSDKVector<IZoomVideoSDKUser*>* userList) override {
// Called when users leave session
}
void onUserHostChanged(IZoomVideoSDKUserHelper* helper,
IZoomVideoSDKUser* user) override {
// Called when host changes
}
void onUserManagerChanged(IZoomVideoSDKUser* user) override {
// Called when manager status changes
}
void onUserNameChanged(IZoomVideoSDKUser* user) override {
// Called when user name changes
}
// ═══════════════════════════════════════════════════════════════════════
// VIDEO EVENTS
// ═══════════════════════════════════════════════════════════════════════
void onUserVideoStatusChanged(IZoomVideoSDKVideoHelper* helper,
IVideoSDKVector<IZoomVideoSDKUser*>* userList) override {
// IMPORTANT: Subscribe to video here, not in onUserJoin
}
void onSpotlightVideoChanged(IZoomVideoSDKVideoHelper* helper,
IVideoSDKVector<IZoomVideoSDKUser*>* userList) override {
// Called when spotlight changes
}
void onVideoCanvasSubscribeFail(ZoomVideoSDKSubscribeFailReason reason,
IZoomVideoSDKUser* user, void* handle) override {
// Called when video subscription fails
}
void onVideoAlphaChannelStatusChanged(bool isAlphaModeOn) override {
// Called when alpha channel mode changes
}
// ═══════════════════════════════════════════════════════════════════════
// AUDIO EVENTS
// ═══════════════════════════════════════════════════════════════════════
void onUserAudioStatusChanged(IZoomVideoSDKAudioHelper* helper,
IVideoSDKVector<IZoomVideoSDKUser*>* userList) override {
// Called when audio status changes (mute/unmute)
}
void onUserActiveAudioChanged(IZoomVideoSDKAudioHelper* helper,
IVideoSDKVector<IZoomVideoSDKUser*>* userList) override {
// Called when active speaker changes
}
void onHostAskUnmute() override {
// Called when host requests you to unmute
}
// ═══════════════════════════════════════════════════════════════════════
// RAW AUDIO EVENTS
// ═══════════════════════════════════════════════════════════════════════
void onMixedAudioRawDataReceived(AudioRawData* data) override {
// Called with mixed audio from all participants
}
void onOneWayAudioRawDataReceived(AudioRawData* data,
IZoomVideoSDKUser* user) override {
// Called with audio from specific user
}
void onSharedAudioRawDataReceived(AudioRawData* data) override {
// Called with shared audio
}
// ═══════════════════════════════════════════════════════════════════════
// SHARE EVENTS
// ═══════════════════════════════════════════════════════════════════════
void onUserShareStatusChanged(IZoomVideoSDKShareHelper* helper,
IZoomVideoSDKUser* user,
IZoomVideoSDKShareAction* shareAction) override {
// Called when share status changes - use shareAction to subscribe
}
void onShareContentChanged(IZoomVideoSDKShareHelper* helper,
IZoomVideoSDKUser* user,
IZoomVideoSDKShareAction* shareAction) override {
// Called when share content type changes
}
void onFailedToStartShare(IZoomVideoSDKShareHelper* helper,
IZoomVideoSDKUser* user) override {
// Called when share fails to start
}
void onShareContentSizeChanged(IZoomVideoSDKShareHelper* helper,
IZoomVideoSDKUser* user,
IZoomVideoSDKShareAction* shareAction) override {
// Called when share size changes
}
void onShareCanvasSubscribeFail(IZoomVideoSDKUser* user, void* handle,
IZoomVideoSDKShareAction* shareAction) override {
// Called when share subscription fails
}
// ═══════════════════════════════════════════════════════════════════════
// CHAT EVENTS
// ═══════════════════════════════════════════════════════════════════════
void onChatNewMessageNotify(IZoomVideoSDKChatHelper* helper,
IZoomVideoSDKChatMessage* messageItem) override {
// Called when new chat message received
}
void onChatMsgDeleteNotification(IZoomVideoSDKChatHelper* helper,
const zchar_t* msgID,
ZoomVideoSDKChatMessageDeleteType deleteBy) override {
// Called when chat message deleted
}
void onChatPrivilegeChanged(IZoomVideoSDKChatHelper* helper,
ZoomVideoSDKChatPrivilegeType privilege) override {
// Called when chat privilege changes
}
// ═══════════════════════════════════════════════════════════════════════
// COMMAND CHANNEL EVENTS
// ═══════════════════════════════════════════════════════════════════════
void onCommandReceived(IZoomVideoSDKUser* sender, const zchar_t* strCmd) override {
// Called when command received
}
void onCommandChannelConnectResult(bool isSuccess) override {
// Called when command channel connection result
}
// ═══════════════════════════════════════════════════════════════════════
// RECORDING EVENTS
// ═══════════════════════════════════════════════════════════════════════
void onCloudRecordingStatus(RecordingStatus status,
IZoomVideoSDKRecordingConsentHandler* handler) override {
// Called when cloud recording status changes
}
void onUserRecordingConsent(IZoomVideoSDKUser* user) override {
// Called when user gives recording consent
}
// ═══════════════════════════════════════════════════════════════════════
// LIVE STREAM EVENTS
// ═══════════════════════════════════════════════════════════════════════
void onLiveStreamStatusChanged(IZoomVideoSDKLiveStreamHelper* helper,
ZoomVideoSDKLiveStreamStatus status) override {
// Called when live stream status changes
}
// ═══════════════════════════════════════════════════════════════════════
// LIVE TRANSCRIPTION EVENTS
// ═══════════════════════════════════════════════════════════════════════
void onLiveTranscriptionStatus(ZoomVideoSDKLiveTranscriptionStatus status) override {
// Called when transcription status changes
}
void onLiveTranscriptionMsgInfoReceived(ILiveTranscriptionMessageInfo* info) override {
// Called when transcription message received
}
void onOriginalLanguageMsgReceived(ILiveTranscriptionMessageInfo* info) override {
// Called when original language message received
}
void onLiveTranscriptionMsgError(ILiveTranscriptionLanguage* spokenLanguage,
ILiveTranscriptionLanguage* transcriptLanguage) override {
// Called on transcription error
}
// ═══════════════════════════════════════════════════════════════════════
// PHONE EVENTS
// ═══════════════════════════════════════════════════════════════════════
void onInviteByPhoneStatus(PhoneStatus status, PhoneFailedReason reason) override {
// Called when phone invite status changes
}
void onCalloutJoinSuccess(IZoomVideoSDKUser* user, const zchar_t* phoneNumber) override {
// Called when callout user joins
}
// ═══════════════════════════════════════════════════════════════════════
// CAMERA CONTROL EVENTS
// ═══════════════════════════════════════════════════════════════════════
void onCameraControlRequestResult(IZoomVideoSDKUser* user, bool isApproved) override {
// Called when camera control request result
}
void onCameraControlRequestReceived(IZoomVideoSDKUser* user,
ZoomVideoSDKCameraControlRequestType requestType,
IZoomVideoSDKCameraControlRequestHandler* handler) override {
// Called when camera control request received
}
// ═══════════════════════════════════════════════════════════════════════
// REMOTE CONTROL EVENTS
// ═══════════════════════════════════════════════════════════════════════
void onRemoteControlStatus(IZoomVideoSDKUser* user,
IZoomVideoSDKShareAction* shareAction,
ZoomVideoSDKRemoteControlStatus status) override {
// Called when remote control status changes
}
void onRemoteControlRequestReceived(IZoomVideoSDKUser* user,
IZoomVideoSDKShareAction* shareAction,
IZoomVideoSDKRemoteControlRequestHandler* handler) override {
// Called when remote control request received
}
void onRemoteControlServiceInstallResult(bool bSuccess) override {
// Called when remote control service install result
}
// ═══════════════════════════════════════════════════════════════════════
// MULTI-CAMERA EVENTS
// ═══════════════════════════════════════════════════════════════════════
void onMultiCameraStreamStatusChanged(ZoomVideoSDKMultiCameraStreamStatus status,
IZoomVideoSDKUser* user,
IZoomVideoSDKRawDataPipe* pipe) override {
// Called when multi-camera stream status changes
}
// ═══════════════════════════════════════════════════════════════════════
// DEVICE EVENTS
// ═══════════════════════════════════════════════════════════════════════
void onMicSpeakerVolumeChanged(unsigned int micVolume,
unsigned int speakerVolume) override {
// Called when mic/speaker volume changes
}
void onAudioDeviceStatusChanged(ZoomVideoSDKAudioDeviceType type,
ZoomVideoSDKAudioDeviceStatus status) override {
// Called when audio device status changes
}
void onTestMicStatusChanged(ZoomVideoSDK_TESTMIC_STATUS status) override {
// Called when test mic status changes
}
void onSelectedAudioDeviceChanged() override {
// Called when selected audio device changes
}
void onCameraListChanged() override {
// Called when camera list changes
}
// ═══════════════════════════════════════════════════════════════════════
// NETWORK EVENTS
// ═══════════════════════════════════════════════════════════════════════
void onUserVideoNetworkStatusChanged(ZoomVideoSDKNetworkStatus status,
IZoomVideoSDKUser* user) override {
// Called when video network status changes
}
void onProxyDetectComplete() override {
// Called when proxy detection completes
}
void onProxySettingNotification(IZoomVideoSDKProxySettingHandler* handler) override {
// Called when proxy settings notification
}
void onSSLCertVerifiedFailNotification(IZoomVideoSDKSSLCertificateInfo* info) override {
// Called when SSL cert verification fails
}
// ═══════════════════════════════════════════════════════════════════════
// CRC EVENTS
// ═══════════════════════════════════════════════════════════════════════
void onCallCRCDeviceStatusChanged(ZoomVideoSDKCRCCallStatus status) override {
// Called when CRC device status changes
}
// ═══════════════════════════════════════════════════════════════════════
// ANNOTATION EVENTS
// ═══════════════════════════════════════════════════════════════════════
void onAnnotationHelperCleanUp(IZoomVideoSDKAnnotationHelper* helper) override {
// Called when annotation helper cleanup
}
void onAnnotationPrivilegeChange(IZoomVideoSDKUser* user,
IZoomVideoSDKShareAction* shareAction) override {
// Called when annotation privilege changes
}
void onAnnotationHelperActived(void* handle) override {
// Called when annotation helper activated
}
// ═══════════════════════════════════════════════════════════════════════
// FILE TRANSFER EVENTS
// ═══════════════════════════════════════════════════════════════════════
void onSendFileStatus(IZoomVideoSDKSendFile* file,
const FileTransferStatus& status) override {
// Called when send file status changes
}
void onReceiveFileStatus(IZoomVideoSDKReceiveFile* file,
const FileTransferStatus& status) override {
// Called when receive file status changes
}
// ═══════════════════════════════════════════════════════════════════════
// INCOMING LIVE STREAM EVENTS
// ═══════════════════════════════════════════════════════════════════════
void onBindIncomingLiveStreamResponse(bool bSuccess, const zchar_t* strStreamKeyID) override {
// Called when bind incoming live stream response
}
void onUnbindIncomingLiveStreamResponse(bool bSuccess, const zchar_t* strStreamKeyID) override {
// Called when unbind incoming live stream response
}
void onIncomingLiveStreamStatusResponse(bool bSuccess,
IVideoSDKVector<IncomingLiveStreamStatus>* list) override {
// Called when incoming live stream status response
}
void onStartIncomingLiveStreamResponse(bool bSuccess, const zchar_t* strStreamKeyID) override {
// Called when start incoming live stream response
}
void onStopIncomingLiveStreamResponse(bool bSuccess, const zchar_t* strStreamKeyID) override {
// Called when stop incoming live stream response
}
// ═══════════════════════════════════════════════════════════════════════
// SHARE SETTING & CONTENT EVENTS
// ═══════════════════════════════════════════════════════════════════════
void onShareSettingChanged(ZoomVideoSDKShareSetting setting) override {
// Called when share settings change
}
void onUnsharingWindowsChanged(IVideoSDKVector<void*>* windowsList,
IZoomVideoSDKShareHelper* pShareHelper,
IZoomVideoSDKUser* pUser,
IZoomVideoSDKShareAction* pShareAction) override {
// Called when list of unsharing windows changes (macOS only)
}
void onSharingActiveMonitorChanged(IVideoSDKVector<void*>* monitorIDs,
IZoomVideoSDKShareHelper* pShareHelper,
IZoomVideoSDKUser* pUser,
IZoomVideoSDKShareAction* pShareAction) override {
// Called when active monitors displaying share changes
}
// ═══════════════════════════════════════════════════════════════════════
// AUDIO LEVEL & NETWORK EVENTS (NEW)
// ═══════════════════════════════════════════════════════════════════════
void onAudioLevelChanged(unsigned int level, bool bAudioSharing,
IZoomVideoSDKUser* pUser) override {
// Called when audio level changes (range 0-9)
}
void onUserNetworkStatusChanged(ZoomVideoSDKDataType type,
ZoomVideoSDKNetworkStatus level,
IZoomVideoSDKUser* pUser) override {
// Called when network status changes for specific data type
}
void onUserOverallNetworkStatusChanged(ZoomVideoSDKNetworkStatus level,
IZoomVideoSDKUser* pUser) override {
// Called when overall network status changes
}
void onShareNetworkStatusChanged(ZoomVideoSDKNetworkStatus shareNetworkStatus,
bool isSendingShare) override {
// Called when share network status changes (deprecated)
}
// ═══════════════════════════════════════════════════════════════════════
// LIVE TRANSCRIPTION EVENTS (ADDITIONAL)
// ═══════════════════════════════════════════════════════════════════════
void onSpokenLanguageChanged(ILiveTranscriptionLanguage* spokenLanguage) override {
// Called when spoken language changes
}
// ═══════════════════════════════════════════════════════════════════════
// ANNOTATION EVENTS (ADDITIONAL)
// ═══════════════════════════════════════════════════════════════════════
void onAnnotationToolTypeChanged(IZoomVideoSDKAnnotationHelper* helper,
void* handle,
ZoomVideoSDKAnnotationToolType toolType) override {
// Called when annotation tool type changes
}
// ═══════════════════════════════════════════════════════════════════════
// WHITEBOARD EVENTS
// ═══════════════════════════════════════════════════════════════════════
void onUserWhiteboardShareStatusChanged(IZoomVideoSDKUser* user,
IZoomVideoSDKWhiteboardHelper* helper) override {
// Called when whiteboard share status changes
}
void onWhiteboardExported(ZoomVideoSDKExportFormat format,
unsigned char* data, long length) override {
// Called when whiteboard export completes
}
// ═══════════════════════════════════════════════════════════════════════
// SUBSESSION (BREAKOUT ROOM) EVENTS
// ═══════════════════════════════════════════════════════════════════════
void onSubSessionStatusChanged(ZoomVideoSDKSubSessionStatus status,
IVideoSDKVector<ISubSessionKit*>* pSubSessionKitList) override {
// Called when subsession status changes
}
void onSubSessionManagerHandle(IZoomVideoSDKSubSessionManager* pManager) override {
// Called when user gains subsession manager privilege
}
void onSubSessionParticipantHandle(IZoomVideoSDKSubSessionParticipant* pParticipant) override {
// Called when user gains/loses subsession participant privileges
}
void onSubSessionUsersUpdate(ISubSessionKit* pSubSessionKit) override {
// Called when subsession users are updated
}
void onBroadcastMessageFromMainSession(const zchar_t* sMessage,
const zchar_t* sUserName) override {
// Called when receiving broadcast message from main session
}
void onSubSessionUserHelpRequest(ISubSessionUserHelpRequestHandler* pHandler) override {
// Called when receiving help request from subsession
}
void onSubSessionUserHelpRequestResult(ZoomVideoSDKUserHelpRequestResult eResult) override {
// Called with help request result
}
// ═══════════════════════════════════════════════════════════════════════
// BROADCAST STREAMING EVENTS
// ═══════════════════════════════════════════════════════════════════════
void onStartBroadcastResponse(bool bSuccess, const zchar_t* channelID) override {
// Called when start broadcast response received
}
void onStopBroadcastResponse(bool bSuccess) override {
// Called when stop broadcast response received
}
void onGetBroadcastControlStatus(bool bSuccess,
ZoomVideoSDKBroadcastControlStatus status) override {
// Called when get broadcast status response received
}
void onStreamingJoinStatusChanged(ZoomVideoSDKStreamingJoinStatus status) override {
// Called when viewer's join status changes
}
// ═══════════════════════════════════════════════════════════════════════
// RTMS (REAL-TIME MEDIA STREAMS) EVENTS
// ═══════════════════════════════════════════════════════════════════════
void onRealTimeMediaStreamsStatus(RealTimeMediaStreamsStatus status) override {
// Called when RTMS status changes
}
void onRealTimeMediaStreamsFail(RealTimeMediaStreamsFailReason failReason) override {
// Called when RTMS fails
}
// ═══════════════════════════════════════════════════════════════════════
// CANVAS SNAPSHOT EVENTS
// ═══════════════════════════════════════════════════════════════════════
void onCanvasSnapshotTaken(IZoomVideoSDKUser* pUser, bool isShare) override {
// Called when canvas snapshot is taken successfully
}
void onCanvasSnapshotIncompatible(IZoomVideoSDKUser* pUser) override {
// Called when snapshot cannot be taken due to compatibility
}
};Most Important Callbacks
| Callback | When to Use |
|---|---|
onSessionJoin | Start audio/video, subscribe to self |
onSessionLeave | Cleanup resources |
onError | Handle errors |
onUserJoin | Track new users (but don't subscribe video here!) |
onUserLeave | Cleanup user resources |
onUserVideoStatusChanged | Subscribe to video here |
onUserAudioStatusChanged | Track mute/unmute |
onChatNewMessageNotify | Handle chat messages |
onUserShareStatusChanged | Subscribe to screen share |
onVideoCanvasSubscribeFail | Handle subscription failures |
Related Documentation
SDK Architecture Pattern - Event-driven design
Video Rendering - Using video callbacks
Build Errors - Abstract class errors
API Reference - Full method signatures
TL;DR: Copy the template above and implement all methods. Focus on session, user, video, and audio events for basic functionality.
Requirements and compatibility
Written for: OpenAI Codex
Works with: Claude Code, Claude apps, OpenAI Codex, GitHub Copilot, Cursor, Gemini CLI, Kiro, OpenCode, Goose, Amp, Roo Code, JetBrains Junie, Factory Droid, Devin (ex-Windsurf), Mistral Vibe, OpenHands, Letta
“Works with” means the tool reads the open Agent Skills format; a skill written for one tool may use features others lack.
Security
No issues found by our static scan· No issues found
A static scan is not a guarantee. Skills are third-party content: review a skill before you let an agent use it.
Attribution and licence
- Created by
- Zoom
- Publisher
- OpenAI (Official)
- Distributed by
- OpenAI
- Source
- openai/plugins · plugins/zoom/skills/video-sdk/windows · commit d420d13
- Licence
- MIT License (redistribution allowed)
- LICENSE (added by AutoGineer from plugins/zoom/LICENSE)
- ATTRIBUTION.md (written by AutoGineer)
- Synced
AutoGineer is not affiliated with or endorsed by Zoom or OpenAI.
Download ZIP
The ZIP holds the skill’s files, its licence files and an ATTRIBUTION.md. Download zoom-video-sdk-windows.zip