Video SDK Web
AnthropicOfficialCreated by ZoomDistributed by Anthropic
- 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 library for developers to build custom video-based experiences directly within browser environments. It supports real-time communication, screen sharing, cloud recording, live streaming, chat, and live transcription. The SDK requires a specific lifecycle, including client initialization and session joining, and provides specialized clients for managing media streams, chat, and other collaborative features.
What it does
- Enables custom video and audio sessions in modern web browsers.
- Supports screen sharing and collaborative whiteboard features.
- Provides tools for cloud recording and live streaming to RTMP endpoints.
- Includes messaging capabilities via chat and command channels.
- Facilitates live transcription for real-time speech-to-text.
- Allows for virtual backgrounds and custom video frame processing.
When to use it
- When building a custom video application that requires a unique UI.
- When integrating real-time video communication into an existing web platform.
- When implementing features like breakout rooms or live transcription in a web-based session.
- When you need to control media stream rendering and participant interaction programmatically.
Advantages
- Provides a modular API for granular control over media and session features.
- Supports standard web technologies like JavaScript and TypeScript.
- Offers specialized clients for distinct features like recording and chat.
- Includes event-driven architecture for handling participant and media state changes.
Usage examples
- “How do I join a video session using the Zoom Video SDK for Web?”
- Initialize the client with your credentials, call the join method with the session topic and signature, then retrieve the media stream object to start video and audio.
- “How can I display a remote participant's video?”
- Listen for the peer-video-state-change event, and when a participant starts their video, use the attachVideo method to append their video element to your DOM.
- “What is the correct way to handle media streams?”
- Always call getMediaStream after the join method has successfully completed to ensure the stream object is available.
- “How do I implement screen sharing?”
- Use the startShareScreen method on the media stream object, passing in a canvas or video element to render the shared content.
Install
Download the skill as a ZIP:
https://mp-staging.autogineer.com/agent-skills/anthropics/video-sdk-web/downloadUnzip it into the cross-client skills folder of your project:
mkdir -p .agents/skills && unzip 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 AutoGineer982 B
- LICENSELicence file added by AutoGineer1.1 KiB
- RUNBOOK.md2.5 KiB
- SKILL.md25.8 KiB
- 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.4 KiB
- examples/screen-share.md12.1 KiB
- examples/session-join-pattern.md10.2 KiB
- examples/transcription.md13.9 KiB
- examples/video-rendering.md10.0 KiB
- references/events-reference.md12.8 KiB
- references/web-reference.md15.5 KiB
- references/web.md26.2 KiB
- troubleshooting/common-issues.md11.0 KiB
examples/screen-share.md
Screen Share
Complete guide to sending and receiving screen shares in the Zoom Video SDK for Web.
Overview
Screen sharing involves two distinct operations:
Sending - Sharing your screen to others (
startShareScreen)Receiving - Viewing others' shared screens (
startShareVieworattachShareView)
Sending Screen Share
Basic Screen Share
// Get the media stream
const stream = client.getMediaStream();
// Create a canvas or video element to render the share preview
const shareCanvas = document.getElementById('share-canvas');
// Start sharing
await stream.startShareScreen(shareCanvas);With Options
await stream.startShareScreen(shareCanvas, {
displaySurface: 'monitor', // 'monitor' | 'window' | 'browser'
audio: true, // Share system/tab audio
optimizedForSharedVideo: true, // Optimize for video content
});Stop Sharing
await stream.stopShareScreen();Pause/Resume
// Pause
await stream.pauseShareScreen();
// Resume
await stream.resumeShareScreen();Receiving Screen Share
Method 1: Canvas-based (Legacy)
// Create a canvas for rendering
const receiveCanvas = document.getElementById('share-view-canvas');
// Listen for active share changes
client.on('active-share-change', async (payload) => {
const { state, userId } = payload;
if (state === 'Active') {
// Someone started sharing - render it
await stream.startShareView(receiveCanvas, userId);
} else if (state === 'Inactive') {
// Sharing stopped
await stream.stopShareView();
}
});Method 2: VideoPlayer-based (Recommended - SDK 2.2.10+)
// Listen for active share changes
client.on('active-share-change', async (payload) => {
const { state, userId } = payload;
if (state === 'Active') {
// Attach share view - returns a VideoPlayer element
const element = await stream.attachShareView(userId);
document.getElementById('share-container').appendChild(element);
} else if (state === 'Inactive') {
// Detach share view
const elements = await stream.detachShareView(userId);
if (Array.isArray(elements)) {
elements.forEach(e => e.remove());
} else if (elements) {
elements.remove();
}
}
});Complete Example
import ZoomVideo from '@zoom/videosdk';
class ScreenShareManager {
constructor(client) {
this.client = client;
this.stream = null;
this.isSharing = false;
this.activeShareUserId = null;
}
init() {
this.stream = this.client.getMediaStream();
this.setupEventListeners();
}
setupEventListeners() {
// When someone starts/stops sharing
this.client.on('active-share-change', async (payload) => {
const { state, userId } = payload;
console.log('Share change:', state, 'from user:', userId);
if (state === 'Active') {
this.activeShareUserId = userId;
await this.renderReceivedShare(userId);
} else {
await this.stopRenderingShare();
this.activeShareUserId = null;
}
});
// When share content changes (e.g., user switches windows)
this.client.on('share-content-change', (payload) => {
console.log('Share content changed for user:', payload.userId);
});
// When share dimension changes
this.client.on('share-content-dimension-change', (payload) => {
console.log('Share dimension:', payload.width, 'x', payload.height);
// Resize container if needed
});
// When you're forced to stop sharing
this.client.on('passively-stop-share', (payload) => {
console.log('Forced to stop sharing. Reason:', payload);
this.isSharing = false;
});
// Share privilege changes
this.client.on('share-privilege-change', (payload) => {
console.log('Share privilege:', payload.privilege);
});
}
async startSharing() {
// Check privilege first
const privilege = this.stream.getSharePrivilege();
if (privilege === 0) {
throw new Error('Sharing not allowed - host has disabled it');
}
// Check if share is locked
if (this.stream.isShareLocked()) {
throw new Error('Sharing is locked by host');
}
const canvas = document.getElementById('share-preview-canvas');
try {
await this.stream.startShareScreen(canvas, {
audio: true,
});
this.isSharing = true;
console.log('Screen share started');
} catch (error) {
console.error('Failed to start screen share:', error);
if (error.type === 'INVALID_OPERATION' && error.reason?.includes('extension')) {
// Chrome extension required (legacy browsers)
console.log('Install extension from:', error.extensionUrl);
}
throw error;
}
}
async stopSharing() {
if (!this.isSharing) return;
await this.stream.stopShareScreen();
this.isSharing = false;
console.log('Screen share stopped');
}
async renderReceivedShare(userId) {
const container = document.getElementById('share-view-container');
try {
// Use attachShareView for VideoPlayer-based rendering (SDK 2.2.10+)
const element = await this.stream.attachShareView(userId);
container.innerHTML = '';
container.appendChild(element);
container.style.display = 'block';
} catch (error) {
console.error('Failed to render share view:', error);
}
}
async stopRenderingShare() {
if (!this.activeShareUserId) return;
const container = document.getElementById('share-view-container');
container.style.display = 'none';
try {
await this.stream.detachShareView(this.activeShareUserId);
container.innerHTML = '';
} catch (error) {
console.error('Failed to detach share view:', error);
}
}
// Get who is currently sharing
getShareUserList() {
return this.stream.getShareUserList();
}
// Get active sharer's user ID
getActiveShareUserId() {
return this.stream.getActiveShareUserId();
}
}
// Usage
const shareManager = new ScreenShareManager(client);
shareManager.init();
// Start sharing
document.getElementById('share-btn').onclick = () => shareManager.startSharing();
document.getElementById('stop-share-btn').onclick = () => shareManager.stopSharing();Share with Audio
// Share screen with system/tab audio
await stream.startShareScreen(canvas, {
audio: true,
});
// Check share audio status
const audioStatus = stream.getShareAudioStatus();
console.log('Share audio:', audioStatus);
// Mute/unmute share audio
await stream.muteShareAudio(); // Mute
await stream.unmuteShareAudio(); // UnmuteShare Privilege Management (Host Only)
import { SharePrivilege } from '@zoom/videosdk';
// Get current privilege
const privilege = stream.getSharePrivilege();
// Set privilege (host only)
await stream.setSharePrivilege(SharePrivilege.Unlocked); // Anyone can share
await stream.setSharePrivilege(SharePrivilege.Locked); // Only host can share
await stream.setSharePrivilege(SharePrivilege.OneParticipant); // One at a time
// Lock/unlock share (host only)
await stream.lockShare(true); // Only host can share
await stream.lockShare(false); // Anyone can shareMultiple Share Views (SDK 2.2.10+)
// Check max renderable share views
const maxViews = stream.getMaxRenderableShareViews();
console.log('Can render up to', maxViews, 'share views');
// Get list of users who are sharing
const sharers = stream.getShareUserList();
// Render multiple share views
for (const sharer of sharers) {
const element = await stream.attachShareView(sharer.userId);
document.getElementById('multi-share-container').appendChild(element);
}Share Quality Optimization
// Optimize for video content (movies, animations)
await stream.enableOptimizeForSharedVideo(true);
// Check if optimized
const isOptimized = stream.isOptimizeForSharedVideoEnabled();
// Check if optimization is supported
const isSupported = stream.isSupportOptimizedForSharedVideo();
// Update shared video quality
await stream.updateSharedVideoQuality(VideoQuality.Video_720P);Screenshot Share View
// Take screenshot of active share
const blob = await stream.screenshotShareView();
// Convert to image
const url = URL.createObjectURL(blob);
const img = document.createElement('img');
img.src = url;
document.body.appendChild(img);React Component
import React, { useEffect, useRef, useState } from 'react';
import { VideoClient, Stream } from '@zoom/videosdk';
interface ScreenShareProps {
client: typeof VideoClient;
stream: typeof Stream;
}
export const ScreenShare: React.FC<ScreenShareProps> = ({ client, stream }) => {
const containerRef = useRef<HTMLDivElement>(null);
const [isSharing, setIsSharing] = useState(false);
const [activeShareUserId, setActiveShareUserId] = useState<number | null>(null);
useEffect(() => {
const handleShareChange = async (payload: { state: string; userId: number }) => {
if (payload.state === 'Active') {
setActiveShareUserId(payload.userId);
if (containerRef.current) {
const element = await stream.attachShareView(payload.userId);
containerRef.current.innerHTML = '';
containerRef.current.appendChild(element);
}
} else {
if (activeShareUserId) {
await stream.detachShareView(activeShareUserId);
}
setActiveShareUserId(null);
if (containerRef.current) {
containerRef.current.innerHTML = '';
}
}
};
const handlePassiveStop = () => {
setIsSharing(false);
};
client.on('active-share-change', handleShareChange);
client.on('passively-stop-share', handlePassiveStop);
return () => {
client.off('active-share-change', handleShareChange);
client.off('passively-stop-share', handlePassiveStop);
};
}, [client, stream, activeShareUserId]);
const startShare = async () => {
try {
const canvas = document.createElement('canvas');
await stream.startShareScreen(canvas);
setIsSharing(true);
} catch (error) {
console.error('Share failed:', error);
}
};
const stopShare = async () => {
await stream.stopShareScreen();
setIsSharing(false);
};
return (
<div className="screen-share">
<div className="controls">
{isSharing ? (
<button onClick={stopShare}>Stop Sharing</button>
) : (
<button onClick={startShare}>Share Screen</button>
)}
</div>
{activeShareUserId && (
<div
ref={containerRef}
className="share-view"
style={{ width: '100%', aspectRatio: '16/9', background: '#000' }}
/>
)}
</div>
);
};Key Events
| Event | When | Payload |
|---|---|---|
active-share-change | Someone starts/stops sharing | { state: 'Active' | 'Inactive', userId } |
share-content-change | Sharer switches window/tab | { userId } |
share-content-dimension-change | Share resolution changes | { width, height, type } |
passively-stop-share | You're forced to stop | PassiveStopShareReason enum |
share-privilege-change | Host changes share settings | { privilege } |
peer-share-state-change | Peer share state changes | { action: 'Start' | 'Stop', userId } |
share-audio-change | Share audio state changes | { state: 'on' | 'off' } |
Key Points
Two methods for receiving: Canvas-based (
startShareView) or VideoPlayer-based (attachShareView)Check privileges first: Use
getSharePrivilege()andisShareLocked()before attempting to shareHandle
passively-stop-share: You may be forced to stop sharing by the hostShare audio requires user gesture: Browsers require user interaction to share audio
Different from video: Screen share uses separate canvas/container from video
Related Documentation
Video Rendering - Video handling
Event Handling - All events
Common Issues - Troubleshooting
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, 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
- Anthropic (Official)
- Distributed by
- Anthropic
- Source
- anthropics/knowledge-work-plugins · partner-built/zoom-plugin/skills/video-sdk/web · 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 video-sdk-web.zip