How haiyangwu/mediasoup-demo-android works
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.