# haiyangwu/mediasoup-demo-android architecture

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

- Interactive diagram: https://gitdiagram.com/haiyangwu/mediasoup-demo-android
- Repository: https://github.com/haiyangwu/mediasoup-demo-android

## Overview

##### Project type and purpose
- This is an Android demo client for the mediasoup SFU (selective forwarding unit), intended to connect to the public demo server at https://demo.mediasoup.org.
- It shows how to establish WebRTC transports via a WebSocket signaling channel (Protoo), manage peers, produce and consume media.

##### File structure
- Top-level module “app” (standard Android Gradle module).
- Under app/src/main/java/org/mediasoup/droid/demo: Activities (RoomActivity, SettingsActivity, SplashScreenActivity), custom Views (MeView, PeerView), ViewModel classes (RoomProps, MeProps, PeerProps), and adapters.
- Under app/src/main/java/org/mediasoup/droid/lib: core client library classes—RoomClient (main orchestration), Protoo (signaling wrapper), WebSocketTransport, PeerConnectionUtils, plus data models for RoomInfo, Peers, Producers, Consumers.
- Android resources (layouts, drawables, menus, preferences) define the UI.
- Test code sits under app/src/test and app/src/androidTest.

##### README
- Confirms this is purely a demo application for mediasoup’s Android client.
- No additional architectural notes, so we infer patterns from code.

a. Main components
- UI Layer: Activities → Data Binding → Views (MeView, PeerView)
- Presentation Layer: ViewModels (RoomProps, PeerProps, etc.) holding LiveData, interacting with UI
- Domain / Library Layer: RoomClient orchestrates signaling and media events
- Signaling Transport: Protoo over WebSocketTransport
- WebRTC API Layer: PeerConnectionUtils uses Android’s WebRTC native bindings via JNI
- External Services: mediasoup demo server (signaling endpoint + SFU media router)
- Data Models: RoomInfo, Peers, Producers, Consumers classes

b. Relationships and interactions
1. User opens SplashScreenActivity → SettingsActivity → RoomActivity.
2. RoomActivity binds to its ViewModel (RoomProps), observes LiveData for peers & media streams.
3. ViewModel calls RoomClient APIs to join/leave rooms, create transports, produce/consume tracks.
4. RoomClient uses Protoo + WebSocketTransport to exchange SDP offers/answers, ICE candidates with SFU.
5. Upon receiving signaling messages, RoomClient calls PeerConnectionUtils to manage underlying WebRTC PeerConnection.
6. Media frames flow between WebRTC engine and UI via SurfaceViews inside PeerView/MeView.

c. Architectural patterns and principles
- MVVM: clear separation between Activity/UI, ViewModel, and business logic.
- Observer pattern: Android LiveData for state propagation.
- Adapter pattern: PeerAdapter to bind peer list data to RecyclerView views.
- Single-responsibility: RoomClient handles only signaling and media control; UI only handles rendering and user input.

d. Key technologies, frameworks, libraries
- Android SDK, AndroidX, Data Binding, Lifecycle & LiveData
- Java (or Java/Kotlin mix) codebase
- mediasoup-client native library (via JNI)
- WebRTC Android SDK
- Protoo signaling JS port in Java
- Gradle build system

##### Detailed coverage
- Every major package: demo.activities, demo.vm, demo.view, lib.socket, lib.model, lib.lv, lib.utils.
- Resource files only as supporting elements for UI components (optional small note).

Summary
1. Android UI Activities & Views
2. ViewModel & LiveData
3. RoomClient Library (signaling orchestration)
4. WebSocketTransport/Protoo & WebRTC (PeerConnectionUtils + JNI)
5. External mediasoup SFU Server

- This level of detail captures the essential architectural elements without over-splitting trivial utility classes.

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% UI Layer
    subgraph "Android UI Layer" 
        style UI fill:#ccffcc,stroke:#333,stroke-width:1px
        Splash["SplashScreenActivity"]:::activity
        Settings["SettingsActivity"]:::activity
        RoomAct["RoomActivity"]:::activity
        MeV["MeView"]:::view
        PeerV["PeerView"]:::view
    end

    %% ViewModel Layer
    subgraph "ViewModel & Binding Layer"
        style VM fill:#ccddff,stroke:#333,stroke-width:1px
        RoomP["RoomProps"]:::vm
        MeP["MeProps"]:::vm
        PeerP["PeerProps"]:::vm
        PeerVP["PeerViewProps"]:::vm
        EdiasP["EdiasProps"]:::vm
        PeerAdapter["PeerAdapter"]:::adapter
        BindAdapters["BindingAdapters"]:::adapter
    end

    %% Domain/Library Layer
    subgraph "RoomClient Library Layer"
        style Lib fill:#ffe0b3,stroke:#333,stroke-width:1px
        RoomClient["RoomClient"]:::core
        RoomMsgHandler["RoomMessageHandler"]:::core
        RoomOptions["RoomOptions"]:::core
        UrlFactory["UrlFactory"]:::core
    end

    %% Signaling Layer
    subgraph "Signaling Transport"
        style Signal fill:#ffff99,stroke:#333,stroke-width:1px
        Protoo["Protoo"]:::signal
        WSTrans["WebSocketTransport"]:::signal
    end

    %% WebRTC & Native Layer
    subgraph "WebRTC & Native JNI"
        style WebRTC fill:#ffccff,stroke:#333,stroke-width:1px
        PCUtils["PeerConnectionUtils"]:::native
        AsyncU["Async"]:::util
        UtilsU["Utils"]:::util
        JsonU["JsonUtils"]:::util
    end

    %% LiveData Stores
    subgraph "LiveData Stores"
        style LV fill:#e6e6e6,stroke:#333,stroke-width:1px
        RoomStore["RoomStore"]:::store
        SupplierLD["SupplierMutableLiveData"]:::store
    end

    %% Data Models
    subgraph "Data Models"
        style Model fill:#d9d9d9,stroke:#333,stroke-width:1px
        RoomInfo["RoomInfo"]:::model
        PeersM["Peers"]:::model
        PeerM["Peer"]:::model
        Producers["Producers"]:::model
        Consumers["Consumers"]:::model
        DataConsumers["DataConsumers"]:::model
        MeM["Me"]:::model
        DeviceInfo["DeviceInfo"]:::model
        InfoM["Info"]:::model
        Notify["Notify"]:::model
    end

    %% Utilities (demo-specific)
    subgraph "Demo Utils"
        style DemoU fill:#f2f2f2,stroke:#333,stroke-width:1px
        ClipCopy["ClipboardCopy"]:::demoUtil
        CombinedLD["CombinedLiveData"]:::demoUtil
    end

    %% External Service
    SFU["mediasoup SFU Server"]:::external

    %% Connections
    %% UI navigation
    User["User"]:::external -->|"launch"| Splash
    Splash -->|"navigate"| Settings
    Settings -->|"openRoom"| RoomAct

    %% UI to ViewModel
    RoomAct -->|"bind/observe"| RoomP
    RoomAct -->|"render"| MeV
    RoomAct -->|"render"| PeerV

    %% ViewModel to Domain
    RoomP -->|"joinRoom() call"| RoomClient
    MeP --> RoomClient
    PeerP --> RoomClient

    %% Binding adapters
    PeerAdapter --> PeerV
    BindAdapters --> MeV

    %% Domain orchestration
    RoomClient --> RoomMsgHandler
    RoomClient --> RoomOptions
    RoomClient --> UrlFactory

    %% Signaling
    RoomMsgHandler -->|"signal via"| Protoo
    Protoo --> WSTrans

    %% External SFU
    WSTrans -->|"WebSocket SDP/ICE"| SFU
    SFU -->|"SDP answer/ICE"| WSTrans

    %% WebRTC JNI
    RoomClient -->|"manage PeerConnection"| PCUtils
    PCUtils --> AsyncU
    PCUtils --> UtilsU
    PCUtils --> JsonU

    %% LiveData updates
    RoomClient -->|"update state"| RoomStore
    RoomStore --> SupplierLD
    SupplierLD --> RoomP

    %% Data Models interactions
    RoomStore --> RoomInfo
    RoomStore --> PeersM
    RoomStore --> Producers
    RoomStore --> Consumers

    %% SFU media flow
    PCUtils -->|"onTrack event"| RoomClient
    RoomClient --> RoomP
    RoomP --> PeerV
    RoomP --> MeV

    %% Demo Utils usage
    RoomAct --> ClipCopy
    RoomP --> CombinedLD

    %% Styles
    classDef activity fill:#ccffcc,stroke:#333,stroke-width:1px
    classDef view fill:#ccffcc,stroke:#333,stroke-width:1px
    classDef vm fill:#ccddff,stroke:#333,stroke-width:1px
    classDef adapter fill:#ccddff,stroke:#333,stroke-width:1px
    classDef core fill:#ffe0b3,stroke:#333,stroke-width:1px
    classDef signal fill:#ffff99,stroke:#333,stroke-width:1px
    classDef native fill:#ffccff,stroke:#333,stroke-width:1px
    classDef util fill:#ffccff,stroke:#333,stroke-width:1px
    classDef store fill:#e6e6e6,stroke:#333,stroke-width:1px
    classDef model fill:#d9d9d9,stroke:#333,stroke-width:1px
    classDef demoUtil fill:#f2f2f2,stroke:#333,stroke-width:1px
    classDef external fill:#cccccc,stroke:#333,stroke-width:1px

    %% Click Events
    click Splash "https://github.com/haiyangwu/mediasoup-demo-android/blob/master/app/src/main/java/org/mediasoup/droid/demo/SplashScreenActivity.java"
    click Settings "https://github.com/haiyangwu/mediasoup-demo-android/blob/master/app/src/main/java/org/mediasoup/droid/demo/SettingsActivity.java"
    click RoomAct "https://github.com/haiyangwu/mediasoup-demo-android/blob/master/app/src/main/java/org/mediasoup/droid/demo/RoomActivity.java"
    click MeV "https://github.com/haiyangwu/mediasoup-demo-android/blob/master/app/src/main/java/org/mediasoup/droid/demo/view/MeView.java"
    click PeerV "https://github.com/haiyangwu/mediasoup-demo-android/blob/master/app/src/main/java/org/mediasoup/droid/demo/view/PeerView.java"
    click RoomP "https://github.com/haiyangwu/mediasoup-demo-android/blob/master/app/src/main/java/org/mediasoup/droid/demo/vm/RoomProps.java"
    click MeP "https://github.com/haiyangwu/mediasoup-demo-android/blob/master/app/src/main/java/org/mediasoup/droid/demo/vm/MeProps.java"
    click PeerP "https://github.com/haiyangwu/mediasoup-demo-android/blob/master/app/src/main/java/org/mediasoup/droid/demo/vm/PeerProps.java"
    click PeerVP "https://github.com/haiyangwu/mediasoup-demo-android/blob/master/app/src/main/java/org/mediasoup/droid/demo/vm/PeerViewProps.java"
    click EdiasP "https://github.com/haiyangwu/mediasoup-demo-android/blob/master/app/src/main/java/org/mediasoup/droid/demo/vm/EdiasProps.java"
    click PeerAdapter "https://github.com/haiyangwu/mediasoup-demo-android/blob/master/app/src/main/java/org/mediasoup/droid/demo/adapter/PeerAdapter.java"
    click BindAdapters "https://github.com/haiyangwu/mediasoup-demo-android/blob/master/app/src/main/java/org/mediasoup/droid/demo/BindingAdapters.java"
    click RoomClient "https://github.com/haiyangwu/mediasoup-demo-android/blob/master/app/src/main/java/org/mediasoup/droid/lib/RoomClient.java"
    click RoomMsgHandler "https://github.com/haiyangwu/mediasoup-demo-android/blob/master/app/src/main/java/org/mediasoup/droid/lib/RoomMessageHandler.java"
    click RoomOptions "https://github.com/haiyangwu/mediasoup-demo-android/blob/master/app/src/main/java/org/mediasoup/droid/lib/RoomOptions.java"
    click UrlFactory "https://github.com/haiyangwu/mediasoup-demo-android/blob/master/app/src/main/java/org/mediasoup/droid/lib/UrlFactory.java"
    click Protoo "https://github.com/haiyangwu/mediasoup-demo-android/blob/master/app/src/main/java/org/mediasoup/droid/lib/Protoo.java"
    click WSTrans "https://github.com/haiyangwu/mediasoup-demo-android/blob/master/app/src/main/java/org/mediasoup/droid/lib/socket/WebSocketTransport.java"
    click PCUtils "https://github.com/haiyangwu/mediasoup-demo-android/blob/master/app/src/main/java/org/mediasoup/droid/lib/PeerConnectionUtils.java"
    click AsyncU "https://github.com/haiyangwu/mediasoup-demo-android/blob/master/app/src/main/java/org/mediasoup/droid/lib/Async.java"
    click UtilsU "https://github.com/haiyangwu/mediasoup-demo-android/blob/master/app/src/main/java/org/mediasoup/droid/lib/Utils.java"
    click JsonU "https://github.com/haiyangwu/mediasoup-demo-android/blob/master/app/src/main/java/org/mediasoup/droid/lib/JsonUtils.java"
    click RoomStore "https://github.com/haiyangwu/mediasoup-demo-android/blob/master/app/src/main/java/org/mediasoup/droid/lib/lv/RoomStore.java"
    click SupplierLD "https://github.com/haiyangwu/mediasoup-demo-android/blob/master/app/src/main/java/org/mediasoup/droid/lib/lv/SupplierMutableLiveData.java"
    click RoomInfo "https://github.com/haiyangwu/mediasoup-demo-android/blob/master/app/src/main/java/org/mediasoup/droid/lib/model/RoomInfo.java"
    click PeersM "https://github.com/haiyangwu/mediasoup-demo-android/blob/master/app/src/main/java/org/mediasoup/droid/lib/model/Peers.java"
    click PeerM "https://github.com/haiyangwu/mediasoup-demo-android/blob/master/app/src/main/java/org/mediasoup/droid/lib/model/Peer.java"
    click Producers "https://github.com/haiyangwu/mediasoup-demo-android/blob/master/app/src/main/java/org/mediasoup/droid/lib/model/Producers.java"
    click Consumers "https://github.com/haiyangwu/mediasoup-demo-android/blob/master/app/src/main/java/org/mediasoup/droid/lib/model/Consumers.java"
    click DataConsumers "https://github.com/haiyangwu/mediasoup-demo-android/blob/master/app/src/main/java/org/mediasoup/droid/lib/model/DataConsumers.java"
    click MeM "https://github.com/haiyangwu/mediasoup-demo-android/blob/master/app/src/main/java/org/mediasoup/droid/lib/model/Me.java"
    click DeviceInfo "https://github.com/haiyangwu/mediasoup-demo-android/blob/master/app/src/main/java/org/mediasoup/droid/lib/model/DeviceInfo.java"
    click InfoM "https://github.com/haiyangwu/mediasoup-demo-android/blob/master/app/src/main/java/org/mediasoup/droid/lib/model/Info.java"
    click Notify "https://github.com/haiyangwu/mediasoup-demo-android/blob/master/app/src/main/java/org/mediasoup/droid/lib/model/Notify.java"
    click ClipCopy "https://github.com/haiyangwu/mediasoup-demo-android/blob/master/app/src/main/java/org/mediasoup/droid/demo/utils/ClipboardCopy.java"
    click CombinedLD "https://github.com/haiyangwu/mediasoup-demo-android/blob/master/app/src/main/java/org/mediasoup/droid/demo/utils/CombinedLiveData.java"
```
