# zoom/meetingsdk-web architecture

> Architecture diagram of the GitHub repository zoom/meetingsdk-web, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-07-16). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/zoom/meetingsdk-web
- Repository: https://github.com/zoom/meetingsdk-web

## Overview

##### Project Type and Purpose
- This is a frontend-focused JavaScript/TypeScript SDK packaged as an NPM library (@zoom/meetingsdk).
- It embeds Zoom Meeting/Webinar capabilities into a host web application via high-performance WebAssembly (WASM) modules.
- Provides two integration modes: Client View (full-page UI) and Component View (embeddable widgets).

##### High-Level Architecture Components
a. Host Web Application
– Your website or single‐page app that installs and calls into @zoom/meetingsdk.
b. Zoom Meeting SDK Library
– index.js / embedded.js: Entry points exposing ZoomMtg (Client View) and ZoomMtgEmbedded (Component View) APIs.
– Type declarations (index.d.ts, embedded.d.ts).
c. Static Assets (dist/)
– lib/
- audio/ → notification chimes (MP3 files).
- av/ → WebAssembly binaries & supporting JS for audio/video encode/decode, plus binary models (dualModel.bin, vbbuffer.bin) and TFJS WebAssembly backends.
- image/, lang/, vendor/ → locale JSON files, images, third-party assets.
– ui/
- CSS files (zoom-meetingsdk.css variants), cursor files, theming assets.
d. Runtime Components
– WebAssembly Modules
- Audio encoder/decoder, video decoder, network code compiled to .wasm
- Loaded via ZoomMtg.preLoadWasm() and ZoomMtg.prepareWebSDK()
– Web Workers
- vbPreloadWorker.js for preloading ML models & binaries off the main thread.
– DOM Overlays
- SDK will dynamically insert DOM elements (video canvases, controls, notifications).
e. Network & External Services
– Zoom Signaling & Media Servers
- REST/JSON API for meeting management (init/join).
- WebSocket or proprietary real-time signalling for audio/video negotiation.
– Zoom CDN
- Hosts WASM, CSS, audio assets (configured by assetPath or setZoomJSLib / webEndpoint for ZFG).
– Zoom REST API
- Signature (JWT) generation endpoint (your backend or Zoom Auth Sample).
- Optionally webhooks for meeting events (depends on application).

##### Interactions & Data Flow
1. Install & Import: host app does npm install and imports ZoomMtg or ZoomMtgEmbedded.
2. Initialization Phase:
– ZoomMtg.preLoadWasm(): fetch WASM binaries from dist/lib/av.
– ZoomMtg.prepareWebSDK(): load supporting JS, workers, models.
– ZoomMtg.init() / client.init(): configure leaveUrl, assetPath, language, patchJsMedia.
3. Join Phase:
– Host app calls join() with signature, meetingNumber, userCredentials.
– SDK does HTTPS request to Zoom REST API to authorize/join.
– On success, open WebSocket or WebRTC sessions to Zoom media servers.
4. Media Pipeline:
– Audio: microphone capture → audio.encode.wasm → send over network → remote audio.decode.wasm → Web Audio output.
– Video: remote video packets → video.decode.wasm → render to HTML5 <canvas> or <video> element.
– Business logic / events wired to SDK callbacks in host app.
5. UI Rendering:
– CSS from dist/ui/zoom-meetingsdk.css applied to DOM overlays.
– Locale JSON files loaded from dist/lib/lang for button labels, tooltips.

##### Architectural Patterns & Design Principles
- Modular Frontend Library: clearly separated entry points for Client vs Component view.
- Resource Preloading: WASM & ML models loaded ahead of time to minimize join latency.
- WebAssembly + Web Worker Offload: compute-intensive tasks run off main thread.
- Asset CDN Abstraction: assetPath/webEndpoint configuration allows switching between Zoom.com and ZoomGov endpoints.
- Pluggable UI: CSS variables + JS events let integrators customize look & feel.

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Host Application
    subgraph "Host Web Application"
        HostApp["Host App<br/>(imports ZoomMtg / ZoomMtgEmbedded)<br/><div id='meetingSDKElement'>"]:::host
    end

    %% Zoom SDK Library
    subgraph "Zoom SDK Library"
        ZM["ZoomMtg (Client View API)"]:::jsmodule
        ZME["ZoomMtgEmbedded (Component View API)"]:::jsmodule
        TypesClient["Type Declarations (index.d.ts)"]:::jsmodule
        TypesEmbed["Type Declarations (embedded.d.ts)"]:::jsmodule
        WASMLoader["WASM Loader<br/>(preLoadWasm & prepareWebSDK)"]:::wasm
        Workers["Web Workers"]:::worker
        MediaPipeline["Media Pipeline<br/>(Audio & Video)"]:::wasm
        UIRender["DOM Overlays & UI Rendering"]:::ui
    end

    %% Asset CDN / Distribution
    subgraph "Asset CDN / dist"
        AudioAssets["Audio Assets"]:::asset
        AVWasm["WASM Modules"]:::wasm
        VideoShim["Video Decode Helpers"]:::asset
        MLModels["ML Models & TFJS Backends"]:::wasm
        PreWorker["Preload Worker"]:::worker
        PreScript["Preload Script"]:::wasm
        Images["Image Assets"]:::asset
        Lang["Localization JSON"]:::asset
        Vendor["Third-Party Vendor Assets"]:::asset
        UIAssets["UI Styles & Cursors"]:::ui
    end

    %% External Services
    subgraph "External Services"
        RESTAPI["Zoom REST API"]:::external
        Signaling["Zoom Signaling & Media Servers"]:::external
        CDN["Zoom CDN"]:::external
    end

    %% Interactions
    HostApp -->|import| ZM
    HostApp -->|import| ZME

    ZM -->|calls| WASMLoader
    ZME -->|calls| WASMLoader

    WASMLoader -->|fetch .wasm| AVWasm
    WASMLoader -->|load JS shims| VideoShim
    WASMLoader -->|load models| MLModels
    WASMLoader -->|init worker| PreWorker
    WASMLoader -->|execute| PreScript

    PreWorker -->|preload| MLModels
    PreWorker -->|preload| AVWasm

    MediaPipeline -->|decode audio/video| AVWasm
    MediaPipeline -->|apply shims| VideoShim
    MediaPipeline -->|runs in| Workers

    Workers -.->|offloads compute| MediaPipeline

    UIRender -->|apply CSS/themes| UIAssets
    UIRender -->|load locale| Lang
    AudioAssets -.-> UIRender

    ZM -->|REST join| RESTAPI
    ZME -->|REST join| RESTAPI
    ZM -->|signaling| Signaling
    ZME -->|signaling| Signaling
    Signaling <-->|"Media Stream"| MediaPipeline

    CDN -->|serves| AVWasm
    CDN -->|serves| VideoShim
    CDN -->|serves| MLModels
    CDN -->|serves| AudioAssets
    CDN -->|serves| Images
    CDN -->|serves| Lang
    CDN -->|serves| Vendor
    CDN -->|serves| UIAssets

    %% Legend
    subgraph "Legend"
        JS["JS Module"]:::jsmodule
        WASM["WASM Module / ML Model"]:::wasm
        WK["Web Worker"]:::worker
        AS["Asset"]:::asset
        UI_L["UI / CSS"]:::ui
        HA["Host App"]:::host
        EX["External Service"]:::external
    end

    %% Click Events
    click ZM "https://github.com/zoom/meetingsdk-web/blob/master/index.js"
    click ZME "https://github.com/zoom/meetingsdk-web/blob/master/embedded.js"
    click TypesClient "https://github.com/zoom/meetingsdk-web/blob/master/index.d.ts"
    click TypesEmbed "https://github.com/zoom/meetingsdk-web/blob/master/embedded.d.ts"
    click AudioAssets "https://github.com/zoom/meetingsdk-web/tree/master/dist/lib/audio/"
    click AVWasm "https://github.com/zoom/meetingsdk-web/blob/master/dist/lib/av/*.wasm"
    click VideoShim "https://github.com/zoom/meetingsdk-web/blob/master/dist/lib/av/video.simd.js"
    click VideoShim "https://github.com/zoom/meetingsdk-web/blob/master/dist/lib/av/video.mtsimd.js"
    click MLModels "https://github.com/zoom/meetingsdk-web/blob/master/dist/lib/av/vb-resource/dualModel.bin"
    click MLModels "https://github.com/zoom/meetingsdk-web/blob/master/dist/lib/av/vb-resource/vbbuffer.bin"
    click MLModels "https://github.com/zoom/meetingsdk-web/blob/master/dist/lib/av/vb-resource/tfjs-backend-wasm-*.wasm"
    click PreWorker "https://github.com/zoom/meetingsdk-web/blob/master/dist/lib/av/vb-resource/vbPreloadWorker.js"
    click PreScript "https://github.com/zoom/meetingsdk-web/blob/master/dist/lib/av/vb-resource/vbPreload.js"
    click Images "https://github.com/zoom/meetingsdk-web/tree/master/dist/lib/image/"
    click Lang "https://github.com/zoom/meetingsdk-web/tree/master/dist/lib/lang/"
    click Vendor "https://github.com/zoom/meetingsdk-web/tree/master/dist/lib/vendor/"
    click UIAssets "https://github.com/zoom/meetingsdk-web/blob/master/dist/ui/zoom-meetingsdk.css"
    click UIAssets "https://github.com/zoom/meetingsdk-web/tree/master/dist/ui/"

    %% Styles
    classDef jsmodule fill:#cce5ff,stroke:#004085,color:#004085
    classDef wasm fill:#e2e3e5,stroke:#6c757d,color:#6c757d
    classDef worker fill:#ffe5b4,stroke:#ff8800,color:#ff8800
    classDef asset fill:#d1ecf1,stroke:#0c5460,color:#0c5460
    classDef ui fill:#d4edda,stroke:#155724,color:#155724
    classDef host fill:#fff3cd,stroke:#856404,color:#856404
    classDef external fill:#d4edda,stroke:#155724,color:#155724
```
