Zoom Meeting SDK Linux
OpenAIOfficialCreated by ZoomDistributed by OpenAI
- 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 build bots that participate in Zoom meetings. It supports raw audio and video data access, allowing for custom transcription, recording, and AI-powered meeting analysis. The SDK is optimized for server-side automation and requires specific system dependencies, including PulseAudio for audio handling and GLib for event loop management.
What it does
- Enables headless bot participation in Zoom meetings
- Provides access to raw PCM audio and YUV420 video data
- Supports local raw recording and cloud recording control
- Facilitates integration with AI pipelines for real-time transcription and analysis
- Handles meeting events through an asynchronous GLib event loop
When to use it
- When building a bot that must join a meeting as a participant to capture media
- When you need to feed raw audio or video directly into an AI processing pipeline
- When developing automated meeting assistants or quality monitoring tools
- When deploying meeting bots in server environments without a graphical user interface
Advantages
- Optimized for headless server operation
- Direct access to raw media streams for custom processing
- Comprehensive support for meeting lifecycle management
- Compatible with standard Linux distributions like Ubuntu and CentOS
Usage examples
- “How do I start raw recording in my C++ bot?”
- The bot must first call StartRawRecording() from the meeting recording controller, ensuring it has host, co-host, or token-based permissions.
- “What is required to get audio working in a headless environment?”
- You must install pulseaudio and pulseaudio-utils, create a configuration file at ~/.config/zoomus.conf, and start the service with virtual sinks.
Install
Download the skill as a ZIP:
https://mp-staging.autogineer.com/agent-skills/openai/zoom-meeting-sdk-linux/downloadUnzip it into the cross-client skills folder of your project:
mkdir -p .agents/skills && unzip zoom-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, LLM analysis, 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 AutoGineer886 B
- LICENSELicence file added by AutoGineer1.1 KiB
- RUNBOOK.md2.3 KiB
- SKILL.md15.0 KiB
- agents/openai.yaml292 B
- concepts/high-level-scenarios.md14.7 KiB
- linux.md11.0 KiB
- meeting-sdk-bot.md29.4 KiB
- references/linux-reference.md20.6 KiB
references/linux-reference.md
Meeting SDK - Linux Reference
Complete reference for Zoom Meeting SDK on Linux including dependencies, Docker setup, and troubleshooting.
System Requirements
OS: Ubuntu 22+, CentOS 8/9, Oracle Linux 8
Architecture: x86_64
Build Tools: cmake 3.16+, gcc/g++ with C++11 support
Dependencies
Ubuntu 22/23
# Build essentials
apt-get update
apt-get install -y build-essential cmake
# X11/XCB libraries (required by SDK)
apt-get install -y --no-install-recommends --no-install-suggests \
libx11-xcb1 \
libxcb-xfixes0 \
libxcb-shape0 \
libxcb-shm0 \
libxcb-randr0 \
libxcb-image0 \
libxcb-keysyms1 \
libxcb-xtest0
# Optional but recommended
apt-get install -y --no-install-recommends --no-install-suggests \
libdbus-1-3 \
libglib2.0-0 \
libgbm1 \
libxfixes3 \
libgl1 \
libdrm2 \
libgssapi-krb5-2
# For curl-based JWT fetching
apt-get install -y \
libcurl4-openssl-dev \
openssl \
ca-certificates \
pkg-config
# Audio support (PulseAudio)
apt-get install -y \
libasound2 \
libasound2-plugins \
alsa \
alsa-utils \
alsa-oss \
pulseaudio \
pulseaudio-utils
# Optional: FFmpeg for video processing
apt-get install -y libavformat-dev libavfilter-dev libavdevice-dev ffmpeg
# If SDL2 errors occur
apt-get install -y libegl-mesa0 libsdl2-dev g++-multilibCentOS 8/9
# Build essentials
sudo yum install cmake gcc gcc-c++
# Enable required repos (CentOS 9)
sudo dnf config-manager --set-enabled crb
sudo dnf install epel-release epel-next-release
# XCB libraries
sudo yum install \
libxcb-devel \
xcb-util-devel \
xcb-util-image \
xcb-util-keysyms
# OpenGL/Mesa (for runtime)
sudo yum install \
mesa-libGL \
mesa-libGL-devel \
mesa-dri-drivers
# Curl support
sudo yum install -y openssl-devel libcurl-devel
# PulseAudio
sudo yum install -y pulseaudio pulseaudio-utils
# Optional: FFmpeg
sudo yum install -y libavformat-dev libavfilter-dev libavdevice-dev ffmpeg
# If SDL2 errors occur
sudo yum install -y SDL2-develCMakeLists.txt Template
cmake_minimum_required(VERSION 3.16)
project(meetingSDKDemo CXX)
set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -std=c++11 -g -O0")
add_definitions(-std=c++11)
set(CMAKE_BUILD_TYPE Debug)
set(CMAKE_EXPORT_COMPILE_COMMANDS ON)
set(CMAKE_ARCHIVE_OUTPUT_DIRECTORY ${CMAKE_SOURCE_DIR}/lib)
set(CMAKE_LIBRARY_OUTPUT_DIRECTORY ${CMAKE_SOURCE_DIR}/lib)
set(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${CMAKE_SOURCE_DIR}/bin)
find_package(PkgConfig REQUIRED)
find_package(ZLIB REQUIRED)
# GLib (required for main loop)
pkg_check_modules(GLIB REQUIRED glib-2.0)
pkg_check_modules(GIO REQUIRED gio-2.0)
# Include directories
include_directories(${CMAKE_SOURCE_DIR}/include)
include_directories(${CMAKE_SOURCE_DIR}/include/h)
include_directories(${GLIB_INCLUDE_DIRS} ${GIO_INCLUDE_DIRS})
# Common GLib paths
include_directories(/usr/include/glib-2.0/)
include_directories(/usr/include/glib-2.0/glib)
include_directories(/usr/lib/x86_64-linux-gnu/glib-2.0/include/)
include_directories(/usr/lib64/glib-2.0/include/)
# Link directories
link_directories(${GLIB_LIBRARY_DIRS} ${GIO_LIBRARY_DIRS})
link_directories(${CMAKE_SOURCE_DIR}/lib/zoom_meeting_sdk)
link_directories(${CMAKE_SOURCE_DIR}/lib/zoom_meeting_sdk/qt_libs)
link_directories(${CMAKE_SOURCE_DIR}/lib/zoom_meeting_sdk/qt_libs/Qt/lib)
add_definitions(${GLIB_CFLAGS_OTHER} ${GIO_CFLAGS_OTHER})
# Source files
add_executable(meetingSDKDemo
${CMAKE_SOURCE_DIR}/meeting_sdk_demo.cpp
${CMAKE_SOURCE_DIR}/AuthServiceEventListener.cpp
${CMAKE_SOURCE_DIR}/MeetingServiceEventListener.cpp
${CMAKE_SOURCE_DIR}/MeetingReminderEventListener.cpp
${CMAKE_SOURCE_DIR}/MeetingParticipantsCtrlEventListener.cpp
${CMAKE_SOURCE_DIR}/MeetingRecordingCtrlEventListener.cpp
# Raw data handlers (if needed)
${CMAKE_SOURCE_DIR}/ZoomSDKRenderer.cpp
${CMAKE_SOURCE_DIR}/ZoomSDKAudioRawData.cpp
${CMAKE_SOURCE_DIR}/ZoomSDKVideoSource.cpp
${CMAKE_SOURCE_DIR}/ZoomSDKVirtualAudioMicEvent.cpp
)
# Link libraries
target_link_libraries(meetingSDKDemo ${GLIB_LIBRARIES} ${GIO_LIBRARIES})
target_link_libraries(meetingSDKDemo gcc_s gcc)
target_link_libraries(meetingSDKDemo meetingsdk)
target_link_libraries(meetingSDKDemo glib-2.0)
target_link_libraries(meetingSDKDemo curl)
target_link_libraries(meetingSDKDemo pthread)
# Create symlink for SDK
execute_process(COMMAND ln -sf libmeetingsdk.so libmeetingsdk.so.1
WORKING_DIRECTORY ${CMAKE_SOURCE_DIR}/lib/zoom_meeting_sdk
)
# Copy config to bin
configure_file(${CMAKE_SOURCE_DIR}/config.txt ${CMAKE_SOURCE_DIR}/bin/config.txt COPYONLY)
# Copy SDK files to bin
file(COPY ${CMAKE_SOURCE_DIR}/lib/zoom_meeting_sdk/ DESTINATION ${CMAKE_SOURCE_DIR}/bin)Configuration File
config.txt Format
meeting_number: "1234567890"
token: "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
meeting_password: "abc123"
recording_token: ""
onBehalfOf_Token: ""
GetVideoRawData: "true"
GetAudioRawData: "true"
SendVideoRawData: "false"
SendAudioRawData: "false"config.json Format (Alternative)
{
"meeting_number": "1234567890",
"token": "YOUR_JWT_TOKEN",
"meeting_password": "abc123",
"recording_token": "",
"remote_url": "https://your-auth-endpoint.com",
"useJWTTokenFromWebService": "false",
"useRecordingTokenFromWebService": "false"
}Docker Setup
Dockerfile (Ubuntu)
FROM ubuntu:22.04
# Prevent interactive prompts
ENV DEBIAN_FRONTEND=noninteractive
# Install dependencies
RUN apt-get update && apt-get install -y \
build-essential cmake \
libx11-xcb1 libxcb-xfixes0 libxcb-shape0 libxcb-shm0 \
libxcb-randr0 libxcb-image0 libxcb-keysyms1 libxcb-xtest0 \
libdbus-1-3 libglib2.0-0 libgbm1 libxfixes3 libgl1 libdrm2 \
libcurl4-openssl-dev openssl ca-certificates pkg-config \
pulseaudio pulseaudio-utils \
&& rm -rf /var/lib/apt/lists/*
WORKDIR /app
# Copy project files
COPY . .
# Build
RUN cd demo && cmake -B build && cd build && make
# Setup audio config
RUN mkdir -p ~/.config && \
echo "[General]" > ~/.config/zoomus.conf && \
echo "system.audio.type=default" >> ~/.config/zoomus.conf
CMD ["./demo/bin/meetingSDKDemo"]PulseAudio Setup (Headless)
Create setup-pulseaudio.sh:
#!/bin/bash
# Start PulseAudio daemon
pulseaudio --start --exit-idle-time=-1
# Create virtual speaker
pactl load-module module-null-sink sink_name=virtual_speaker sink_properties=device.description="Virtual_Speaker"
# Create virtual microphone
pactl load-module module-null-sink sink_name=virtual_mic sink_properties=device.description="Virtual_Microphone"
# Create zoomus.conf
mkdir -p ~/.config
cat > ~/.config/zoomus.conf << EOF
[General]
system.audio.type=default
EOF
echo "PulseAudio configured for headless operation"Docker Compose
version: '3.8'
services:
meeting-bot:
build: .
environment:
- PULSE_SERVER=unix:/run/user/1000/pulse/native
volumes:
- ./config.txt:/app/demo/bin/config.txt
- /run/user/1000/pulse:/run/user/1000/pulse
network_mode: hostEvent Listeners
AuthServiceEventListener
// AuthServiceEventListener.h
#include "auth_service_interface.h"
class AuthServiceEventListener : public IAuthServiceEvent {
public:
AuthServiceEventListener(void (*onComplete)())
: onAuthComplete(onComplete) {}
void onAuthenticationReturn(AuthResult ret) override {
if (ret == AUTHRET_SUCCESS && onAuthComplete) {
onAuthComplete();
}
}
void onLoginReturnWithReason(LOGINSTATUS ret, IAccountInfo* info, LoginFailReason reason) override {}
void onLogout() override {}
void onZoomIdentityExpired() override {}
void onZoomAuthIdentityExpired() override {}
private:
void (*onAuthComplete)();
};MeetingServiceEventListener
// MeetingServiceEventListener.h
#include "meeting_service_interface.h"
class MeetingServiceEventListener : public IMeetingServiceEvent {
public:
MeetingServiceEventListener(
void (*onJoined)(),
void (*onEnded)(),
void (*onInMeeting)()
) : onMeetingJoined(onJoined),
onMeetingEnded(onEnded),
onInMeetingCallback(onInMeeting) {}
void onMeetingStatusChanged(MeetingStatus status, int iResult) override {
if (status == MEETING_STATUS_CONNECTING) {
if (onMeetingJoined) onMeetingJoined();
}
else if (status == MEETING_STATUS_INMEETING) {
if (onInMeetingCallback) onInMeetingCallback();
}
else if (status == MEETING_STATUS_ENDED) {
if (onMeetingEnded) onMeetingEnded();
}
}
void onMeetingStatisticsWarningNotification(StatisticsWarningType type) override {}
void onMeetingParameterNotification(const MeetingParameter* param) override {}
void onSuspendParticipantsActivities() override {}
void onAICompanionActiveChangeNotice(bool isActive) override {}
private:
void (*onMeetingJoined)();
void (*onMeetingEnded)();
void (*onInMeetingCallback)();
};MeetingParticipantsCtrlEventListener
// MeetingParticipantsCtrlEventListener.h
#include "meeting_service_components/meeting_participants_ctrl_interface.h"
class MeetingParticipantsCtrlEventListener : public IMeetingParticipantsCtrlEvent {
public:
MeetingParticipantsCtrlEventListener(
void (*onHost)(),
void (*onCoHost)()
) : onIsHost(onHost), onIsCoHost(onCoHost) {}
void onUserJoin(IList<unsigned int>* lstUserID, const zchar_t* strUserList) override {}
void onUserLeft(IList<unsigned int>* lstUserID, const zchar_t* strUserList) override {}
void onHostChangeNotification(unsigned int userId) override {
if (onIsHost) onIsHost();
}
void onCoHostChangeNotification(unsigned int userId, bool isCoHost) override {
if (isCoHost && onIsCoHost) onIsCoHost();
}
void onLowOrRaiseHandStatusChanged(bool bLow, unsigned int userid) override {}
private:
void (*onIsHost)();
void (*onIsCoHost)();
};Raw Data Requirements
Recording Permission
Raw data access requires one of:
Host status
Co-host status
Recording permission from host
Recording token (app_privilege_token)
// Check and start raw recording
void CheckAndStartRawRecording() {
IMeetingRecordingController* recordCtrl =
m_pMeetingService->GetMeetingRecordingController();
SDKError canStart = recordCtrl->CanStartRawRecording();
if (canStart == SDKERR_SUCCESS) {
recordCtrl->StartRawRecording();
// Now subscribe to raw data
} else {
std::cout << "Need host/cohost/recording permission" << std::endl;
}
}Video Resolutions
videoHelper->setRawDataResolution(ZoomSDKResolution_90P);
videoHelper->setRawDataResolution(ZoomSDKResolution_180P);
videoHelper->setRawDataResolution(ZoomSDKResolution_360P);
videoHelper->setRawDataResolution(ZoomSDKResolution_720P);
videoHelper->setRawDataResolution(ZoomSDKResolution_1080P);Audio Format
Format: PCM (raw)
Sample Rate: 32000 Hz
Channels: Mono or Stereo
Bit Depth: 16-bit
Compilation Tips
Note: Specific methods/types may vary by SDK version. Always check SDK headers.
Event Listener Interfaces
SDK event listener interfaces have many pure virtual methods. Implement ALL of them (even with empty bodies) or you'll get "invalid new-expression of abstract class type" errors. Check the SDK header for the complete interface definition.
Include Order Issues
Some SDK headers don't include their dependencies. If you get undefined type errors:
Add standard includes (
<ctime>,<cstdint>) before SDK headersInclude related SDK headers in dependency order (e.g.,
meeting_audio_interface.hbeforemeeting_participants_ctrl_interface.h)
Method Signatures
Reference samples may have outdated method names. The SDK header files are the authoritative source - always verify method signatures there.
Troubleshooting
Segmentation Fault on AuthSDK
Cause: OpenSSL version incompatibility (needs 1.1.x)
Fix (Ubuntu):
cd /tmp
wget http://security.ubuntu.com/ubuntu/pool/main/o/openssl/libssl1.1_1.1.1f-1ubuntu2.20_amd64.deb
sudo dpkg -i libssl1.1_1.1.1f-1ubuntu2.20_amd64.deblibGL Error (Mesa)
libGL error: MESA-LOADER: failed to open swrastFix:
# Ubuntu
apt-get install mesa-libGL mesa-dri-drivers
# CentOS
yum install mesa-libGL mesa-libGL-devel mesa-dri-driversXCB Libraries Missing
libxcb-image.so.0 not found
libxcb-keysyms.so.1 not foundFix:
# Ubuntu
apt-get install libxcb-image0 libxcb-keysyms1
# CentOS
yum install xcb-util-image xcb-util-keysymsNo Audio in Docker
Fix: Create zoomus.conf before running:
mkdir -p ~/.config
echo -e "[General]\nsystem.audio.type=default" > ~/.config/zoomus.confCannot Start Raw Recording
Cause: No recording permission
Fix: Either:
Wait for host to grant recording permission
Use
recording_tokenin config (get from Recording Token API)Join as host using
onBehalfOf_Token
Cleanup
void CleanSDK() {
if (videoHelper) videoHelper->unSubscribe();
if (audioHelper) audioHelper->unSubscribe();
if (m_pAuthService) {
DestroyAuthService(m_pAuthService);
m_pAuthService = NULL;
}
if (m_pSettingService) {
DestroySettingService(m_pSettingService);
m_pSettingService = NULL;
}
if (m_pMeetingService) {
DestroyMeetingService(m_pMeetingService);
m_pMeetingService = NULL;
}
CleanUPSDK();
}API Reference
InitParam Structure
struct tagInitParam {
const zchar_t* strWebDomain; // "https://zoom.us"
const zchar_t* strBrandingName; // Custom branding name
const zchar_t* strSupportUrl; // Support URL
SDK_LANGUAGE_ID emLanguageID; // LANGUAGE_English, etc.
bool enableGenerateDump; // Enable crash dump
bool enableLogByDefault; // Enable logging
unsigned int uiLogFileSize; // Log file size (MB, default: 5)
RawDataOptions rawdataOpts; // Raw data options
ConfigurableOptions obConfigOpts; // Config options
int wrapperType; // SDK wrapper type
};IAuthService Methods
| Method | Description | Returns |
|---|---|---|
SetEvent(IAuthServiceEvent*) | Set auth callback | SDKError |
SDKAuth(AuthContext&) | Authenticate with JWT | SDKError |
GetAuthResult() | Get auth status | AuthResult |
GetSDKIdentity() | Get SDK identity | const zchar_t* |
LogOut() | Logout | SDKError |
GetAccountInfo() | Get account info | IAccountInfo* |
GetLoginStatus() | Get login status | LOGINSTATUS |
IMeetingService Methods
| Method | Description | Returns |
|---|---|---|
SetEvent(IMeetingServiceEvent*) | Set meeting callback | SDKError |
Join(JoinParam&) | Join meeting | SDKError |
Start(StartParam&) | Start meeting | SDKError |
Leave(LeaveMeetingCmd) | Leave meeting | SDKError |
GetMeetingStatus() | Get status | MeetingStatus |
GetMeetingInfo() | Get meeting info | IMeetingInfo* |
GetMeetingVideoController() | Video control | IMeetingVideoController* |
GetMeetingAudioController() | Audio control | IMeetingAudioController* |
GetMeetingRecordingController() | Recording control | IMeetingRecordingController* |
GetMeetingParticipantsController() | Participants | IMeetingParticipantsController* |
GetMeetingChatController() | Chat control | IMeetingChatController* |
JoinParam4WithoutLogin Structure
struct JoinParam4WithoutLogin {
UINT64 meetingNumber; // Meeting number
const zchar_t* userName; // Display name
const zchar_t* psw; // Meeting password
const zchar_t* vanityID; // Personal link name
const zchar_t* customer_key; // Customer key
const zchar_t* webinarToken; // Webinar token
const zchar_t* userZAK; // Zoom Access Key
const zchar_t* app_privilege_token; // App privilege token (for raw data)
const zchar_t* onBehalfToken; // On behalf token
bool isVideoOff; // Start with video off
bool isAudioOff; // Start with audio off
};IZoomSDKRenderer Methods
| Method | Description | Returns |
|---|---|---|
setRawDataResolution(ZoomSDKResolution) | Set resolution | SDKError |
subscribe(uint32_t userId, ZoomSDKRawDataType) | Subscribe to video | SDKError |
unSubscribe() | Unsubscribe | SDKError |
getResolution() | Get resolution | ZoomSDKResolution |
getSubscribeId() | Get user ID | uint32_t |
ZoomSDKResolution values: ZoomSDKResolution_90P, _180P, _360P, _720P, _1080P
YUVRawDataI420 Methods
| Method | Description | Returns |
|---|---|---|
GetStreamWidth() | Video width | uint32_t |
GetStreamHeight() | Video height | uint32_t |
GetYBuffer() | Y plane buffer | char* |
GetUBuffer() | U plane buffer | char* |
GetVBuffer() | V plane buffer | char* |
GetBufferLen() | Total buffer length | uint32_t |
GetRotation() | Rotation angle | int |
GetAlphaBuffer() | Alpha channel | char* |
Video Format:
YUV420 (I420) contiguous planar format (no strides)
Y plane:
width * heightbytesU plane:
(width/2) * (height/2)bytesV plane:
(width/2) * (height/2)bytesTotal size:
width * height * 1.5bytes
AudioRawData Methods
| Method | Description | Returns |
|---|---|---|
GetBuffer() | Audio buffer | char* |
GetBufferLen() | Buffer length (bytes) | uint32_t |
GetSampleRate() | Sample rate (Hz) | uint32_t |
GetChannelNum() | Number of channels | uint32_t |
Audio Format:
PCM (uncompressed), 16-bit, little-endian
Sample rate: 32000 Hz (typical)
Channels: 1 (mono) or 2 (stereo)
Playing Raw Files with FFmpeg
Raw files have no headers - specify format explicitly:
# Play YUV video (adjust dimensions to match your output)
ffplay -video_size 640x360 -pixel_format yuv420p -f rawvideo video.yuv
# Convert YUV to MP4
ffmpeg -video_size 640x360 -pixel_format yuv420p -f rawvideo -i video.yuv -c:v libx264 output.mp4
# Play PCM audio
ffplay -f s16le -ar 32000 -ac 1 audio.pcm
# Convert PCM to WAV
ffmpeg -f s16le -ar 32000 -ac 1 -i audio.pcm output.wav
# Combine video + audio into MP4
ffmpeg -video_size 640x360 -pixel_format yuv420p -f rawvideo -i video.yuv \
-f s16le -ar 32000 -ac 1 -i audio.pcm \
-c:v libx264 -c:a aac -shortest output.mp4Error Codes (SDKError)
| Code | Description |
|---|---|
SDKERR_SUCCESS | Success |
SDKERR_INVALID_PARAMETER | Invalid parameter |
SDKERR_UNINITIALIZE | SDK not initialized |
SDKERR_UNAUTHENTICATION | Not authenticated |
SDKERR_NO_PERMISSION | No permission |
SDKERR_NO_AUDIODEVICE_ISFOUND | No audio device |
SDKERR_NO_VIDEODEVICE_ISFOUND | No video device |
SDKERR_INTERNAL_ERROR | Internal error |
SDKERR_SERVICE_FAILED | Service failed |
SDKERR_MEMORY_FAILED | Memory allocation failed |
SDKERR_TOO_FREQUENT_CALL | API called too frequently |
Authentication Results (AuthResult)
| Result | Description |
|---|---|
AUTHRET_SUCCESS | Authentication successful |
AUTHRET_KEYORSECRETEMPTY | Key or secret empty |
AUTHRET_JWTTOKENWRONG | JWT token invalid |
AUTHRET_OVERTIME | Operation timed out |
Meeting Status (MeetingStatus)
| Status | Description |
|---|---|
MEETING_STATUS_IDLE | No meeting |
MEETING_STATUS_CONNECTING | Connecting |
MEETING_STATUS_INMEETING | In meeting |
MEETING_STATUS_RECONNECTING | Reconnecting |
MEETING_STATUS_FAILED | Failed |
MEETING_STATUS_ENDED | Meeting ended |
MEETING_STATUS_WAITINGFORHOST | Waiting for host |
Authentication Requirements (2026 Update)
Important: Beginning March 2, 2026, apps joining meetings outside their account must be authorized.
Options:
App Privilege Token (OBF) - Recommended for bots
ZAK Token - Zoom Access Key
On Behalf Token - For specific use cases
Resources
Official docs: https://developers.zoom.us/docs/meeting-sdk/linux/
API Reference: https://marketplacefront.zoom.us/sdk/meeting/linux/index.html
Headless sample: https://github.com/zoom/meetingsdk-headless-linux-sample
Raw recording sample: https://github.com/zoom/meetingsdk-linux-raw-recording-sample
Auth endpoint: https://github.com/zoom/meetingsdk-auth-endpoint-sample
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
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
- OpenAI (Official)
- Distributed by
- OpenAI
- Source
- openai/plugins · plugins/zoom/skills/meeting-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-meeting-sdk-linux.zip