Zoom Video SDK Web
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 Web provides a robust JavaScript/TypeScript library for building custom, browser-based video communication experiences. Unlike standard Zoom meetings, this SDK allows developers to create fully branded, custom user interfaces for video sessions, screen sharing, live transcription, and collaborative features like whiteboarding. It follows a strict event-driven architecture and requires careful management of the session lifecycle, particularly regarding media stream initialization and participant event handling.
What it does
- Enables real-time audio and video communication in web browsers.
- Supports screen sharing and collaborative whiteboarding.
- Provides tools for cloud recording and live streaming to RTMP endpoints.
- Includes features for in-session chat and custom command messaging.
- Facilitates live transcription and breakout room management.
- Offers granular control over media devices and video quality settings.
When to use it
- When building a custom-branded video conferencing application.
- When you need full control over the video UI and participant layout.
- When integrating real-time communication into existing web platforms.
- When requiring advanced features like custom video frame processing or live captions.
Advantages
- Full control over the user interface and user experience.
- Supports high-definition video and WebRTC for direct peer-to-peer streaming.
- Comprehensive feature set including chat, recording, and transcription.
- Well-documented lifecycle patterns for reliable session management.
Usage examples
- “How do I join a video session using the Zoom Video SDK?”
- The user receives the 5-step lifecycle pattern: create client, initialize, join, get media stream, and start media, with specific warnings to only call getMediaStream() after joining.
- “How can I display a remote participant's video?”
- The user is guided to use the peer-video-state-change event to trigger attachVideo() and append the resulting video element to the DOM.
Install
Download the skill as a ZIP:
https://autogineer.com/agent-skills/openai/zoom-video-sdk-web/downloadUnzip it into the cross-client skills folder of your project:
mkdir -p .agents/skills && unzip zoom-video-sdk-web.zip -d .agents/skills
Documentation by Zoom
Zoom Video SDK - Web Development
Expert guidance for developing with the Zoom Video SDK on Web. This SDK enables custom video applications in the browser with real-time video/audio, screen sharing, cloud recording, live streaming, chat, and live transcription.
This skill is for custom video sessions, not embedded Zoom meetings. If the user wants a custom UI for a real Zoom meeting, route to ../../meeting-sdk/web/component-view/SKILL.md.
Official Documentation: https://developers.zoom.us/docs/video-sdk/web/ API Reference: https://marketplacefront.zoom.us/sdk/custom/web/modules.html Sample Repository: https://github.com/zoom/videosdk-web-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
Video Rendering - Display video with attachVideo()
Event Handling - Required events for video/audio
Reference:
Singleton Hierarchy - 4-level SDK navigation map
API Reference - Methods, events, error codes
SKILL.md - Complete documentation navigation
../../probe-sdk/SKILL.md - Optional browser/device/network readiness diagnostics before join
Having issues?
Video not showing → Video Rendering (use attachVideo, not renderVideo)
getMediaStream() returns undefined → Call AFTER join() completes
Quick diagnostics → Common Issues
SDK Overview
The Zoom Video SDK for Web is a JavaScript library that provides:
Session Management: Join/leave video SDK sessions
Video/Audio: Start/stop camera and microphone
Screen Sharing: Share screens or browser tabs
Cloud Recording: Record sessions to Zoom cloud
Live Streaming: Stream to RTMP endpoints
Chat: In-session messaging
Command Channel: Custom command messaging
Live Transcription: Real-time speech-to-text
Subsessions: Breakout room support
Whiteboard: Collaborative whiteboard features
Virtual Background: Blur or custom image backgrounds
Prerequisites
System Requirements
Modern Browser: Chrome 80+, Firefox 75+, Safari 14+, Edge 80+
Video SDK Credentials: SDK Key and Secret from Marketplace
JWT Token: Server-side generated signature
Browser Feature Requirements
// Check browser compatibility before init
const compatibility = ZoomVideo.checkSystemRequirements();
console.log('Audio:', compatibility.audio);
console.log('Video:', compatibility.video);
console.log('Screen:', compatibility.screen);
// Check feature support
const features = ZoomVideo.checkFeatureRequirements();
console.log('Supported:', features.supportFeatures);
console.log('Unsupported:', features.unSupportFeatures);Optional Pre-Join Diagnostics (Recommended for Reliability)
Use Probe SDK as a readiness gate before client.join(...) when you need to reduce failed starts:
Run diagnostics with ../../probe-sdk/SKILL.md.
Evaluate policy (
allow,warn,block).Start Video SDK join only when policy allows.
Cross-skill flow: ../../general/use-cases/probe-sdk-preflight-readiness-gate.md
Installation
NPM (Recommended)
npm install @zoom/videosdkimport ZoomVideo from '@zoom/videosdk';CDN (Fallback Strategy Recommended)
Note: Some networks/ad blockers can block
source.zoom.us. If you see flaky loads, first try allowlisting the domain in your environment. If needed, consider a fallback (mirror/self-host) only if it's permitted for your use case and you can keep versions in sync.
# Download SDK locally
curl "https://source.zoom.us/videosdk/zoom-video-2.3.12.min.js" -o public/js/zoom-video-sdk.min.js<!-- Use local copy instead of CDN -->
<script src="js/zoom-video-sdk.min.js"></script>// CDN exports as WebVideoSDK, NOT ZoomVideo
const ZoomVideo = WebVideoSDK.default;Quick Start
import ZoomVideo from '@zoom/videosdk';
// 1. Create client (singleton - returns same instance)
const client = ZoomVideo.createClient();
// 2. Initialize SDK
await client.init('en-US', 'Global', { patchJsMedia: true });
// 3. Join session
await client.join(topic, signature, userName, password);
// 4. CRITICAL: Get stream AFTER join
const stream = client.getMediaStream();
// 5. Start media
await stream.startVideo();
await stream.startAudio();
// 6. Attach video to DOM
const videoElement = await stream.attachVideo(userId, VideoQuality.Video_360P);
document.getElementById('video-container').appendChild(videoElement);SDK Lifecycle (CRITICAL ORDER)
The SDK has a strict lifecycle. Violating it causes silent failures.
1. Create client: client = ZoomVideo.createClient()
2. Initialize: await client.init('en-US', 'Global', options)
3. Join session: await client.join(topic, signature, userName, password)
4. Get stream: stream = client.getMediaStream() ← ONLY AFTER JOIN
5. Start media: await stream.startVideo() / await stream.startAudio()Common Mistake:
// WRONG: Getting stream before joining
const stream = client.getMediaStream(); // Returns undefined!
await client.join(...);
// CORRECT: Get stream after joining
await client.join(...);
const stream = client.getMediaStream(); // Works!Critical Gotchas and Best Practices
getMediaStream() ONLY Works After join()
The #1 issue that causes video/audio to fail:
// WRONG
const stream = client.getMediaStream(); // undefined!
await client.join(...);
// CORRECT
await client.join(...);
const stream = client.getMediaStream(); // WorksUse attachVideo() NOT renderVideo()
renderVideo() is deprecated. Use attachVideo() which returns a VideoPlayer element:
import { VideoQuality } from '@zoom/videosdk';
// CORRECT: attachVideo returns element to append
const videoElement = await stream.attachVideo(userId, VideoQuality.Video_360P);
document.getElementById('video-container').appendChild(videoElement);
// WRONG: renderVideo is deprecated
await stream.renderVideo(canvas, userId, ...); // Don't use!Video Rendering is Event-Driven (CRITICAL)
You MUST listen for events to properly render participant videos:
// When another participant's video state changes
client.on('peer-video-state-change', async (payload) => {
const { action, userId } = payload;
if (action === 'Start') {
// Participant turned on video - attach it
const element = await stream.attachVideo(userId, VideoQuality.Video_360P);
container.appendChild(element);
} else if (action === 'Stop') {
// Participant turned off video - detach it
await stream.detachVideo(userId);
}
});
// When participants join/leave
client.on('user-added', (payload) => {
// New participant joined - check if their video is on
const users = client.getAllUser();
// Render videos for users with bVideoOn === true
});
client.on('user-removed', (payload) => {
// Participant left - clean up their video element
stream.detachVideo(payload[0].userId);
});Peer Video on Mid-Session Join
Existing participants' videos won't auto-render when you join mid-session.
// After joining, render existing participants' videos
const renderExistingVideos = async () => {
await new Promise(resolve => setTimeout(resolve, 500));
const users = client.getAllUser();
const currentUserId = client.getCurrentUserInfo().userId;
for (const user of users) {
if (user.bVideoOn && user.userId !== currentUserId) {
const element = await stream.attachVideo(user.userId, VideoQuality.Video_360P);
document.getElementById(`video-${user.userId}`).appendChild(element);
}
}
};CDN Race Condition with ES Modules
When using <script type="module"> with CDN, the SDK may not be loaded yet:
function waitForSDK(timeout = 10000) {
return new Promise((resolve, reject) => {
if (typeof WebVideoSDK !== 'undefined') {
resolve();
return;
}
const start = Date.now();
const check = setInterval(() => {
if (typeof WebVideoSDK !== 'undefined') {
clearInterval(check);
resolve();
} else if (Date.now() - start > timeout) {
clearInterval(check);
reject(new Error('SDK failed to load'));
}
}, 100);
});
}
await waitForSDK();
const ZoomVideo = WebVideoSDK.default;SharedArrayBuffer for HD Video
For optimal performance and HD video, configure these headers on your server:
Cross-Origin-Opener-Policy: same-origin
Cross-Origin-Embedder-Policy: require-corpNote: As of v1.11.2, SharedArrayBuffer is elective (not strictly required).
Check HD Capability Before Enabling
const stream = client.getMediaStream();
// Check if 720p is supported
const hdSupported = stream.isSupportHDVideo();
// Get maximum video quality
const maxQuality = stream.getVideoMaxQuality();
// 0=90P, 1=180P, 2=360P, 3=720P, 4=1080P
// Start video with HD
if (hdSupported) {
await stream.startVideo({ hd: true });
}Screen Share Rendering Mode Check
const stream = client.getMediaStream();
// Check which element type to use
if (stream.isStartShareScreenWithVideoElement()) {
// Use video element
const video = document.getElementById('share-video');
await stream.startShareScreen(video as unknown as HTMLCanvasElement);
} else {
// Use canvas element
const canvas = document.getElementById('share-canvas');
await stream.startShareScreen(canvas);
}Key Features
Video Quality Enum
import { VideoQuality } from '@zoom/videosdk';
VideoQuality.Video_90P // 0
VideoQuality.Video_180P // 1
VideoQuality.Video_360P // 2 (recommended for most cases)
VideoQuality.Video_720P // 3
VideoQuality.Video_1080P // 4Virtual Backgrounds
const stream = client.getMediaStream();
// Always check support first
if (stream.isSupportVirtualBackground()) {
// Blur background
await stream.updateVirtualBackgroundImage('blur');
// Custom image background
await stream.updateVirtualBackgroundImage('https://example.com/bg.jpg');
// Remove virtual background
await stream.updateVirtualBackgroundImage(undefined);
}Video Processor (Custom Effects)
The VideoProcessor class allows you to intercept and modify video frames:
// video-processor-worker.js
class MyVideoProcessor extends VideoProcessor {
processFrame(input, output) {
const ctx = output.getContext('2d');
ctx.drawImage(input, 0, 0);
// Add overlay
ctx.fillStyle = 'white';
ctx.font = '24px Arial';
ctx.fillText('Live', 20, 40);
return true;
}
}WebRTC Mode
Enable WebRTC mode for direct peer-to-peer streaming with HD video support:
await client.init('en-US', 'Global', {
patchJsMedia: true,
webrtc: true // Enable WebRTC mode
});Feature Clients
Access specialized clients from the VideoClient:
| Client | Access Method | Purpose |
|---|---|---|
| Stream | client.getMediaStream() | Video, audio, screen share, devices |
| Chat | client.getChatClient() | Send/receive messages |
| Command | client.getCommandClient() | Custom commands (reactions, etc.) |
| Recording | client.getRecordingClient() | Cloud recording control |
| Transcription | client.getLiveTranscriptionClient() | Live captions |
| LiveStream | client.getLiveStreamClient() | RTMP streaming |
| Subsession | client.getSubsessionClient() | Breakout rooms |
| Whiteboard | client.getWhiteboardClient() | Collaborative whiteboard |
Common Tasks
Start/Stop Video
await stream.startVideo();
await stream.stopVideo();Start/Stop Audio
await stream.startAudio();
await stream.muteAudio();
await stream.unmuteAudio();
await stream.stopAudio();Switch Devices
// Get available devices
const cameras = stream.getCameraList();
const mics = stream.getMicList();
const speakers = stream.getSpeakerList();
// Switch devices
await stream.switchCamera(cameraId);
await stream.switchMicrophone(micId);
await stream.switchSpeaker(speakerId);Screen Sharing
// Start sharing
await stream.startShareScreen(canvas);
// Stop sharing
await stream.stopShareScreen();
// Receive share
client.on('active-share-change', async (payload) => {
if (payload.state === 'Active') {
await stream.startShareView(canvas, payload.userId);
} else {
await stream.stopShareView();
}
});Chat
const chatClient = client.getChatClient();
// Send to everyone
await chatClient.send('Hello, everyone!');
// Send to specific user
await chatClient.sendToUser(userId, 'Private message');
// Receive messages
client.on('chat-on-message', (payload) => {
console.log(`${payload.sender.name}: ${payload.message}`);
});Recording (Host Only)
const recordingClient = client.getRecordingClient();
await recordingClient.startCloudRecording();
await recordingClient.stopCloudRecording();
client.on('recording-change', (payload) => {
console.log('Recording status:', payload.state);
});Leave/End Session
// Leave session (others stay)
await client.leave();
// End session for ALL participants (host only)
await client.leave(true);Error Handling
Common Join Errors
| Error | Cause | Solution |
|---|---|---|
Invalid signature | JWT expired or malformed | Generate new signature |
Session does not exist | Host hasn't started yet | Show "waiting" message, retry |
Permission denied | User denied camera/mic | Request permission again |
Example Error Handler
try {
await client.join(topic, signature, userName, password);
} catch (error) {
if (error.reason?.includes('signature')) {
// Regenerate signature and retry
} else if (error.reason?.includes('Session')) {
// Show "Waiting for host..." and poll
} else if (error.reason?.includes('Permission')) {
// Guide user to enable permissions
}
console.error('Join failed:', error);
}Browser Compatibility
| Feature | Chrome | Firefox | Safari | Edge |
|---|---|---|---|---|
| Video | 80+ | 75+ | 14+ | 80+ |
| Audio | 80+ | 75+ | 14+ | 80+ |
| Screen Share | 80+ | 75+ | 15+ | 80+ |
| Virtual BG | 80+ | 90+ | - | 80+ |
Safari Notes:
Virtual background not supported
Screen sharing requires macOS 15+
CORS Errors (Telemetry)
CORS errors to log-external-gateway.zoom.us are harmless.
These are caused by COOP/COEP headers blocking telemetry requests. They don't affect SDK functionality.
Complete Documentation Library
Core Concepts
SDK Architecture Pattern - Universal 3-step pattern for ANY feature
Singleton Hierarchy - 4-level navigation guide
Complete Examples
Session Join Pattern - JWT auth + session join with full code
Video Rendering - attachVideo() patterns
Screen Share - Send and receive screen shares
Event Handling - Required events
Chat - In-session messaging
Recording - Cloud recording control
Transcription - Live captions
Framework Integrations
React Hooks - Official @zoom/videosdk-react library
Framework Integrations - Next.js, Vue/Nuxt patterns
Troubleshooting
Common Issues - Quick diagnostics & error codes
References
API Reference - Complete method signatures
Events Reference - All event types
SKILL.md - Complete navigation guide
Official Sample Repositories
| Type | Repository |
|---|---|
| Web Sample | videosdk-web-sample |
| React SDK | videosdk-react |
| Next.js | videosdk-nextjs-quickstart |
| Vue/Nuxt | videosdk-vue-nuxt-quickstart |
| Auth Endpoint | videosdk-auth-endpoint-sample |
| UI Toolkit | videosdk-zoom-ui-toolkit-react-sample |
Resources
Official Docs: https://developers.zoom.us/docs/video-sdk/web/
API Reference: https://marketplacefront.zoom.us/sdk/custom/web/modules.html
Dev Forum: https://devforum.zoom.us/
GitHub Samples: https://github.com/zoom/videosdk-web-sample
Need help? Start with SKILL.md for complete navigation.
Merged from video-sdk/web/SKILL.md
Zoom Video SDK Web - Complete Documentation Index
Quick Start Path
If you're new to the SDK, follow this order:
Read the architecture pattern → concepts/sdk-architecture-pattern.md
Universal formula: Create Client → Init → Join → Get Stream → Use
Once you understand this, you can implement any feature
Implement session join → examples/session-join-pattern.md
Complete working JWT + session join code
Listen to events → examples/event-handling.md
CRITICAL: The SDK is event-driven, you must listen for events
Implement video → examples/video-rendering.md
Use attachVideo(), NOT renderVideo()
Troubleshoot any issues → troubleshooting/common-issues.md
Quick diagnostic checklist
Error code tables
Documentation Structure
video-sdk/web/
├── SKILL.md # Main skill overview
├── SKILL.md # This file - navigation guide
│
├── concepts/ # Core architectural patterns
│ ├── sdk-architecture-pattern.md # Universal formula for ANY feature
│ └── singleton-hierarchy.md # 4-level navigation guide
│
├── examples/ # Complete working code
│ ├── session-join-pattern.md # JWT auth + session join
│ ├── video-rendering.md # attachVideo() patterns
│ ├── screen-share.md # Send and receive screen shares
│ ├── event-handling.md # Required events
│ ├── chat.md # Chat implementation
│ ├── command-channel.md # Command channel messaging
│ ├── recording.md # Cloud recording control
│ ├── transcription.md # Live transcription/captions
│ ├── react-hooks.md # Official @zoom/videosdk-react library
│ └── framework-integrations.md # Next.js, Vue/Nuxt, ZFG patterns
│
├── troubleshooting/ # Problem solving guides
│ └── common-issues.md # Quick diagnostic workflow
│
└── references/ # Reference documentation
├── web-reference.md # API hierarchy, methods, error codes
└── events-reference.md # All event typesBy Use Case
I want to build a video app
SDK Architecture Pattern - Understand the pattern
Session Join Pattern - Join sessions
Video Rendering - Display video
Event Handling - Listen for video events
I'm getting runtime errors
Common Issues - Error code tables
"getMediaStream() is undefined" → Call AFTER join() completes
I want to receive screen shares
Screen Share - startShareView() patterns
Event Handling - active-share-change event
I want to send screen shares
Screen Share - startShareScreen() patterns
Check isStartShareScreenWithVideoElement() for element type
I want to use chat
Chat - Send/receive messages
getChatClient() for ChatClient access
I want to record sessions
Recording - Cloud recording (host only)
getRecordingClient() for RecordingClient access
I want to use live transcription
Transcription - Enable live captions
getLiveTranscriptionClient() for LiveTranscriptionClient access
I want to use command channel
Command Channel - Custom signaling between participants
Must call getCommandClient() AFTER join()
I want to implement a specific feature
SDK Architecture Pattern - START HERE!
Singleton Hierarchy - Navigate to the feature
API Reference - Method signatures
I'm using React
React Hooks - Official @zoom/videosdk-react library
Provides hooks: useSession, useSessionUsers, useVideoState, useAudioState
Pre-built components: VideoPlayerComponent, ScreenSharePlayerComponent
I'm using Next.js or Vue/Nuxt
Framework Integrations - SSR considerations
Server-side JWT generation patterns
Client-side only SDK usage
Most Critical Documents
1. SDK Architecture Pattern (MASTER DOCUMENT)
concepts/sdk-architecture-pattern.md
The universal 5-step pattern:
Create client
Initialize SDK
Join session
Get stream
Use features + listen to events
2. Common Issues (MOST COMMON PROBLEMS)
troubleshooting/common-issues.md
Common issues:
getMediaStream() returns undefined
Video not displaying
renderVideo() deprecated
3. Singleton Hierarchy (NAVIGATION MAP)
concepts/singleton-hierarchy.md
4-level deep navigation showing how to reach every feature.
Key Learnings
Critical Discoveries:
getMediaStream() ONLY works after join()
The stream object is not available until session is joined
Use attachVideo() NOT renderVideo()
renderVideo() is deprecated
attachVideo() returns a VideoPlayer element to append to DOM
See: Video Rendering
The SDK is Event-Driven
You MUST listen for events to render participant videos
key events: peer-video-state-change, user-added, user-removed
See: Event Handling
Peer Videos on Mid-Session Join
Existing participants' videos won't auto-render
Must manually iterate getAllUser() and attachVideo()
See: Video Rendering
CDN vs NPM
CDN exports as
WebVideoSDK.default, notZoomVideoSome networks/ad blockers may block
source.zoom.us- allowlist or use a permitted fallback strategySee: Session Join Pattern
SharedArrayBuffer for HD
Required for 720p/1080p video
Need COOP/COEP headers on server
Check with
stream.isSupportHDVideo()
Screen Share Element Type
Check
isStartShareScreenWithVideoElement()for correct element typeSee: Screen Share
Command Channel Setup Order
Must call getCommandClient() AFTER client.join()
Register listeners AFTER join, not before
Web uses getCommandClient() not getCmdChannel()
See: Command Channel
Command Channel is Session-Scoped
Does NOT span across different sessions
Both sender and receiver must be in the same session
Quick Reference
"getMediaStream() returns undefined"
→ Call AFTER join() completes
"Video not showing"
→ Video Rendering - Use attachVideo(), check events
"renderVideo() doesn't work"
→ Video Rendering - Use attachVideo() instead
"How do I implement [feature]?"
"How do I navigate to [client]?"
"What error code means what?"
Document Version
Based on Zoom Video SDK for Web v2.3.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 AutoGineer878 B
- LICENSELicence file added by AutoGineer1.1 KiB
- RUNBOOK.md2.5 KiB
- SKILL.md25.6 KiB
- agents/openai.yaml300 B
- concepts/sdk-architecture-pattern.md8.3 KiB
- concepts/singleton-hierarchy.md18.9 KiB
- examples/chat.md12.0 KiB
- examples/command-channel.md7.1 KiB
- examples/event-handling.md14.1 KiB
- examples/framework-integrations.md10.8 KiB
- examples/react-hooks.md9.8 KiB
- examples/recording.md10.3 KiB
- examples/screen-share.md12.0 KiB
- examples/session-join-pattern.md10.1 KiB
- examples/transcription.md13.9 KiB
- examples/video-rendering.md9.9 KiB
- references/events-reference.md12.8 KiB
- references/web-reference.md15.5 KiB
- references/web.md26.1 KiB
- troubleshooting/common-issues.md10.9 KiB
examples/chat.md
Chat
Complete guide to implementing chat functionality in the Zoom Video SDK for Web.
Getting the Chat Client
// Get chat client after joining session
const chatClient = client.getChatClient();Sending Messages
Send to Everyone
// Send to all participants
await chatClient.sendToAll('Hello everyone!');Send to Specific User
// Send private message to specific user
const userId = 12345;
await chatClient.send('Hello!', userId);Get Available Receivers
// Get list of users you can send messages to
const receivers = chatClient.getReceivers();
receivers.forEach(user => {
console.log(user.displayName, user.userId);
});Receiving Messages
// Listen for incoming messages
client.on('chat-on-message', (payload) => {
const {
id, // Message ID
message, // Message text
sender, // { userId, name, avatar }
receiver, // { userId, name } or 'everyone'
timestamp, // Unix timestamp
isPrivate, // Boolean - is this a private message
} = payload;
console.log(`[${sender.name}]: ${message}`);
if (isPrivate) {
console.log('(Private message)');
}
addMessageToUI(payload);
});Chat History
// Get chat history for current session
const history = chatClient.getHistory();
history.forEach(msg => {
console.log(`${msg.sender.name}: ${msg.message}`);
});Chat Privileges
Check Current Privilege
import { ChatPrivilege } from '@zoom/videosdk';
const privilege = chatClient.getPrivilege();
switch (privilege) {
case ChatPrivilege.All:
// Can chat to everyone and privately
break;
case ChatPrivilege.NoOne:
// Cannot send chat
break;
case ChatPrivilege.EveryonePublicly:
// Can only send to everyone (no private)
break;
}Set Privilege (Host Only)
// Host can control chat privileges
await chatClient.setPrivilege(ChatPrivilege.All); // Allow all chat
await chatClient.setPrivilege(ChatPrivilege.NoOne); // Disable chat
await chatClient.setPrivilege(ChatPrivilege.EveryonePublicly); // Public onlyListen for Privilege Changes
client.on('chat-privilege-change', (payload) => {
const { chatPrivilege } = payload;
if (chatPrivilege === ChatPrivilege.NoOne) {
disableChatInput();
showNotification('Chat has been disabled by host');
} else {
enableChatInput();
}
});File Transfer
Check if File Transfer is Enabled
const isEnabled = chatClient.isFileTransferEnabled();
if (isEnabled) {
// Get file transfer settings
const settings = chatClient.getFileTransferSetting();
console.log('Max file size:', settings.maxFileSize);
}Send File
// Send file to specific user
const file = document.getElementById('fileInput').files[0];
const userId = 12345;
try {
const cancelFn = await chatClient.sendFile(file, userId);
// To cancel upload
// cancelFn();
} catch (error) {
console.error('File upload failed:', error);
}
// Track upload progress
client.on('chat-file-upload-progress', (payload) => {
const { fileName, progress, status, fileSize } = payload;
console.log(`Upload ${fileName}: ${progress}%`);
if (status === 'success') {
console.log('Upload complete');
} else if (status === 'fail') {
console.log('Upload failed');
}
});Download File
// Download file from message
const messageId = 'msg123';
const fileUrl = 'https://...';
try {
const cancelFn = await chatClient.downloadFile(messageId, fileUrl);
// Or get as blob for display
const blob = await chatClient.downloadFile(messageId, fileUrl, true);
const url = URL.createObjectURL(blob);
// Display image or create download link
} catch (error) {
console.error('Download failed:', error);
}
// Track download progress
client.on('chat-file-download-progress', (payload) => {
const { fileName, progress, status, fileBlob } = payload;
console.log(`Download ${fileName}: ${progress}%`);
if (status === 'success' && fileBlob) {
// File ready
const url = URL.createObjectURL(fileBlob);
}
});Complete Chat Component
class ChatManager {
constructor(client) {
this.client = client;
this.chatClient = null;
this.messages = [];
}
init() {
this.chatClient = this.client.getChatClient();
this.setupEventListeners();
this.loadHistory();
}
setupEventListeners() {
// Incoming messages
this.client.on('chat-on-message', (payload) => {
this.messages.push(payload);
this.onMessageReceived(payload);
});
// Privilege changes
this.client.on('chat-privilege-change', (payload) => {
this.onPrivilegeChange(payload.chatPrivilege);
});
// File upload progress
this.client.on('chat-file-upload-progress', (payload) => {
this.onUploadProgress(payload);
});
// File download progress
this.client.on('chat-file-download-progress', (payload) => {
this.onDownloadProgress(payload);
});
}
loadHistory() {
this.messages = this.chatClient.getHistory();
this.renderMessages();
}
async sendMessage(text, receiverId = null) {
const privilege = this.chatClient.getPrivilege();
if (privilege === ChatPrivilege.NoOne) {
throw new Error('Chat is disabled');
}
try {
if (receiverId) {
await this.chatClient.send(text, receiverId);
} else {
await this.chatClient.sendToAll(text);
}
} catch (error) {
console.error('Failed to send message:', error);
throw error;
}
}
async sendFile(file, receiverId) {
if (!this.chatClient.isFileTransferEnabled()) {
throw new Error('File transfer is disabled');
}
const settings = this.chatClient.getFileTransferSetting();
if (file.size > settings.maxFileSize) {
throw new Error(`File too large. Max: ${settings.maxFileSize} bytes`);
}
return await this.chatClient.sendFile(file, receiverId);
}
getReceivers() {
return this.chatClient.getReceivers();
}
getPrivilege() {
return this.chatClient.getPrivilege();
}
// Override these in your implementation
onMessageReceived(message) {
console.log('New message:', message);
this.renderMessages();
}
onPrivilegeChange(privilege) {
console.log('Privilege changed:', privilege);
}
onUploadProgress(progress) {
console.log('Upload:', progress);
}
onDownloadProgress(progress) {
console.log('Download:', progress);
}
renderMessages() {
// Implement your UI rendering
}
}
// Usage
const chatManager = new ChatManager(client);
chatManager.init();
// Send message
document.getElementById('send-btn').onclick = async () => {
const input = document.getElementById('chat-input');
await chatManager.sendMessage(input.value);
input.value = '';
};React Component
import React, { useState, useEffect, useRef } from 'react';
import { VideoClient, ChatPrivilege } from '@zoom/videosdk';
interface ChatMessage {
id: string;
message: string;
sender: { userId: number; name: string };
timestamp: number;
isPrivate: boolean;
}
interface ChatProps {
client: typeof VideoClient;
}
export const Chat: React.FC<ChatProps> = ({ client }) => {
const [messages, setMessages] = useState<ChatMessage[]>([]);
const [inputValue, setInputValue] = useState('');
const [privilege, setPrivilege] = useState<ChatPrivilege>(ChatPrivilege.All);
const [receivers, setReceivers] = useState<any[]>([]);
const [selectedReceiver, setSelectedReceiver] = useState<number | null>(null);
const messagesEndRef = useRef<HTMLDivElement>(null);
const chatClient = client.getChatClient();
useEffect(() => {
// Load history
setMessages(chatClient.getHistory());
setReceivers(chatClient.getReceivers());
setPrivilege(chatClient.getPrivilege());
// Listen for new messages
const handleMessage = (payload: ChatMessage) => {
setMessages(prev => [...prev, payload]);
};
// Listen for privilege changes
const handlePrivilege = (payload: { chatPrivilege: ChatPrivilege }) => {
setPrivilege(payload.chatPrivilege);
};
// Listen for user changes (update receivers)
const handleUserChange = () => {
setReceivers(chatClient.getReceivers());
};
client.on('chat-on-message', handleMessage);
client.on('chat-privilege-change', handlePrivilege);
client.on('user-added', handleUserChange);
client.on('user-removed', handleUserChange);
return () => {
client.off('chat-on-message', handleMessage);
client.off('chat-privilege-change', handlePrivilege);
client.off('user-added', handleUserChange);
client.off('user-removed', handleUserChange);
};
}, [client, chatClient]);
// Auto-scroll to bottom
useEffect(() => {
messagesEndRef.current?.scrollIntoView({ behavior: 'smooth' });
}, [messages]);
const sendMessage = async () => {
if (!inputValue.trim()) return;
if (privilege === ChatPrivilege.NoOne) return;
try {
if (selectedReceiver) {
await chatClient.send(inputValue, selectedReceiver);
} else {
await chatClient.sendToAll(inputValue);
}
setInputValue('');
} catch (error) {
console.error('Send failed:', error);
}
};
const handleKeyPress = (e: React.KeyboardEvent) => {
if (e.key === 'Enter' && !e.shiftKey) {
e.preventDefault();
sendMessage();
}
};
const isDisabled = privilege === ChatPrivilege.NoOne;
return (
<div className="chat-container">
<div className="chat-messages">
{messages.map((msg) => (
<div key={msg.id} className={`message ${msg.isPrivate ? 'private' : ''}`}>
<span className="sender">{msg.sender.name}</span>
{msg.isPrivate && <span className="private-badge">(private)</span>}
<p className="text">{msg.message}</p>
<span className="time">
{new Date(msg.timestamp).toLocaleTimeString()}
</span>
</div>
))}
<div ref={messagesEndRef} />
</div>
<div className="chat-input-area">
<select
value={selectedReceiver || ''}
onChange={(e) => setSelectedReceiver(e.target.value ? Number(e.target.value) : null)}
disabled={isDisabled || privilege === ChatPrivilege.EveryonePublicly}
>
<option value="">Everyone</option>
{receivers.map((r) => (
<option key={r.userId} value={r.userId}>
{r.displayName}
</option>
))}
</select>
<input
type="text"
value={inputValue}
onChange={(e) => setInputValue(e.target.value)}
onKeyPress={handleKeyPress}
placeholder={isDisabled ? 'Chat disabled' : 'Type a message...'}
disabled={isDisabled}
/>
<button onClick={sendMessage} disabled={isDisabled || !inputValue.trim()}>
Send
</button>
</div>
{isDisabled && (
<div className="chat-disabled-notice">
Chat has been disabled by the host
</div>
)}
</div>
);
};Key Points
Get ChatClient after joining -
client.getChatClient()only works afterjoin()Check privileges - Host can disable chat or limit to public only
Handle private messages - Check
isPrivateflag in message payloadFile transfer - Check
isFileTransferEnabled()before sending filesUpdate receivers list - Refresh when participants join/leave
Error Handling
try {
await chatClient.sendToAll('Hello');
} catch (error) {
switch (error.type) {
case 'IMPROPER_MEETING_STATE':
// Not in a session
break;
case 'INSUFFICIENT_PRIVILEGES':
// Chat disabled or no permission
break;
case 'INVALID_PARAMETERS':
// Invalid message or receiver
break;
}
}Related Documentation
Event Handling - Chat events
API Reference - Full ChatClient API
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.
Needs: Needs network access, Needs Node.js
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/web · 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-web.zip