Back to Details

probe-sdk

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

Zoom Probe SDK

Zoom Probe SDK

Background reference for preflight diagnostics on user devices and networks before meeting or session workflows.
Official docs:
Reference sample:
供会议或会话工作流启动前对用户设备和网络进行预检诊断的背景参考。
官方文档：
参考示例：

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.
  • 当用户需要客户端诊断和就绪度评分（设备/网络/浏览器能力）而非加入会议/会话时，使用Probe SDK。
  • 如果用户需要嵌入式会议流，请跳转至../meeting-sdk/SKILL.md。
  • 如果用户需要自定义实时会话UX，请跳转至../video-sdk/SKILL.md。
  • 如果用户需要事件/API的后端编排，请关联使用../rivet-sdk/SKILL.md、../oauth/SKILL.md和../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
从这里开始：
  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
    ).
  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
    ).
  1. 初始化
    Prober
    / 
    Reporter
    。
  2. 请求媒体权限并枚举设备。
  3. 运行针对性诊断（
    diagnoseAudio
    、
    diagnoseVideo
    ）。
  4. 运行全面网络诊断（
    startToDiagnose
    ）并将统计数据流式传输到UI。
  5. 生成最终报告并应用就绪度门槛校验。
  6. 停止/清理资源（
    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.
See scenarios/high-level-scenarios.md for details.
  • Meeting SDK加入操作前的预加入诊断页面。
  • 支持捕获结构化报告供客户排查问题的工作流。
  • 面向kiosk或受控终端环境的设备认证流程。
  • 高级媒体功能的浏览器能力门槛校验。
详见scenarios/high-level-scenarios.md了解详情。

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
  • 会议预加入校验：../meeting-sdk/web/SKILL.md
  • 视频会话就绪度校验：../video-sdk/web/SKILL.md
  • 遥测/报告接入后端：../rivet-sdk/SKILL.md + ../rest-api/SKILL.md

Environment Variables

环境变量

  • See references/environment-variables.md for optional 
    .env
    keys and how to source values.
可选
.env
配置项及取值方法请查看references/environment-variables.md。

Operations

运维相关

  • RUNBOOK.md - 5-minute preflight and debugging checklist.
  • RUNBOOK.md - 5分钟预检和调试清单。