Meeting SDK Linux
AnthropicOfficialCreated by ZoomDistributed by Anthropic
- Skill
- Tool integration
- Software development
- MIT
- Low risk
AutoGineer summary
Written by AutoGineer from the skill’s own files, not by the author
The Zoom Meeting SDK for Linux provides a C++ library designed for headless server environments, enabling developers to create bots that join meetings, capture raw audio and video, and perform automated tasks. It supports asynchronous event handling via GLib and is optimized for deployment in environments like Ubuntu or CentOS, providing direct access to PCM audio and YUV420 video streams.
What it does
- Enables headless participation in Zoom meetings without a GUI
- Provides raw access to audio and video streams for AI processing
- Supports programmatic control over meeting recording and participant management
- Integrates with PulseAudio for virtual audio device handling in server environments
- Facilitates asynchronous event management using GLib main loops
When to use it
- When building automated meeting transcription or AI-powered assistants
- When creating bots that require raw media data for custom analysis
- When implementing server-side meeting recording and monitoring solutions
- When deploying meeting bots in Linux-based cloud or containerized environments
Advantages
- Optimized for headless operation in server-side environments
- Direct access to raw media formats for flexible integration with AI pipelines
- Comprehensive support for meeting lifecycle management and recording controls
- Well-documented integration paths for common Linux distributions
Usage examples
- “How do I start raw recording in my C++ meeting bot?”
- The bot must first join the meeting, then use the meeting recording controller to verify permissions via CanStartRawRecording and initiate the stream with StartRawRecording.
- “What is required to handle audio in a headless Linux environment?”
- You must install PulseAudio, configure a virtual audio device, and ensure the environment is set up with the appropriate configuration file to allow the SDK to capture audio.
Install
Download the skill as a ZIP:
https://mp-staging.autogineer.com/agent-skills/anthropics/meeting-sdk-linux/downloadUnzip it into the cross-client skills folder of your project:
mkdir -p .agents/skills && unzip meeting-sdk-linux.zip -d .agents/skills
Documentation by Zoom
Zoom Meeting SDK - Linux Development
Expert guidance for building headless meeting bots with the Zoom Meeting SDK on Linux. This SDK enables server-side meeting participation, raw media capture, transcription, and AI-powered meeting automation.
How to Build a Meeting Bot That Automatically Joins and Records
Use this skill when the requirement is:
visible bot joins a real Zoom meeting
the bot records raw media itself
or the bot triggers a Zoom-managed cloud-recording workflow after join
Skill chain:
primary:
meeting-sdk/linuxadd
zoom-rest-apifor OBF/ZAK lookup, scheduling, or cloud-recording settingsadd
zoom-webhookswhen post-meeting cloud recording retrieval is required
Minimal raw-recording flow:
JoinParam join_param;
join_param.userType = SDK_UT_WITHOUT_LOGIN;
auto& params = join_param.param.withoutloginuserJoin;
params.meetingNumber = meeting_number;
params.userName = "Recording Bot";
params.psw = meeting_password.c_str();
params.app_privilege_token = obf_token.c_str();
SDKError join_err = meeting_service->Join(join_param);
if (join_err != SDKERR_SUCCESS) {
throw std::runtime_error("join_failed");
}
// In MEETING_STATUS_INMEETING callback:
auto* record_ctrl = meeting_service->GetMeetingRecordingController();
if (!record_ctrl) {
throw std::runtime_error("recording_controller_unavailable");
}
if (record_ctrl->CanStartRawRecording() != SDKERR_SUCCESS) {
throw std::runtime_error("raw_recording_not_permitted");
}
SDKError record_err = record_ctrl->StartRawRecording();
if (record_err != SDKERR_SUCCESS) {
throw std::runtime_error("start_raw_recording_failed");
}
GetAudioRawdataHelper()->subscribe(new MyAudioDelegate());Use raw recording when the bot must own PCM/YUV media or feed an AI pipeline directly.
Use cloud recording + webhooks when the requirement is Zoom-managed MP4/M4A/transcript assets after the meeting.
Official Documentation: https://developers.zoom.us/docs/meeting-sdk/linux/
API Reference: https://marketplacefront.zoom.us/sdk/meeting/linux/
Sample Repository (Raw Recording): https://github.com/zoom/meetingsdk-linux-raw-recording-sample
Sample Repository (Headless): https://github.com/zoom/meetingsdk-headless-linux-sample
Quick Links
New to Meeting SDK Linux? Follow this path:
linux.md - Quick start guide with complete workflow
concepts/high-level-scenarios.md - Production bot architectures
meeting-sdk-bot.md - Resilient bot with retry logic
references/linux-reference.md - Dependencies, Docker, CMake
Common Use Cases:
Transcription Bot → high-level-scenarios.md#scenario-1-transcription-bot
Recording Bot → high-level-scenarios.md#scenario-2-recording-bot
AI Meeting Assistant → high-level-scenarios.md#scenario-3-ai-meeting-assistant
Quality Monitoring → high-level-scenarios.md#scenario-4-monitoring-quality-bot
Auto-Join + Recording Bot → meeting-sdk-bot.md for raw recording orchestration, retry, and cloud-recording handoff
Having issues?
Docker audio issues → references/linux-reference.md#pulseaudio-setup
Raw recording permission denied → meeting-sdk-bot.md#raw-recording-permission-denied
Build errors → references/linux-reference.md#troubleshooting
Routing Rule for Bots
If the user asks to build a bot that automatically joins a Zoom meeting and records it, start with meeting-sdk-bot.md.
Use Meeting SDK Linux for the visible participant, join flow, and raw recording control.
Chain zoom-rest-api when the bot must fetch OBF/ZAK tokens, schedule meetings, or enable account-side recording settings.
Chain zoom-webhooks when the requirement is Zoom cloud recording retrieval after meeting end.
SDK Overview
The Zoom Meeting SDK for Linux is a C++ library optimized for headless server environments:
Headless Operation: No GUI required, perfect for Docker/cloud
Raw Data Access: YUV420 video, PCM audio at 32kHz
GLib Event Loop: Async event handling for callbacks
Docker-Ready: Pre-configured Dockerfiles for CentOS/Ubuntu
PulseAudio Integration: Virtual audio devices for headless environments
Key Differences from Video SDK
| Feature | Meeting SDK (Linux) | Video SDK |
|---|---|---|
| Primary Use | Join existing meetings as bot | Host custom video sessions |
| Visibility | Visible participant | Session participant |
| UI | Headless (no UI) | Optional custom UI |
| Authentication | JWT + OBF/ZAK for external meetings | JWT only |
| Recording Control | StartRawRecording() required | Direct raw data access |
| Platform | Linux only | Windows, macOS, iOS, Android |
Prerequisites
System Requirements
OS: Ubuntu 22+, CentOS 8/9, Oracle Linux 8
Architecture: x86_64
Compiler: gcc/g++ with C++11 support
Build Tools: cmake 3.16+
Development Dependencies
# Ubuntu
apt-get install -y build-essential cmake \
libx11-xcb1 libxcb-xfixes0 libxcb-shape0 libxcb-shm0 \
libxcb-randr0 libxcb-image0 libxcb-keysyms1 libxcb-xtest0 \
libglib2.0-dev libcurl4-openssl-dev pulseaudio
# CentOS
yum install -y cmake gcc gcc-c++ \
libxcb-devel xcb-util-image xcb-util-keysyms \
glib2-devel libcurl-devel pulseaudioRequired Credentials
Zoom Meeting SDK App (Client ID & Secret) → Create at Marketplace
JWT Token → Generate from Client ID/Secret
For External Meetings: OBF token OR ZAK token → Get via REST API
For Raw Recording: Meeting Recording Token (optional) → Get via API
Quick Start
1. Download & Extract SDK
# Download from https://marketplace.zoom.us/
tar xzf zoom-meeting-sdk-linux_x86_64-{version}.tar
# Organize files
mkdir -p demo/include/h demo/lib/zoom_meeting_sdk
cp -r h/* demo/include/h/
cp lib*.so demo/lib/zoom_meeting_sdk/
cp -r qt_libs demo/lib/zoom_meeting_sdk/
cp translation.json demo/lib/zoom_meeting_sdk/json/
# Create required symlink
cd demo/lib/zoom_meeting_sdk && ln -s libmeetingsdk.so libmeetingsdk.so.12. Initialize & Auth
#include "zoom_sdk.h"
USING_ZOOM_SDK_NAMESPACE
// Initialize SDK
InitParam init_params;
init_params.strWebDomain = "https://zoom.us";
init_params.enableLogByDefault = true;
init_params.rawdataOpts.audioRawDataMemoryMode = ZoomSDKRawDataMemoryModeHeap;
InitSDK(init_params);
// Authenticate with JWT
AuthContext auth_ctx;
auth_ctx.jwt_token = your_jwt_token;
CreateAuthService(&auth_service);
auth_service->SDKAuth(auth_ctx);3. Join Meeting
// In onAuthenticationReturn callback
void onAuthenticationReturn(AuthResult ret) {
if (ret == AUTHRET_SUCCESS) {
JoinParam join_param;
join_param.userType = SDK_UT_WITHOUT_LOGIN;
auto& params = join_param.param.withoutloginuserJoin;
params.meetingNumber = 1234567890;
params.userName = "Bot";
params.psw = "password";
params.isVideoOff = true;
params.isAudioOff = false;
meeting_service->Join(join_param);
}
}4. Access Raw Data
// In onMeetingStatusChanged callback
void onMeetingStatusChanged(MeetingStatus status, int iResult) {
if (status == MEETING_STATUS_INMEETING) {
auto* record_ctrl = meeting_service->GetMeetingRecordingController();
// Start raw recording (enables raw data access)
if (record_ctrl->CanStartRawRecording() == SDKERR_SUCCESS) {
record_ctrl->StartRawRecording();
// Subscribe to audio
auto* audio_helper = GetAudioRawdataHelper();
audio_helper->subscribe(new MyAudioDelegate());
// Subscribe to video
IZoomSDKRenderer* video_renderer;
createRenderer(&video_renderer, new MyVideoDelegate());
video_renderer->setRawDataResolution(ZoomSDKResolution_720P);
video_renderer->subscribe(user_id, RAW_DATA_TYPE_VIDEO);
}
}
}Key Features
| Feature | Description |
|---|---|
| Headless Operation | No GUI, perfect for Docker/server deployments |
| Raw Audio (PCM) | Capture mixed or per-user audio at 32kHz |
| Raw Video (YUV420) | Capture video frames in contiguous planar format |
| GLib Event Loop | Async callback handling |
| Docker Support | Pre-built Dockerfiles for CentOS/Ubuntu |
| PulseAudio Virtual Devices | Audio in headless environments |
| Breakout Rooms | Programmatic breakout room management |
| Chat | Send/receive in-meeting chat |
| Recording Control | Local, cloud, and raw recording |
Critical Gotchas & Best Practices
⚠️ CRITICAL: PulseAudio for Docker/Headless
The #1 issue for raw audio in Docker:
Raw audio requires PulseAudio and a config file, even in headless environments.
Solution:
# Install PulseAudio
apt-get install -y pulseaudio pulseaudio-utils
# Create config file
mkdir -p ~/.config
cat > ~/.config/zoomus.conf << EOF
[General]
system.audio.type=default
EOF
# Start PulseAudio with virtual devices
pulseaudio --start --exit-idle-time=-1
pactl load-module module-null-sink sink_name=virtual_speaker
pactl load-module module-null-sink sink_name=virtual_micSee: references/linux-reference.md#pulseaudio-setup
Raw Recording Permission Required
Unlike Video SDK, Meeting SDK requires explicit permission to access raw data:
// MUST call StartRawRecording() first
auto* record_ctrl = meeting_service->GetMeetingRecordingController();
SDKError can_record = record_ctrl->CanStartRawRecording();
if (can_record == SDKERR_SUCCESS) {
record_ctrl->StartRawRecording();
// NOW you can subscribe to audio/video
} else {
// Need: host/co-host status OR recording token
}Ways to get permission:
Bot is host/co-host
Host grants recording permission
Use
recording_tokenparameter (get via REST API)Use
app_privilege_token(OBF) when joining
GLib Main Loop Required
SDK callbacks execute via GLib event loop:
#include <glib.h>
// Setup main loop
GMainLoop* loop = g_main_loop_new(NULL, FALSE);
// Add timeout for periodic tasks
g_timeout_add_seconds(10, check_meeting_status, NULL);
// Run loop (blocks until quit)
g_main_loop_run(loop);Without GLib loop: Callbacks never fire, join hangs indefinitely.
Heap Memory Mode Recommended
Always use heap mode for raw data to avoid stack overflow with large frames:
init_params.rawdataOpts.videoRawDataMemoryMode = ZoomSDKRawDataMemoryModeHeap;
init_params.rawdataOpts.shareRawDataMemoryMode = ZoomSDKRawDataMemoryModeHeap;
init_params.rawdataOpts.audioRawDataMemoryMode = ZoomSDKRawDataMemoryModeHeap;Thread Safety
SDK callbacks execute on SDK threads:
Don't perform heavy operations in callbacks
Don't call
CleanUPSDK()from within callbacksUse thread-safe queues for data passing
Use mutexes for shared state
Production Architectures
Transcription Bot
See: concepts/high-level-scenarios.md#scenario-1
Join Meeting → StartRawRecording → Subscribe Audio →
Stream to AssemblyAI/Whisper → Generate Real-time TranscriptRecording Bot
See: concepts/high-level-scenarios.md#scenario-2
Join Meeting → StartRawRecording → Subscribe Audio+Video →
Write YUV+PCM → FFmpeg Merge → Upload to StorageAI Meeting Assistant
See: concepts/high-level-scenarios.md#scenario-3
Join Meeting → Real-time Transcription → AI Analysis →
Extract Action Items → Generate SummarySample Applications
Official Repositories:
| Sample | Description | Link |
|---|---|---|
| Raw Recording Sample | Traditional C++ approach with config.txt | GitHub |
| Headless Sample | Modern TOML-based with CLI, Docker Compose | GitHub |
What Each Demonstrates:
Raw Recording Sample: Complete raw data workflow, PulseAudio setup, Docker multi-distro support
Headless Sample: AssemblyAI integration, Anthropic AI, production-ready config management
Documentation Library
Core Concepts
linux.md - Quick start & core workflow
concepts/high-level-scenarios.md - Production bot architectures
meeting-sdk-bot.md - Resilient bot with retry logic
Platform Reference
references/linux-reference.md - Dependencies, CMake, Docker, troubleshooting
Authentication
../references/authorization.md - SDK JWT generation
../references/bot-authentication.md - Bot token types (ZAK, OBF, JWT)
Advanced Features
../references/breakout-rooms.md - Programmatic breakout rooms
../references/ai-companion.md - AI Companion controls
Common Issues
| Issue | Cause | Solution |
|---|---|---|
| No audio in Docker | Missing PulseAudio config | Create ~/.config/zoomus.conf |
| Raw recording denied | No permission | Use host/co-host OR recording token |
| Callbacks not firing | Missing GLib main loop | Add g_main_loop_run() |
| Build errors (XCB) | Missing X11 libraries | Install libxcb packages |
| Segfault on auth | OpenSSL version mismatch | Install libssl1.1 |
Complete troubleshooting: references/linux-reference.md#troubleshooting
Resources
Official Docs: https://developers.zoom.us/docs/meeting-sdk/linux/
API Reference: https://marketplacefront.zoom.us/sdk/meeting/linux/
Dev Forum: https://devforum.zoom.us/
GitHub Samples:
Need help? Start with linux.md for quick start, then explore high-level-scenarios.md for production patterns.
Operations
RUNBOOK.md - 5-minute preflight and debugging checklist.
Files
- ATTRIBUTION.mdAdded by AutoGineer990 B
- LICENSELicence file added by AutoGineer1.1 KiB
- RUNBOOK.md2.3 KiB
- SKILL.md15.2 KiB
- concepts/high-level-scenarios.md14.8 KiB
- linux.md11.0 KiB
- meeting-sdk-bot.md29.8 KiB
- references/linux-reference.md20.7 KiB
meeting-sdk-bot.md
Meeting SDK Bot (Linux)
Build resilient meeting bots that join Zoom meetings as visible participants using the Meeting SDK.
Overview
Meeting SDK bots join as real participants (visible in participant list) and can access raw audio/video data for recording, transcription, or AI processing.
Use this approach when:
You need to be visible in the participant list
You want to interact with meeting features (chat, reactions, etc.)
You need local recording control
You're processing your own meetings or have user consent
Alternative: See rtms/examples/rtms-bot.md for invisible, read-only access via RTMS.
Architecture
┌─────────────────────────────────────────────────────────────────────┐
│ MEETING SDK BOT FLOW │
└─────────────────────────────────────────────────────────────────────┘
┌─────────────────────────────────────────────────────────────────────┐
│ 1. Pre-Join: REST API │
│ └── Get meeting schedule (number, password, start time) │
│ └── Get OBF token for user (bot joins "on behalf of" user) │
└────────────────────────────┬────────────────────────────────────────┘
│
▼
┌─────────────────────────────────────────────────────────────────────┐
│ 2. Join with Retry (OBF requires owner present) │
│ └── Retry with configurable interval until owner joins │
│ └── Circuit breaker: Stop after N attempts │
└────────────────────────────┬────────────────────────────────────────┘
│
▼
┌─────────────────────────────────────────────────────────────────────┐
│ 3. Start Raw Recording (Meeting SDK singleton) │
│ └── IMeetingRecordingController::StartRawRecording() │
│ └── Subscribe to raw audio/video │
└────────────────────────────┬────────────────────────────────────────┘
│
▼
┌─────────────────────────────────────────────────────────────────────┐
│ 4. Process Media Streams │
│ └── Audio: PCM data via IZoomSDKAudioRawDataDelegate │
│ └── Video: YUV420 frames via IZoomSDKVideoRawDataDelegate │
└────────────────────────────┬────────────────────────────────────────┘
│
▼
┌─────────────────────────────────────────────────────────────────────┐
│ 5. Mid-Meeting: Connection Monitoring │
│ └── Detect disconnections → Exponential backoff retry │
│ └── Stop after N reconnection attempts │
└─────────────────────────────────────────────────────────────────────┘Skills Required
| Skill | Purpose |
|---|---|
| zoom-rest-api | Get meeting schedule, retrieve OBF token |
| zoom-meeting-sdk (Linux) | Join meeting, control recording, access raw media |
Choose the Recording Mode
| Goal | Primary path | Skills |
|---|---|---|
| Bot writes its own audio/video files | StartRawRecording() + raw audio/video delegates | zoom-meeting-sdk (Linux) |
| Zoom-hosted MP4/M4A/transcript assets after meeting end | Meeting/account cloud recording settings + recording.completed webhook + recordings download API | zoom-rest-api + zoom-webhooks |
Use raw recording when the bot must process or persist media itself. Use the cloud-recording path when the requirement is post-meeting retrieval of Zoom-managed recording assets.
Automatic Join + Recording Flow
zoom-rest-api
-> get meeting metadata
-> get OBF or ZAK token
Meeting SDK Linux bot
-> join with retry
-> CanStartRawRecording()
-> StartRawRecording()
-> subscribe raw audio/video
-> write PCM/YUV or forward to AI pipeline
Optional post-meeting cloud path
-> zoom-webhooks recording.completed
-> zoom-rest-api recordings downloadPrerequisites
Zoom Meeting SDK v5.15+ (Linux)
Meeting SDK JWT credentials (SDK Key + Secret)
Server-to-Server OAuth app or OAuth app for REST API access
REST API scopes:
meeting:read,user:read, optionallymeeting:writeif triggering meetingsRaw Data entitlement enabled (Admin → Account Settings → Meeting → "Allow access to raw data")
Configuration
Retry Parameters (Customizable)
// config.h or environment variables
struct BotConfig {
// Join retry (waiting for owner to be present)
int join_retry_attempts = 5; // Max join attempts (default: 5)
int join_retry_interval_ms = 60000; // Constant interval: 60s (default: 1min)
// Mid-meeting reconnection (network failures)
int reconnect_max_attempts = 3; // Max reconnection attempts (default: 3)
int reconnect_base_delay_ms = 2000; // Initial delay: 2s (default: 2s)
// Exponential backoff: 2s, 4s, 8s...
// Meeting schedule polling (if webhook unavailable)
int schedule_poll_interval_ms = 30000; // Poll every 30s (default: 30s)
// Timeout settings
int auth_timeout_ms = 10000; // SDK auth timeout (default: 10s)
int join_timeout_ms = 30000; // Single join attempt timeout (default: 30s)
};
// Load from environment variables (recommended for production)
BotConfig loadConfig() {
BotConfig cfg;
// Override defaults from env vars if present
const char* env;
if ((env = getenv("BOT_JOIN_RETRY_ATTEMPTS"))) {
cfg.join_retry_attempts = atoi(env);
}
if ((env = getenv("BOT_JOIN_RETRY_INTERVAL_MS"))) {
cfg.join_retry_interval_ms = atoi(env);
}
if ((env = getenv("BOT_RECONNECT_MAX_ATTEMPTS"))) {
cfg.reconnect_max_attempts = atoi(env);
}
if ((env = getenv("BOT_RECONNECT_BASE_DELAY_MS"))) {
cfg.reconnect_base_delay_ms = atoi(env);
}
return cfg;
}Customization Guide
| Parameter | Default | When to Increase | When to Decrease |
|---|---|---|---|
join_retry_attempts | 5 | High-priority meetings, owner often late | Testing, short-lived meetings |
join_retry_interval_ms | 60000 (1min) | Meetings with long pre-join buffer | Need faster failure detection |
reconnect_max_attempts | 3 | Unstable networks, critical meetings | Batch processing, cost-sensitive |
reconnect_base_delay_ms | 2000 (2s) | Network latency high (international) | Local network, low latency |
Recommended Ranges:
Join retry attempts: 3-10
Join retry interval: 30s-5min
Reconnect attempts: 2-5
Reconnect base delay: 1s-5s
Examples:
# High-priority production bot (aggressive retries)
export BOT_JOIN_RETRY_ATTEMPTS=10
export BOT_JOIN_RETRY_INTERVAL_MS=30000 # 30s
export BOT_RECONNECT_MAX_ATTEMPTS=5
export BOT_RECONNECT_BASE_DELAY_MS=1000 # 1s
# Cost-sensitive batch processing (conservative)
export BOT_JOIN_RETRY_ATTEMPTS=3
export BOT_JOIN_RETRY_INTERVAL_MS=120000 # 2min
export BOT_RECONNECT_MAX_ATTEMPTS=2
export BOT_RECONNECT_BASE_DELAY_MS=5000 # 5s
# Development/testing (fail fast)
export BOT_JOIN_RETRY_ATTEMPTS=2
export BOT_JOIN_RETRY_INTERVAL_MS=10000 # 10s
export BOT_RECONNECT_MAX_ATTEMPTS=1
export BOT_RECONNECT_BASE_DELAY_MS=1000 # 1sStep 1: Get Meeting Info + OBF Token (REST API)
Get Meeting Schedule
# Get meeting details
curl "https://api.zoom.us/v2/meetings/{meetingId}" \
-H "Authorization: Bearer YOUR_ACCESS_TOKEN"Response:
{
"id": 1234567890,
"topic": "Team Standup",
"start_time": "2026-02-09T15:00:00Z",
"password": "abc123",
"pmi": false
}Store: meeting number, password, start time.
Get OBF Token
The bot joins "on behalf of" a Zoom user. Get the user's OBF token:
# Get OBF token for user
curl -X POST "https://api.zoom.us/v2/users/{userId}/token?type=obf&ttl=7200" \
-H "Authorization: Bearer YOUR_ACCESS_TOKEN"Response:
{
"token": "eyJhbGc...",
"expire_in": 7200
}CRITICAL: The bot cannot join until the owner (the user whose OBF token you're using) is present in the meeting. This is why retry logic is essential.
Error if REST API fails: ABORT. No meeting info = cannot proceed.
Step 2: Join Meeting with Retry Logic
Join Implementation
#include <chrono>
#include <thread>
class MeetingBot {
private:
BotConfig config;
IMeetingService* meetingService;
bool joinSuccessful = false;
bool ownerNotPresentError = false;
public:
// Attempt to join with retry logic
bool joinMeetingWithRetry(
uint64_t meetingNumber,
const string& password,
const string& obfToken,
const string& botDisplayName
) {
for (int attempt = 1; attempt <= config.join_retry_attempts; attempt++) {
cout << "[JOIN] Attempt " << attempt << "/"
<< config.join_retry_attempts << endl;
// Attempt join
JoinParam joinParam;
joinParam.userType = SDK_UT_WITHOUT_LOGIN;
JoinParam4WithoutLogin& param = joinParam.param.withoutloginuserJoin;
param.meetingNumber = meetingNumber;
param.userName = botDisplayName.c_str();
param.psw = password.c_str();
param.isVideoOff = true; // Bots typically don't send video
param.isAudioOff = false; // Need audio for transcription
param.app_privilege_token = obfToken.c_str(); // OBF token
SDKError err = meetingService->Join(joinParam);
if (err != SDKERR_SUCCESS) {
cerr << "[JOIN] Join() call failed: " << err << endl;
// Check if it's a retriable error
if (shouldRetryJoin(err)) {
if (attempt < config.join_retry_attempts) {
cout << "[JOIN] Retrying in "
<< (config.join_retry_interval_ms / 1000)
<< "s..." << endl;
this_thread::sleep_for(
chrono::milliseconds(config.join_retry_interval_ms)
);
continue;
}
}
// Non-retriable error or out of attempts
cerr << "[JOIN] Giving up after " << attempt << " attempts" << endl;
return false;
}
// Join() call succeeded, wait for callback
if (waitForJoinCallback()) {
cout << "[JOIN] Successfully joined meeting!" << endl;
return true;
} else {
cerr << "[JOIN] Join callback indicated failure" << endl;
// If owner not present, retry
if (ownerNotPresentError && attempt < config.join_retry_attempts) {
cout << "[JOIN] Owner not present. Retrying in "
<< (config.join_retry_interval_ms / 1000) << "s..." << endl;
this_thread::sleep_for(
chrono::milliseconds(config.join_retry_interval_ms)
);
continue;
}
}
}
cerr << "[JOIN] Failed to join after "
<< config.join_retry_attempts << " attempts" << endl;
return false;
}
private:
bool shouldRetryJoin(SDKError err) {
switch (err) {
case SDKERR_WRONG_USAGE:
case SDKERR_INVALID_PARAMETER:
case SDKERR_MODULE_LOAD_FAILED:
return false; // Configuration errors, don't retry
case SDKERR_NETWORK_ERROR:
case SDKERR_SERVICE_FAILED:
return true; // Network/server issues, retry
default:
return true; // Unknown error, retry to be safe
}
}
bool waitForJoinCallback() {
// Wait for onMeetingStatusChanged callback
// Implementation depends on your callback handling
// Typical: use condition variable with timeout
std::unique_lock<std::mutex> lock(callbackMutex);
bool success = callbackCV.wait_for(
lock,
std::chrono::milliseconds(config.join_timeout_ms),
[this]{ return joinSuccessful || ownerNotPresentError; }
);
return success && joinSuccessful;
}
public:
// Callback from SDK
void onMeetingStatusChanged(MeetingStatus status, int iResult) {
std::lock_guard<std::mutex> lock(callbackMutex);
if (status == MEETING_STATUS_INMEETING) {
joinSuccessful = true;
callbackCV.notify_one();
} else if (status == MEETING_STATUS_FAILED) {
// Check error code for "owner not present"
if (iResult == MEETING_FAIL_OBF_OWNER_NOT_IN_MEETING) {
ownerNotPresentError = true;
}
joinSuccessful = false;
callbackCV.notify_one();
}
}
private:
std::mutex callbackMutex;
std::condition_variable callbackCV;
};Common Join Errors
| Error Code | Meaning | Action |
|---|---|---|
MEETING_FAIL_OBF_OWNER_NOT_IN_MEETING | OBF token owner not in meeting yet | RETRY (owner might join soon) |
MEETING_FAIL_MEETING_NOT_EXIST | Meeting not started | RETRY if before end time |
MEETING_FAIL_INCORRECT_MEETING_NUMBER | Wrong meeting ID | ABORT (config error) |
MEETING_FAIL_MEETING_NOT_START | Meeting hasn't started | RETRY until start time |
MEETING_FAIL_INVALID_TOKEN | OBF token invalid/expired | ABORT (need new token) |
Step 3: Start Raw Recording
Once joined, request permission to access raw audio/video:
void onMeetingStatusChanged(MeetingStatus status, int iResult) {
if (status == MEETING_STATUS_INMEETING) {
cout << "[BOT] Joined successfully, starting raw recording..." << endl;
// Get recording controller
IMeetingRecordingController* recordCtrl =
meetingService->GetMeetingRecordingController();
if (!recordCtrl) {
cerr << "[BOT] Failed to get recording controller" << endl;
return;
}
// Check permission
SDKError canRecord = recordCtrl->CanStartRawRecording();
if (canRecord != SDKERR_SUCCESS) {
cerr << "[BOT] Cannot start raw recording: " << canRecord << endl;
cerr << "[BOT] Check: Raw Data entitlement enabled in Admin settings?" << endl;
return;
}
// Start raw recording (enables raw data flow)
SDKError err = recordCtrl->StartRawRecording();
if (err != SDKERR_SUCCESS) {
cerr << "[BOT] StartRawRecording failed: " << err << endl;
return;
}
cout << "[BOT] Raw recording started, subscribing to media..." << endl;
// Subscribe to audio/video
subscribeToRawMedia();
}
}IMPORTANT: StartRawRecording() does NOT create a file. It enables access to raw audio/video data streams.
Manage Recording Lifecycle Explicitly
The bot should treat raw recording as a capability switch plus media subscriptions:
class RecordingSession {
public:
void start(IMeetingService* meetingService) {
auto* recordCtrl = meetingService->GetMeetingRecordingController();
if (!recordCtrl) {
throw std::runtime_error("recording_controller_unavailable");
}
SDKError canRecord = recordCtrl->CanStartRawRecording();
if (canRecord != SDKERR_SUCCESS) {
throw std::runtime_error("raw_recording_not_permitted");
}
SDKError err = recordCtrl->StartRawRecording();
if (err != SDKERR_SUCCESS) {
throw std::runtime_error("start_raw_recording_failed");
}
audioHelper = GetAudioRawdataHelper();
audioHelper->subscribe(&audioDelegate, true);
createRenderer(&videoRenderer, &videoDelegate);
videoRenderer->setRawDataResolution(ZoomSDKResolution_720P);
videoRenderer->subscribe(activeUserId, RAW_DATA_TYPE_VIDEO);
}
void stop(IMeetingService* meetingService) {
if (audioHelper) {
audioHelper->unSubscribe();
}
if (videoRenderer) {
videoRenderer->unSubscribe();
}
auto* recordCtrl = meetingService->GetMeetingRecordingController();
if (recordCtrl) {
recordCtrl->StopRawRecording();
}
}
private:
IZoomSDKAudioRawDataHelper* audioHelper = nullptr;
IZoomSDKRenderer* videoRenderer = nullptr;
MyAudioDelegate audioDelegate;
MyVideoDelegate videoDelegate;
uint32_t activeUserId = 0;
};Persisting a recording is your job after raw data arrives. Typical outputs are:
PCM audio -> WAV/FLAC encoder or streaming transcription pipeline
YUV420 video -> FFmpeg transcode to MP4 or frame-by-frame CV pipeline
Mixed bot pipeline -> raw capture first, then post-process after leave
Step 4: Subscribe to Raw Audio/Video
void subscribeToRawMedia() {
// Subscribe to raw audio
IZoomSDKAudioRawDataDelegate* audioDelegate = new MyAudioDelegate();
SDKError audioErr = meetingService->GetMeetingAudioController()
->GetMeetingAudioHelper()
->subscribe(audioDelegate, true); // true = mixed audio
if (audioErr != SDKERR_SUCCESS) {
cerr << "[AUDIO] Subscribe failed: " << audioErr << endl;
} else {
cout << "[AUDIO] Subscribed to mixed audio" << endl;
}
// Subscribe to raw video
IZoomSDKVideoRawDataDelegate* videoDelegate = new MyVideoDelegate();
SDKError videoErr = meetingService->GetMeetingVideoController()
->GetMeetingVideoHelper()
->subscribe(videoDelegate);
if (videoErr != SDKERR_SUCCESS) {
cerr << "[VIDEO] Subscribe failed: " << videoErr << endl;
} else {
cout << "[VIDEO] Subscribed to video streams" << endl;
}
}Cloud Recording Alternative
If the requirement is Zoom-managed cloud recording instead of raw media capture, use Meeting SDK only for the joining bot and use API/webhook skills for the recording workflow:
curl -X POST "https://api.zoom.us/v2/users/{userId}/meetings" \
-H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"topic": "Bot Recorded Meeting",
"type": 2,
"start_time": "2026-03-06T18:00:00Z",
"settings": {
"auto_recording": "cloud"
}
}'Then subscribe to recording.completed and download assets through the recordings APIs:
zoom-webhooks-> receiverecording.completedzoom-rest-api->GET /meetings/{meetingId}/recordingsorGET /users/{userId}/recordings
Use this path when the desired output is Zoom-hosted MP4/M4A/transcript files rather than bot-owned raw PCM/YUV.
Step 5: Mid-Meeting Reconnection
Connection Monitoring
class MeetingBot {
private:
BotConfig config;
int reconnectionAttempt = 0;
public:
void onMeetingStatusChanged(MeetingStatus status, int iResult) {
switch (status) {
case MEETING_STATUS_RECONNECTING:
cout << "[BOT] Connection lost, SDK is reconnecting..." << endl;
break;
case MEETING_STATUS_FAILED:
case MEETING_STATUS_DISCONNECTING:
handleDisconnection(iResult);
break;
case MEETING_STATUS_INMEETING:
// Reconnection successful
if (reconnectionAttempt > 0) {
cout << "[BOT] Reconnected successfully!" << endl;
reconnectionAttempt = 0; // Reset counter
}
break;
}
}
private:
void handleDisconnection(int errorCode) {
reconnectionAttempt++;
cout << "[RECONNECT] Disconnected (error: " << errorCode
<< "), attempt " << reconnectionAttempt << "/"
<< config.reconnect_max_attempts << endl;
if (reconnectionAttempt >= config.reconnect_max_attempts) {
cerr << "[RECONNECT] Giving up after "
<< reconnectionAttempt << " attempts" << endl;
cleanup();
notifyFailure("Max reconnection attempts exceeded");
return;
}
// Exponential backoff: 2s, 4s, 8s...
int delay_ms = config.reconnect_base_delay_ms
* (1 << (reconnectionAttempt - 1));
cout << "[RECONNECT] Retrying in " << (delay_ms / 1000) << "s..." << endl;
// Schedule reconnection
std::thread([this, delay_ms]() {
std::this_thread::sleep_for(std::chrono::milliseconds(delay_ms));
attemptRejoin();
}).detach();
}
void attemptRejoin() {
// Re-use same meeting number, password, OBF token
// If OBF token expired, fetch new one from REST API first
if (isOBFTokenExpired()) {
cout << "[RECONNECT] OBF token expired, fetching new one..." << endl;
// TODO: Call REST API to get fresh OBF token
}
// Call join again
bool success = joinMeetingWithRetry(
cachedMeetingNumber,
cachedPassword,
cachedOBFToken,
cachedBotName
);
if (!success) {
cerr << "[RECONNECT] Rejoin failed" << endl;
cleanup();
notifyFailure("Reconnection failed");
}
}
};Customizing Reconnection Behavior
// Example: Linear backoff instead of exponential
int delay_ms = config.reconnect_base_delay_ms * reconnectionAttempt;
// Example: Capped exponential backoff (max 30s)
int delay_ms = std::min(
config.reconnect_base_delay_ms * (1 << (reconnectionAttempt - 1)),
30000 // Cap at 30s
);
// Example: Jittered backoff (avoid thundering herd)
int base_delay = config.reconnect_base_delay_ms * (1 << (reconnectionAttempt - 1));
int jitter = rand() % 1000; // Random 0-1000ms
int delay_ms = base_delay + jitter;Recording Fallback: Local vs Cloud
If raw recording fails, fall back to local or cloud recording:
void startRecordingWithFallback() {
IMeetingRecordingController* ctrl =
meetingService->GetMeetingRecordingController();
// Try raw recording first
if (ctrl->CanStartRawRecording() == SDKERR_SUCCESS) {
SDKError err = ctrl->StartRawRecording();
if (err == SDKERR_SUCCESS) {
cout << "[RECORDING] Using raw recording" << endl;
return;
}
}
// Fallback: Local recording
if (ctrl->CanStartRecording(true) == SDKERR_SUCCESS) {
SDKError err = ctrl->StartRecording(
chrono::system_clock::now(),
"/tmp/bot_recording.mp4"
);
if (err == SDKERR_SUCCESS) {
cout << "[RECORDING] Using local recording" << endl;
return;
}
}
// Fallback: Cloud recording
if (ctrl->CanStartCloudRecording() == SDKERR_SUCCESS) {
SDKError err = ctrl->StartCloudRecording();
if (err == SDKERR_SUCCESS) {
cout << "[RECORDING] Using cloud recording" << endl;
return;
}
}
cerr << "[RECORDING] All recording methods failed" << endl;
}Complete Resilient Bot Example
int main() {
// 1. Load configuration
BotConfig config = loadConfig();
// 2. Initialize Meeting SDK
InitParam initParam;
initParam.strWebDomain = "https://zoom.us";
initParam.emLanguageID = LANGUAGE_English;
initParam.enableLogByDefault = true;
SDKError err = InitSDK(initParam);
if (err != SDKERR_SUCCESS) {
cerr << "InitSDK failed: " << err << endl;
return 1;
}
// 3. Authenticate SDK with JWT
AuthContext authCtx;
authCtx.jwt_token = generateJWT(SDK_KEY, SDK_SECRET);
IAuthService* authService = CreateAuthService();
authService->SDKAuth(authCtx);
// Wait for auth callback...
// 4. Fetch meeting info + OBF token from REST API
MeetingInfo meetingInfo = fetchMeetingInfoFromAPI(MEETING_ID);
string obfToken = fetchOBFTokenFromAPI(USER_ID);
if (meetingInfo.empty() || obfToken.empty()) {
cerr << "ABORT: Failed to get meeting info or OBF token" << endl;
return 1;
}
// 5. Join meeting with retry
MeetingBot bot(config);
bool joined = bot.joinMeetingWithRetry(
meetingInfo.number,
meetingInfo.password,
obfToken,
"Transcription Bot"
);
if (!joined) {
cerr << "ABORT: Failed to join meeting" << endl;
return 1;
}
// 6. SDK callbacks handle: StartRawRecording, subscribe, reconnection
// 7. Keep running until meeting ends
bot.runEventLoop();
// 8. Cleanup
bot.cleanup();
CleanUPSDK();
return 0;
}Comparison: Meeting SDK Bot vs RTMS Bot
| Aspect | Meeting SDK Bot | RTMS Bot |
|---|---|---|
| Visibility | Visible participant | Invisible (read-only service) |
| Authentication | JWT + OBF token | REST API trigger + webhook |
| Join Dependency | Owner must be present | No dependency on participants |
| Retry Logic | Required (owner presence) | Not applicable (webhook-based) |
| Media Access | Raw audio/video/share via SDK | Audio/video/text/share/chat via WebSocket |
| Recording Control | Full (local, cloud, raw) | None (read-only) |
| Interaction | Can send chat, reactions | Cannot interact |
| Resource Usage | Higher (full SDK) | Lower (WebSocket only) |
| Use Case | Interactive bots, recording, moderation | Passive transcription, analytics |
Choose Meeting SDK Bot when:
You need to interact with the meeting (chat, reactions)
You need local recording control
You want to be visible in participant list
You're processing your own meetings
Choose RTMS Bot when:
You only need to observe/transcribe
You want minimal resource usage
You prefer invisible operation
You're processing external meetings
Troubleshooting
Bot Never Joins (OBF Owner Not Present)
Symptom: All join attempts fail with "owner not in meeting"
Solution:
Verify owner (OBF token holder) has joined the meeting
Increase
join_retry_attemptsorjoin_retry_interval_msCheck meeting start time - don't attempt join before meeting starts
Consider webhook: Listen for
meeting.participant_joinedevent for owner
Raw Recording Permission Denied
Symptom: CanStartRawRecording() returns error
Solution:
Admin → Account Settings → Meeting → In Meeting (Advanced)
Enable "Allow access to raw data (audio, video, sharing) for Meeting SDK"
Requires "Raw Data" entitlement from Zoom support
Frequent Disconnections During Meeting
Symptom: Bot reconnects multiple times, then gives up
Solution:
Increase
reconnect_max_attempts(e.g., 5 instead of 3)Increase
reconnect_base_delay_msif network is slowCheck server network stability
Monitor CPU/memory usage (insufficient resources can cause disconnects)
OBF Token Expires During Meeting
Symptom: Reconnection fails with "invalid token"
Solution:
Fetch fresh OBF token in
attemptRejoin()before rejoiningMonitor token expiration (
expire_infrom API response)Request longer-lived tokens (max TTL: 7200s = 2 hours)
Resources
Meeting SDK Linux: https://developers.zoom.us/docs/meeting-sdk/linux/
Raw Data Guide: https://developers.zoom.us/docs/meeting-sdk/linux/add-features/raw-data/
OBF FAQ: https://developers.zoom.us/docs/meeting-sdk/obf-faq/
REST API - Get Meeting: https://developers.zoom.us/docs/api/rest/reference/zoom-api/methods/#operation/meeting
REST API - Get OBF Token: https://developers.zoom.us/docs/api/rest/reference/zoom-api/methods/#operation/userToken
RTMS Bot Alternative: ../../rtms/examples/rtms-bot.md
Requirements and compatibility
Written for: Claude Code, Claude apps
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.
Needs: Claude Code frontmatter
Security
What our scanner noticed· Low risk
- Instructions that use the network
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
- Anthropic (Official)
- Distributed by
- Anthropic
- Source
- anthropics/knowledge-work-plugins · partner-built/zoom-plugin/skills/meeting-sdk/linux · commit e050c2e
- Licence
- MIT License (redistribution allowed)
- LICENSE (added by AutoGineer from partner-built/zoom-plugin/LICENSE)
- ATTRIBUTION.md (written by AutoGineer)
- Synced
AutoGineer is not affiliated with or endorsed by Zoom or Anthropic.
Download ZIP
The ZIP holds the skill’s files, its licence files and an ATTRIBUTION.md. Download meeting-sdk-linux.zip