Zoom Video SDK Linux
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 Linux provides a C++ library for building custom video applications, including headless bots and UI-integrated clients. Unlike other platforms, the Linux SDK does not provide a Canvas API, requiring developers to use a raw data pipe for all audio and video processing. This skill covers the architectural patterns, environment setup, and critical implementation requirements for Linux-based Zoom integrations.
What it does
- Provides guidance for building headless bots and custom UI applications using Qt or GTK.
- Explains the mandatory raw data pipe architecture for video and audio handling.
- Details the integration of virtual audio and video devices for headless environments.
- Outlines the singleton-based SDK architecture and event delegate patterns.
- Offers troubleshooting steps for PulseAudio, Qt dependencies, and build configurations.
- Supports advanced features like cloud recording, live streaming, and transcription.
When to use it
- When building custom video conferencing applications on Linux.
- When developing headless bots for automated session participation.
- When integrating Zoom video capabilities into existing C++ applications.
- When implementing custom media processing or injection pipelines.
Advantages
- Enables full control over raw audio and video streams.
- Supports headless operation via Docker and virtual device injection.
- Provides a consistent singleton-based API for session management.
- Includes comprehensive documentation for Linux-specific environment setup.
Usage examples
- “How do I join a session using the Zoom Video SDK on Linux?”
- The agent provides the session join pattern, including initializing the SDK, setting up delegates, and configuring the session context with necessary credentials and virtual device parameters.
- “Why is my video not rendering in my Linux Zoom application?”
- The agent explains that Linux lacks a Canvas API and guides the user to implement a raw data pipe to process and render YUV420 frames manually.
- “How do I configure audio for a headless bot on Linux?”
- The agent provides instructions for installing PulseAudio, configuring the zoomus.conf file, and initializing virtual audio speakers and microphones in the session context.
Install
Download the skill as a ZIP:
https://mp-staging.autogineer.com/agent-skills/openai/zoom-video-sdk-linux/downloadUnzip it into the cross-client skills folder of your project:
mkdir -p .agents/skills && unzip zoom-video-sdk-linux.zip -d .agents/skills
Documentation by Zoom
Zoom Video SDK - Linux Development
Expert guidance for developing with the Zoom Video SDK on Linux. Build headless bots, raw media capture/injection applications, and custom UI integrations with Qt/GTK.
Official Documentation: https://developers.zoom.us/docs/video-sdk/linux/ API Reference: https://marketplacefront.zoom.us/sdk/custom/linux/ Sample Repository: https://github.com/zoom/videosdk-linux-raw-recording-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
Raw Data vs Canvas - CRITICAL: Linux has NO Canvas API - raw data ONLY
Raw Video Capture - Capture and process YUV420 frames
Reference:
Singleton Hierarchy - 5-level SDK navigation map
API Reference - Complete API documentation
Qt/GTK Integration - UI framework patterns
Troubleshooting - Quick diagnostics
SKILL.md - Complete documentation navigation
Having issues?
PulseAudio setup → PulseAudio Guide
Qt dependencies → Qt Dependencies
Build errors → Build Errors Guide
Key Differences from Windows/macOS
| Feature | Linux | Windows/Mac |
|---|---|---|
| Canvas API | ❌ Not available | ✅ Available |
| Raw Data Pipe | ✅ ONLY option | ✅ Available |
| UI Integration | Qt, GTK, SDL2, OpenGL | Win32/WinForms/WPF, Cocoa |
| Headless Support | ✅ Excellent (Docker) | Limited |
| Audio | PulseAudio required | Native |
| Virtual Devices | ✅ Required for headless | Optional |
SDK Overview
The Zoom Video SDK for Linux is a C++ library optimized for:
Headless Bots: Docker/WSL support, no display required
Raw Data Access: Capture YUV420 video, PCM audio
Raw Data Injection: Virtual camera/mic for custom media
Screen Sharing: Capture or inject share data
Cloud Recording: Record sessions to Zoom cloud
Live Streaming: Stream to RTMP endpoints
Live Transcription: Real-time speech-to-text
Qt/GTK Integration: Full UI framework support
Prerequisites
System Requirements
OS: Ubuntu 20.04+, Debian 11+, or compatible
Architecture: x64 (recommended), ARM64
Compiler: GCC 9+, Clang 10+
CMake: 3.14 or later
Qt5: Bundled with SDK (do NOT install system Qt5)
Dependencies
sudo apt update
sudo apt install -y build-essential gcc cmake libglib2.0-dev liblzma-dev \
libxcb-image0 libxcb-keysyms1 libxcb-xfixes0 libxcb-xkb1 libxcb-shape0 \
libxcb-shm0 libxcb-randr0 libxcb-xtest0 libgbm1 libxtst6 libgl1 libnss3 \
libasound2 libpulse0
# For headless Linux
sudo apt install -y pulseaudio
# PulseAudio configuration (CRITICAL for audio)
mkdir -p ~/.config
echo "[General]" > ~/.config/zoomus.conf
echo "system.audio.type=default" >> ~/.config/zoomus.conf
# Log directory
mkdir -p ~/.zoom/logsQuick Start
#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
IZoomVideoSDK* sdk = CreateZoomVideoSDKObj();
// 2. Initialize
ZoomVideoSDKInitParams init_params;
init_params.domain = "https://zoom.us";
init_params.enableLog = true;
init_params.logFilePrefix = "bot";
init_params.videoRawDataMemoryMode = ZoomVideoSDKRawDataMemoryModeHeap;
init_params.shareRawDataMemoryMode = ZoomVideoSDKRawDataMemoryModeHeap;
init_params.audioRawDataMemoryMode = ZoomVideoSDKRawDataMemoryModeHeap;
sdk->initialize(init_params);
// 3. Add delegate
sdk->addListener(myDelegate);
// 4. Join session
ZoomVideoSDKSessionContext ctx;
ctx.sessionName = "my-session";
ctx.userName = "Linux Bot";
ctx.token = "jwt-token";
ctx.audioOption.connect = true;
ctx.audioOption.mute = false;
ctx.videoOption.localVideoOn = false;
// For headless: Virtual audio speaker
ctx.virtualAudioSpeaker = new VirtualSpeaker();
IZoomVideoSDKSession* session = sdk->joinSession(ctx);See Session Join Pattern for complete code.
Key Features
| Feature | Linux Support | Guide |
|---|---|---|
| Session Management | ✅ Full | Session Join |
| Raw Video (YUV420) | ✅ ONLY rendering option | Raw Video |
| Raw Audio (PCM) | ✅ Full | Raw Audio |
| Virtual Camera/Mic | ✅ Full | Virtual Devices |
| Cloud Recording | ✅ Full | Recording |
| Live Streaming | ✅ Full | Live Stream |
| Live Transcription | ✅ Full | Transcription |
| Command Channel | ✅ Full | Commands |
| Chat | ✅ Full | Chat |
| Qt Integration | ✅ Recommended | Qt/GTK |
| GTK Integration | ✅ Supported | Qt/GTK |
| Docker/Headless | ✅ Excellent | Virtual Devices |
Critical Gotchas
⚠️ CRITICAL #1: No Canvas API on Linux
Problem: Linux SDK does NOT have Canvas API like Windows/Mac.
Solution: You MUST use Raw Data Pipe and implement your own rendering.
See: Raw Data vs Canvas
⚠️ CRITICAL #2: PulseAudio Required for Audio
Problem: SDK requires PulseAudio for raw audio functions.
Solution:
sudo apt install -y pulseaudio
mkdir -p ~/.config
echo "[General]" > ~/.config/zoomus.conf
echo "system.audio.type=default" >> ~/.config/zoomus.confSee: PulseAudio Setup
⚠️ CRITICAL #3: Qt5 Dependencies
Problem: SDK requires Qt5 libraries (bundled, NOT system Qt5).
Solution:
# Copy from SDK package
cp -r samples/qt_libs/Qt/lib/* lib/zoom_video_sdk/
# Create symlinks
cd lib/zoom_video_sdk
for lib in libQt5*.so.5; do ln -sf $lib ${lib%.5}; doneSee: Qt Dependencies
⚠️ CRITICAL #4: Heap Memory Mode
Always use heap mode for raw data:
init_params.videoRawDataMemoryMode = ZoomVideoSDKRawDataMemoryModeHeap;
init_params.shareRawDataMemoryMode = ZoomVideoSDKRawDataMemoryModeHeap;
init_params.audioRawDataMemoryMode = ZoomVideoSDKRawDataMemoryModeHeap;⚠️ CRITICAL #5: Virtual Audio for Headless
Problem: Docker/headless environments have no audio devices.
Solution: Use virtual audio speaker and mic.
session_context.virtualAudioSpeaker = new VirtualSpeaker();
session_context.virtualAudioMic = new VirtualMic();See: Virtual Audio/Video
Sample Repositories
Official Samples
| Repository | Description |
|---|---|
| raw-recording-sample | Raw audio/video capture |
| qt-quickstart | Qt6 UI integration |
| gtk-quickstart | GTK3 UI integration |
Sample Architecture
Headless Bot (Docker):
┌──────────────────────────────────┐
│ Virtual Audio Speaker/Mic │
├──────────────────────────────────┤
│ Raw Data Processing │
│ - YUV420 → File/Stream
## Merged from video-sdk/linux/SKILL.md
# Zoom Video SDK Linux - Complete Documentation Index
## Quick Start Path
**If you're new to the SDK, follow this order:**
1. **Read the architecture pattern** → [concepts/sdk-architecture-pattern.md](concepts/sdk-architecture-pattern.md)
- Universal formula: Singleton → Delegate → Subscribe
- Once you understand this, you can implement any feature
2. **Understand Linux specifics** → [concepts/raw-data-vs-canvas.md](concepts/raw-data-vs-canvas.md)
- **CRITICAL**: Linux has NO Canvas API - raw data ONLY
3. **Implement session join** → [examples/session-join-pattern.md](examples/session-join-pattern.md)
- Complete working JWT + session join code
4. **Setup environment** → [troubleshooting/pulseaudio-setup.md](troubleshooting/pulseaudio-setup.md)
- PulseAudio configuration (required for audio)
- [troubleshooting/qt-dependencies.md](troubleshooting/qt-dependencies.md)
- Qt5 library setup (bundled with SDK)
5. **Implement features** → Choose from examples below
---
## Documentation Structure
video-sdk/linux/ ├── SKILL.md # Main skill overview ├── SKILL.md # This file - navigation guide ├── linux.md # Platform summary │ ├── concepts/ # Core architectural patterns │ ├── sdk-architecture-pattern.md # Universal formula for ANY feature │ ├── singleton-hierarchy.md # 5-level navigation guide │ └── raw-data-vs-canvas.md # Linux-specific: raw data ONLY │ ├── examples/ # Complete working code │ ├── session-join-pattern.md # JWT auth + session join │ └── command-channel.md # Command channel with threading │ ├── troubleshooting/ # Problem solving guides │ ├── pulseaudio-setup.md # Audio configuration │ ├── qt-dependencies.md # Qt5 library setup │ ├── build-errors.md # Common build issues │ └── common-issues.md # Quick diagnostic workflow │ └── references/ # Reference documentation └── linux-reference.md # API hierarchy, methods, error codes
---
## By Use Case
### I want to build a headless bot
1. [SDK Architecture Pattern](concepts/sdk-architecture-pattern.md) - Understand the pattern
2. [Session Join Pattern](examples/session-join-pattern.md) - Join sessions
3. [PulseAudio Setup](troubleshooting/pulseaudio-setup.md) - Configure audio
4. [Raw Data vs Canvas](concepts/raw-data-vs-canvas.md) - Understand Linux differences
### I'm getting build errors
1. [Build Errors Guide](troubleshooting/build-errors.md) - SDK build issues
2. [Qt Dependencies](troubleshooting/qt-dependencies.md) - Qt5 setup
3. [Common Issues](troubleshooting/common-issues.md) - Quick diagnostics
### I'm getting runtime errors
1. [PulseAudio Setup](troubleshooting/pulseaudio-setup.md) - Audio not working
2. [Qt Dependencies](troubleshooting/qt-dependencies.md) - Library not found
3. [Common Issues](troubleshooting/common-issues.md) - Error code tables
### I want to use command channel
1. [Command Channel](examples/command-channel.md) - Send/receive commands
2. [Common Issues](troubleshooting/common-issues.md) - Threading requirements
### I want to implement a specific feature
1. [SDK Architecture Pattern](concepts/sdk-architecture-pattern.md) - **START HERE!**
2. [Singleton Hierarchy](concepts/singleton-hierarchy.md) - Navigate to the feature
3. [API Reference](references/linux-reference.md) - Method signatures
---
## Most Critical Documents
### 1. SDK Architecture Pattern (MASTER DOCUMENT)
**[concepts/sdk-architecture-pattern.md](concepts/sdk-architecture-pattern.md)**
The universal 3-step pattern:
1. Get singleton (SDK, helpers, session, users)
2. Implement delegate (event callbacks)
3. Subscribe and use
### 2. Raw Data vs Canvas (LINUX-SPECIFIC)
**[concepts/raw-data-vs-canvas.md](concepts/raw-data-vs-canvas.md)**
**CRITICAL**: Unlike Windows/Mac, Linux SDK has NO Canvas API. You MUST use raw data pipe.
### 3. PulseAudio Setup (MOST COMMON ISSUE)
**[troubleshooting/pulseaudio-setup.md](troubleshooting/pulseaudio-setup.md)**
Audio requires PulseAudio configuration.
### 4. Qt Dependencies
**[troubleshooting/qt-dependencies.md](troubleshooting/qt-dependencies.md)**
SDK requires bundled Qt5 libraries, NOT system Qt5.
---
## Key Learnings
### Critical Discoveries:
1. **Linux has NO Canvas API**
- Windows/Mac have Canvas API for SDK-rendered video
- Linux MUST use Raw Data Pipe
- See: [Raw Data vs Canvas](concepts/raw-data-vs-canvas.md)
2. **PulseAudio is MANDATORY**
- SDK requires PulseAudio for raw audio
- Must configure ~/.config/zoomus.conf
- See: [PulseAudio Setup](troubleshooting/pulseaudio-setup.md)
3. **Use Bundled Qt5, NOT System Qt5**
- SDK includes specific Qt5 versions
- Copy from samples/qt_libs/
- See: [Qt Dependencies](troubleshooting/qt-dependencies.md)
4. **Helpers Control YOUR Streams Only**
- `videoHelper->startVideo()` starts YOUR camera
- To see others, subscribe to their VideoPipe
- See: [Singleton Hierarchy](concepts/singleton-hierarchy.md)
5. **Virtual Devices for Headless**
- Docker/headless needs virtual audio speaker/mic
- Set before joining session
- See: [Session Join Pattern](examples/session-join-pattern.md)
6. **Always Use Heap Memory Mode**
```cpp
init_params.videoRawDataMemoryMode = ZoomVideoSDKRawDataMemoryModeHeap;GLib Main Loop Required
while/sleep loops don't dispatch SDK events
Must use g_main_loop_run()
See: Common Issues
All SDK Calls Must Be on Main Thread
Background thread SDK calls return error 2 (Internal_Error)
Use g_idle_add() to schedule on GLib main thread
See: Command Channel
Command Channel is Session-Scoped
Does NOT span across different sessions
Both sender and receiver must be in the same session
See: Command Channel
Sample Repositories
raw-recording-sample - Official raw data sample
qt-quickstart - Qt6 UI integration
gtk-quickstart - GTK3 UI integration
Quick Reference
"My code won't compile"
"Audio not working"
"Library not found"
"How do I implement [feature]?"
"What error code means what?"
Document Version
Based on Zoom Video SDK for Linux 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 AutoGineer882 B
- LICENSELicence file added by AutoGineer1.1 KiB
- RUNBOOK.md2.2 KiB
- SKILL.md15.3 KiB
- agents/openai.yaml246 B
- concepts/raw-data-vs-canvas.md16.4 KiB
- concepts/sdk-architecture-pattern.md14.7 KiB
- concepts/singleton-hierarchy.md15.0 KiB
- examples/chat.md215 B
- examples/cloud-recording.md395 B
- examples/command-channel.md9.7 KiB
- examples/live-streaming.md234 B
- examples/qt-gtk-integration.md261 B
- examples/raw-audio-capture.md215 B
- examples/raw-video-capture.md251 B
- examples/session-join-pattern.md21.2 KiB
- examples/transcription.md255 B
- examples/virtual-audio-video.md279 B
- linux.md25.7 KiB
- references/linux-reference.md26.7 KiB
- troubleshooting/build-errors.md2.0 KiB
- troubleshooting/common-issues.md5.3 KiB
- troubleshooting/pulseaudio-setup.md1.7 KiB
- troubleshooting/qt-dependencies.md1.9 KiB
concepts/singleton-hierarchy.md
Singleton Hierarchy - Complete SDK Navigation Map
5-Level SDK Navigation
The Zoom Video SDK for Linux follows a hierarchical singleton pattern. Understanding this hierarchy is the key to navigating the entire SDK.
Level 1: SDK Singleton
└─ IZoomVideoSDK (CreateZoomVideoSDKObj)
│
├─ Level 2: Session Info
│ └─ IZoomVideoSDKSession (via getSessionInfo)
│ └─ Level 3: Users
│ └─ IZoomVideoSDKUser[] (via getMyself, getAllUsers, getRemoteUsers)
│ └─ Level 4: User Pipes
│ ├─ IZoomVideoSDKRawDataPipe (via GetVideoPipe)
│ └─ IZoomVideoSDKRawDataPipe (via GetSharePipe)
│
└─ Level 2: Feature Helpers
├─ IZoomVideoSDKAudioHelper (getAudioHelper)
├─ IZoomVideoSDKVideoHelper (getVideoHelper)
├─ IZoomVideoSDKShareHelper (getShareHelper)
├─ IZoomVideoSDKChatHelper (getChatHelper)
├─ IZoomVideoSDKRecordingHelper (getRecordingHelper)
├─ IZoomVideoSDKLiveStreamHelper (getLiveStreamHelper)
├─ IZoomVideoSDKLiveTranscriptionHelper (getLiveTranscriptionHelper)
├─ IZoomVideoSDKCmdChannel (getCmdChannel)
├─ IZoomVideoSDKPhoneHelper (getPhoneHelper)
├─ IZoomVideoSDKCRCHelper (getCRCHelper)
├─ IZoomVideoSDKWhiteboardHelper (getWhiteboardHelper)
├─ IZoomVideoSDKSubSessionHelper (getSubSessionHelper)
└─ Settings Helpers
├─ IZoomVideoSDKAudioSettingHelper (getAudioSettingHelper)
├─ IZoomVideoSDKVideoSettingHelper (getVideoSettingHelper)
└─ IZoomVideoSDKShareSettingHelper (getShareSettingHelper)Level 1: SDK Singleton
Entry Point: This is where everything starts.
// Create SDK object
IZoomVideoSDK* video_sdk_obj = CreateZoomVideoSDKObj();
// Initialize
ZoomVideoSDKInitParams init_params;
init_params.domain = "https://zoom.us";
init_params.enableLog = true;
init_params.logFilePrefix = "bot";
init_params.videoRawDataMemoryMode = ZoomVideoSDKRawDataMemoryModeHeap;
init_params.shareRawDataMemoryMode = ZoomVideoSDKRawDataMemoryModeHeap;
init_params.audioRawDataMemoryMode = ZoomVideoSDKRawDataMemoryModeHeap;
video_sdk_obj->initialize(init_params);
// Join session
ZoomVideoSDKSessionContext ctx;
ctx.sessionName = "my-session";
ctx.userName = "Bot";
ctx.token = "jwt-token";
IZoomVideoSDKSession* session = video_sdk_obj->joinSession(ctx);
// Cleanup
video_sdk_obj->leaveSession(false);
video_sdk_obj->cleanup();
DestroyZoomVideoSDKObj();Key Methods:
initialize()- Must be called before any other SDK operationsjoinSession()- Join or create a sessionleaveSession(bool endSession)- Leave session (host can end for all)cleanup()- Release SDK resourcesaddListener()/removeListener()- Register event callbacksisInSession()- Check if currently in a sessiongetSessionInfo()- Access Level 2: Sessionget*Helper()- Access Level 2: Feature Helpers
Level 2A: Session Info
Purpose: Access session-level information and users.
IZoomVideoSDKSession* session = video_sdk_obj->getSessionInfo();Key Methods:
// Current user
IZoomVideoSDKUser* myself = session->getMyself();
// All users (including self)
IVideoSDKVector<IZoomVideoSDKUser*>* all = session->getAllUsers();
// Remote users only (excluding self)
IVideoSDKVector<IZoomVideoSDKUser*>* remote = session->getRemoteUsers();
// Session info
const char* sessionName = session->getSessionName();
const char* sessionID = session->getSessionID();
const char* sessionPassword = session->getSessionPassword();
const char* sessionHost = session->getSessionHost();Level 2B: Feature Helpers
Feature helpers control YOUR streams and actions. They do NOT control other users' streams.
Audio Helper
Purpose: Control YOUR audio (mic, speaker, mute).
IZoomVideoSDKAudioHelper* audio = video_sdk_obj->getAudioHelper();
// Start/stop your audio
audio->startAudio();
audio->stopAudio();
// Mute/unmute yourself
audio->muteAudio(true);
audio->unmuteAudio();
// Subscribe to raw audio callbacks
audio->subscribe();
audio->unSubscribe();
// Device management
IVideoSDKVector<IZoomVideoSDKMicDevice*>* mics = audio->getMicList();
IVideoSDKVector<IZoomVideoSDKSpeakerDevice*>* speakers = audio->getSpeakerList();
audio->selectMic(deviceID);
audio->selectSpeaker(deviceID);Key Insight: To receive others' audio, subscribe via subscribe() and implement audio callbacks in IZoomVideoSDKDelegate.
Video Helper
Purpose: Control YOUR video (camera).
IZoomVideoSDKVideoHelper* video = video_sdk_obj->getVideoHelper();
// Start/stop your video
video->startVideo();
video->stopVideo();
// Camera management
IVideoSDKVector<IZoomVideoSDKCameraDevice*>* cameras = video->getCameraList();
video->selectCamera(deviceID);
// Video settings
video->rotateMyVideo(90); // 0, 90, 180, 270Key Insight: To receive others' video, subscribe to their GetVideoPipe().
Share Helper
Purpose: Control YOUR screen share.
IZoomVideoSDKShareHelper* share = video_sdk_obj->getShareHelper();
// Start/stop screen share
share->startShare();
share->stopShare();
// Custom share source
IZoomVideoSDKShareSource* source = new MyShareSource();
share->startSharingExternalSource(source);
// Share status
bool isSharing = share->isSharingOut();
bool canShare = share->isSharingOut() == false;Key Insight: To receive others' share, subscribe to their GetSharePipe().
Chat Helper
Purpose: Send/receive chat messages.
IZoomVideoSDKChatHelper* chat = video_sdk_obj->getChatHelper();
// Send messages
chat->sendChatToAll("Hello everyone!");
chat->sendChatToUser(user, "Private message");
// Delete messages (host only)
chat->deleteChatMessage(messageID);
// Check privileges
ZoomVideoSDKChatPrivilegeType priv = chat->getChatPrivilege();Receive: Implement onChatNewMessageNotify() in delegate.
Recording Helper
Purpose: Cloud recording control.
IZoomVideoSDKRecordingHelper* rec = video_sdk_obj->getRecordingHelper();
// Check permissions
ZoomVideoSDKErrors canRecord = rec->canStartRecording();
if (canRecord == ZoomVideoSDKErrors_Success) {
// Start recording
rec->startCloudRecording();
}
// Stop recording
rec->stopCloudRecording();
// Pause/resume
rec->pauseCloudRecording();
rec->resumeCloudRecording();
// Check status
bool isRecording = rec->isCloudRecording();Receive status: Implement onCloudRecordingStatus() in delegate.
Live Stream Helper
Purpose: RTMP live streaming.
IZoomVideoSDKLiveStreamHelper* stream = video_sdk_obj->getLiveStreamHelper();
// Check permissions
ZoomVideoSDKErrors canStream = stream->canStartLiveStream();
if (canStream == ZoomVideoSDKErrors_Success) {
// Start live stream
stream->startLiveStream("rtmp://...", "stream-key", "broadcast-url");
}
// Stop stream
stream->stopLiveStream();
// Check status
bool isStreaming = stream->isInLiveStreamingMode();Receive status: Implement onLiveStreamStatusChanged() in delegate.
Live Transcription Helper
Purpose: Real-time speech-to-text.
IZoomVideoSDKLiveTranscriptionHelper* trans = video_sdk_obj->getLiveTranscriptionHelper();
// Check permissions
bool canStart = trans->canStartLiveTranscription();
if (canStart) {
// Start transcription
trans->startLiveTranscription();
}
// Stop transcription
trans->stopLiveTranscription();
// Set language
IVideoSDKVector<ILiveTranscriptionLanguage*>* langs = trans->getAvailableSpokenLanguages();
trans->setSpokenLanguage(langs->GetItem(0)->getLTTLanguageID());Receive messages: Implement onLiveTranscriptionMsgInfoReceived() in delegate.
Command Channel
Purpose: Custom command messaging between participants.
IZoomVideoSDKCmdChannel* cmd = video_sdk_obj->getCmdChannel();
// Send command to user
cmd->sendCommand(user, "custom-command-data");Receive: Implement onCommandReceived() in delegate.
Phone Helper
Purpose: PSTN dial-out.
IZoomVideoSDKPhoneHelper* phone = video_sdk_obj->getPhoneHelper();
// Get supported countries
IVideoSDKVector<IZoomVideoSDKPhoneSupportCountryInfo*>* countries = phone->getSupportCountryInfo();
// Invite by phone
phone->inviteByPhone(countryCode, phoneNumber, displayName);
// Cancel invitation
phone->cancelInviteByPhone(success_callback, fail_callback);Settings Helpers
Purpose: Configure audio/video/share settings.
// Audio settings
IZoomVideoSDKAudioSettingHelper* audioSettings = video_sdk_obj->getAudioSettingHelper();
audioSettings->setMicVolume(volume);
audioSettings->setSpeakerVolume(volume);
// Video settings
IZoomVideoSDKVideoSettingHelper* videoSettings = video_sdk_obj->getVideoSettingHelper();
videoSettings->setOriginalSizeMode(true);
// Share settings
IZoomVideoSDKShareSettingHelper* shareSettings = video_sdk_obj->getShareSettingHelper();Level 3: Users
Purpose: Access individual user objects.
// Get current user
IZoomVideoSDKUser* myself = video_sdk_obj->getSessionInfo()->getMyself();
// Get all users
IVideoSDKVector<IZoomVideoSDKUser*>* users = video_sdk_obj->getSessionInfo()->getAllUsers();
// Iterate users
for (int i = 0; i < users->GetCount(); i++) {
IZoomVideoSDKUser* user = users->GetItem(i);
const char* name = user->getUserName();
bool isHost = user->isHost();
bool isManager = user->isManager();
}User Methods:
// User info
const char* getUserName();
const char* getUserGuid();
bool isHost();
bool isManager();
// Video status
IZoomVideoSDKRawDataPipe* GetVideoPipe(); // Level 4
// Audio status
IZoomVideoSDKAudioStatus* getAudioStatus();
// Share status
IZoomVideoSDKRawDataPipe* GetSharePipe(); // Level 4Level 4: User Pipes
Purpose: Subscribe to raw video/share data from specific users.
Video Pipe
IZoomVideoSDKUser* user = /* get from session */;
IZoomVideoSDKRawDataPipe* videoPipe = user->GetVideoPipe();
// Subscribe to user's video
class VideoDelegate : public IZoomVideoSDKRawDataPipeDelegate {
void onRawDataFrameReceived(YUVRawDataI420* data) override {
// Process YUV420 frame
}
void onRawDataStatusChanged(RawDataStatus status) override {
// Video on/off
}
};
videoPipe->subscribe(ZoomVideoSDKResolution_720P, new VideoDelegate());
// Unsubscribe
videoPipe->unSubscribe();Share Pipe
IZoomVideoSDKUser* user = /* get from session */;
IZoomVideoSDKRawDataPipe* sharePipe = user->GetSharePipe();
// Subscribe to user's share (same pattern as video)
sharePipe->subscribe(ZoomVideoSDKResolution_1080P, new ShareDelegate());Navigation Patterns
Pattern: Feature → Helper
"I want to do X" → Find the helper that controls X.
| Want to... | Navigate to... |
|---|---|
| Start my audio | getAudioHelper()->startAudio() |
| Start my video | getVideoHelper()->startVideo() |
| Share my screen | getShareHelper()->startShare() |
| Send chat | getChatHelper()->sendChatToAll() |
| Start recording | getRecordingHelper()->startCloudRecording() |
| Start live stream | getLiveStreamHelper()->startLiveStream() |
| Start transcription | getLiveTranscriptionHelper()->startLiveTranscription() |
Pattern: Receive Data → Pipes
"I want to receive X from others" → Subscribe to user pipes or implement delegate callbacks.
| Want to receive... | Navigate to... |
|---|---|
| Others' video (raw) | user->GetVideoPipe()->subscribe() |
| Others' share (raw) | user->GetSharePipe()->subscribe() |
| Mixed audio (raw) | getAudioHelper()->subscribe() + onMixedAudioRawDataReceived() |
| Per-user audio (raw) | getAudioHelper()->subscribe() + onOneWayAudioRawDataReceived() |
| Chat messages | Implement onChatNewMessageNotify() |
| Commands | Implement onCommandReceived() |
Pattern: Virtual Devices → Session Context
"I want to inject custom data" → Set virtual devices in session context BEFORE joining.
| Want to inject... | Navigate to... |
|---|---|
| Custom audio (mic) | session_context.virtualAudioMic = new MyMic() |
| Custom video | session_context.externalVideoSource = new MyVideo() |
| Virtual speaker (headless) | session_context.virtualAudioSpeaker = new MySpeaker() |
| Custom share | getShareHelper()->startSharingExternalSource(source) |
Quick Reference
Get SDK Object
IZoomVideoSDK* sdk = CreateZoomVideoSDKObj();Get Session
IZoomVideoSDKSession* session = sdk->getSessionInfo();Get Users
IZoomVideoSDKUser* myself = session->getMyself();
IVideoSDKVector<IZoomVideoSDKUser*>* all = session->getAllUsers();
IVideoSDKVector<IZoomVideoSDKUser*>* remote = session->getRemoteUsers();Get Helpers
IZoomVideoSDKAudioHelper* audio = sdk->getAudioHelper();
IZoomVideoSDKVideoHelper* video = sdk->getVideoHelper();
IZoomVideoSDKShareHelper* share = sdk->getShareHelper();
IZoomVideoSDKChatHelper* chat = sdk->getChatHelper();
IZoomVideoSDKRecordingHelper* rec = sdk->getRecordingHelper();
IZoomVideoSDKLiveStreamHelper* stream = sdk->getLiveStreamHelper();
IZoomVideoSDKLiveTranscriptionHelper* trans = sdk->getLiveTranscriptionHelper();
IZoomVideoSDKCmdChannel* cmd = sdk->getCmdChannel();Get Pipes
IZoomVideoSDKRawDataPipe* videoPipe = user->GetVideoPipe();
IZoomVideoSDKRawDataPipe* sharePipe = user->GetSharePipe();Complete Navigation Example
// Level 1: SDK Singleton
IZoomVideoSDK* sdk = CreateZoomVideoSDKObj();
sdk->initialize(init_params);
sdk->joinSession(session_context);
// Level 2A: Session Info
IZoomVideoSDKSession* session = sdk->getSessionInfo();
// Level 3: Users
IZoomVideoSDKUser* myself = session->getMyself();
IVideoSDKVector<IZoomVideoSDKUser*>* remote = session->getRemoteUsers();
// Level 4: Subscribe to remote user's video
IZoomVideoSDKUser* remoteUser = remote->GetItem(0);
IZoomVideoSDKRawDataPipe* videoPipe = remoteUser->GetVideoPipe();
videoPipe->subscribe(ZoomVideoSDKResolution_720P, videoDelegate);
// Level 2B: Control my audio
IZoomVideoSDKAudioHelper* audio = sdk->getAudioHelper();
audio->startAudio();
audio->subscribe(); // For raw audio callbacks
// Level 2B: Control my video
IZoomVideoSDKVideoHelper* video = sdk->getVideoHelper();
video->startVideo();
// Level 2B: Send chat
IZoomVideoSDKChatHelper* chat = sdk->getChatHelper();
chat->sendChatToAll("Hello!");
// Level 2B: Start recording
IZoomVideoSDKRecordingHelper* rec = sdk->getRecordingHelper();
if (rec->canStartRecording() == ZoomVideoSDKErrors_Success) {
rec->startCloudRecording();
}See Also
SDK Architecture Pattern - Universal 3-step pattern
API Reference - Complete API documentation
Session Join Pattern - Working session join code
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/linux · 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-linux.zip