probe-sdk

name	probe-sdk
description	Zoom Probe SDK for web diagnostics. Use to test media permissions, audio/video/screen-share diagnostics, network quality, compatibility reporting, and consented offline camera-dump evidence before users join meetings or sessions.
triggers	["probe sdk","zoom probe","@zoom/probesdk","media diagnostics","network diagnostic","preflight check","diagnose audio video","browser compatibility diagnostics","diagnostic report","camera dump","screen share diagnostic"]

Zoom Probe SDK

Implementation guidance for Zoom Probe SDK (web) to run preflight diagnostics on user devices and network before meeting/session workflows.

Current npm package verified on 2026-07-10: @zoom/probesdk@1.0.4.

Official docs:

• https://developers.zoom.us/docs/probe-sdk/
• https://marketplacefront.zoom.us/sdk/probe/index.html

Reference sample:

• https://github.com/zoom/probesdk-web

Routing Guardrail

• Use Probe SDK when the user needs client-side diagnostics and readiness scoring (device/network/browser capability), not meeting/session join.
• If user needs embedded meeting flows, route to ../meeting-sdk/SKILL.md.
• If user needs custom real-time session UX, route to ../video-sdk/SKILL.md.
• If user needs backend orchestration of events/APIs, chain with ../rivet-sdk/SKILL.md, ../oauth/SKILL.md, and ../rest-api/SKILL.md.

Quick Links

Start here:

1. probe-sdk.md
2. concepts/architecture-and-lifecycle.md
3. scenarios/high-level-scenarios.md
4. examples/diagnostic-page-pattern.md
5. examples/comprehensive-network-pattern.md
6. references/probe-reference-map.md
7. references/environment-variables.md
8. references/versioning-and-compatibility.md
9. references/samples-validation.md
10. references/source-map.md
11. troubleshooting/common-issues.md
12. RUNBOOK.md

Common Lifecycle Pattern

1. Initialize Prober / Reporter.
2. Request media permissions and enumerate devices.
3. Run targeted diagnostics (diagnoseAudio, diagnoseVideo, diagnoseScreenShare).
4. Run comprehensive network diagnostic (startToDiagnose) and stream stats to UI.
5. Produce final report and apply readiness gates.
6. Stop/cleanup (stopToDiagnose, stopToDiagnoseVideo, releaseMediaStream, cleanup).

High-Level Scenarios

• Pre-join diagnostics page before Meeting SDK join action.
• Support workflow that captures structured report for customer troubleshooting.
• Device certification flow for kiosk or controlled endpoint environments.
• Browser capability gating for advanced media features.
• Consented Chrome/Chromium camera evidence capture with startCameraDump() for black-frame or flicker investigations. The SDK creates an offline .probe.tar or .probe.tar.gz; it does not upload the bundle.

See scenarios/high-level-scenarios.md for details.

Chaining

• Meeting pre-join gate: ../meeting-sdk/web/SKILL.md
• Video session readiness gate: ../video-sdk/web/SKILL.md
• Telemetry/report ingestion backend: ../rivet-sdk/SKILL.md + ../rest-api/SKILL.md

Environment Variables

• See references/environment-variables.md for optional .env keys and how to source values.

Operations

• RUNBOOK.md - 5-minute preflight and debugging checklist.