# gamezad/ts3-mobile architecture

> Architecture diagram of the GitHub repository gamezad/ts3-mobile, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-10-01). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/gamezad/ts3-mobile
- Repository: https://github.com/gamezad/ts3-mobile

## Overview

TS3 Mobile is an experimental Android TeamSpeak 3 client. Users enter server details, connect through the foreground service, browse channels and participants, join channels, and control playback and microphone settings. The service coordinates identity, protocol sessions, reconnection, and audio; the protocol adapter handles TeamSpeak session events, while audio-opus supplies voice encoding and playback. The README documents additional capabilities beyond the sampled code; links for those are shown only where documentation supports them.

Main entry points: [`app/src/main/java/io/github/ts3mobile/app/service/TeamSpeakService.kt`](https://github.com/gamezad/ts3-mobile/blob/main/app/src/main/java/io/github/ts3mobile/app/service/TeamSpeakService.kt) (Foreground service), [`ts3-protocol/src/main/kotlin/io/github/ts3mobile/protocol/Ts3jSessionClient.kt`](https://github.com/gamezad/ts3-mobile/blob/main/ts3-protocol/src/main/kotlin/io/github/ts3mobile/protocol/Ts3jSessionClient.kt) (ts3j adapter), [`app/src/main/java/io/github/ts3mobile/app/MainActivity.kt`](https://github.com/gamezad/ts3-mobile/blob/main/app/src/main/java/io/github/ts3mobile/app/MainActivity.kt) (Activity), [`audio-opus/src/main/java/io/github/ts3mobile/audio/opus/OpusMicrophoneCapture.kt`](https://github.com/gamezad/ts3-mobile/blob/main/audio-opus/src/main/java/io/github/ts3mobile/audio/opus/OpusMicrophoneCapture.kt) (Microphone capture)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_app["Android app"]
  node_activity["Activity<br/>[MainActivity.kt]"]
  node_viewmodel["Connection form<br/>[MainViewModel.kt]"]
  node_screen["Main screen<br/>[MainScreen.kt]"]
  node_service["Foreground service"]
  node_state["Service state"]
  node_reconnect["Reconnect policy<br/>[ReconnectPolicy.kt]"]
end

subgraph group_protocol["TeamSpeak protocol"]
  node_session["Session client API"]
  node_adapter["ts3j adapter"]
  node_snapshot[("Snapshot store")]
  node_channel["Channel ordering<br/>[ChannelTree.kt]"]
  node_models["Session models<br/>[Model.kt]"]
  node_identitycodec["Identity codec"]
end

subgraph group_audio["Voice audio"]
  node_router["Audio routing"]
  node_player["Voice playback<br/>[OpusAudioPlayer.kt]"]
  node_decoder["Opus decoder"]
  node_mixer["Participant mixer"]
  node_capture["Microphone capture"]
  node_encoder["Opus encoder"]
  node_denoiser["RNNoise processor"]
end

subgraph group_identity["Identity security"]
  node_vault[("Identity vault<br/>[IdentityVault.kt]")]
end

node_user(("User"))
node_server{{"TeamSpeak server"}}

node_user -->|"uses"| node_activity
node_activity -->|"updates form"| node_viewmodel
node_activity -->|"renders"| node_screen
node_activity -->|"starts and binds"| node_service
node_screen -->|"orders channels"| node_channel
node_service -->|"publishes state"| node_state
node_service -->|"applies backoff"| node_reconnect
node_service -->|"loads identity"| node_vault
node_vault -->|"generates identity"| node_identitycodec
node_service -->|"controls session"| node_session
node_session -->|"implemented by"| node_adapter
node_adapter -->|"connects and transmits"| node_server
node_adapter -->|"updates and reads"| node_snapshot
node_adapter -->|"uses identity"| node_identitycodec
node_adapter -.->|"maps session data"| node_models
node_screen -.->|"displays roster"| node_models
node_service -->|"controls routing"| node_router
node_service -->|"controls playback"| node_player
node_adapter -.->|"delivers voice frames"| node_player
node_player -->|"decodes packets"| node_decoder
node_player -->|"applies participant gains"| node_mixer
node_service -->|"controls transmission"| node_capture
node_capture -->|"encodes frames"| node_encoder
node_capture -->|"denoises audio"| node_denoiser
node_capture -.->|"provides voice source"| node_session

click node_activity "https://github.com/gamezad/ts3-mobile/blob/main/app/src/main/java/io/github/ts3mobile/app/MainActivity.kt"
click node_viewmodel "https://github.com/gamezad/ts3-mobile/blob/main/app/src/main/java/io/github/ts3mobile/app/MainViewModel.kt"
click node_screen "https://github.com/gamezad/ts3-mobile/blob/main/app/src/main/java/io/github/ts3mobile/app/ui/MainScreen.kt"
click node_service "https://github.com/gamezad/ts3-mobile/blob/main/app/src/main/java/io/github/ts3mobile/app/service/TeamSpeakService.kt"
click node_state "https://github.com/gamezad/ts3-mobile/blob/main/app/src/main/java/io/github/ts3mobile/app/service/TeamSpeakServiceState.kt"
click node_reconnect "https://github.com/gamezad/ts3-mobile/blob/main/app/src/main/java/io/github/ts3mobile/app/service/ReconnectPolicy.kt"
click node_session "https://github.com/gamezad/ts3-mobile/blob/main/ts3-protocol/src/main/kotlin/io/github/ts3mobile/protocol/Ts3SessionClient.kt"
click node_adapter "https://github.com/gamezad/ts3-mobile/blob/main/ts3-protocol/src/main/kotlin/io/github/ts3mobile/protocol/Ts3jSessionClient.kt"
click node_snapshot "https://github.com/gamezad/ts3-mobile/blob/main/ts3-protocol/src/main/kotlin/io/github/ts3mobile/protocol/SessionSnapshotStore.kt"
click node_channel "https://github.com/gamezad/ts3-mobile/blob/main/ts3-protocol/src/main/kotlin/io/github/ts3mobile/protocol/ChannelTree.kt"
click node_models "https://github.com/gamezad/ts3-mobile/blob/main/ts3-protocol/src/main/kotlin/io/github/ts3mobile/protocol/Model.kt"
click node_identitycodec "https://github.com/gamezad/ts3-mobile/blob/main/ts3-protocol/src/main/kotlin/io/github/ts3mobile/protocol/Ts3IdentityCodec.kt"
click node_vault "https://github.com/gamezad/ts3-mobile/blob/main/app/src/main/java/io/github/ts3mobile/app/identity/IdentityVault.kt"
click node_router "https://github.com/gamezad/ts3-mobile/blob/main/audio-opus/src/main/java/io/github/ts3mobile/audio/opus/AudioDeviceRouter.kt"
click node_player "https://github.com/gamezad/ts3-mobile/blob/main/audio-opus/src/main/java/io/github/ts3mobile/audio/opus/OpusAudioPlayer.kt"
click node_decoder "https://github.com/gamezad/ts3-mobile/blob/main/audio-opus/src/main/java/io/github/ts3mobile/audio/opus/NativeOpusDecoder.kt"
click node_mixer "https://github.com/gamezad/ts3-mobile/blob/main/audio-opus/src/main/java/io/github/ts3mobile/audio/opus/ParticipantGainMixer.kt"
click node_capture "https://github.com/gamezad/ts3-mobile/blob/main/audio-opus/src/main/java/io/github/ts3mobile/audio/opus/OpusMicrophoneCapture.kt"
click node_encoder "https://github.com/gamezad/ts3-mobile/blob/main/audio-opus/src/main/java/io/github/ts3mobile/audio/opus/NativeOpusEncoder.kt"
click node_denoiser "https://github.com/gamezad/ts3-mobile/blob/main/audio-opus/src/main/java/io/github/ts3mobile/audio/opus/NativeRnNoiseProcessor.kt"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_activity,node_viewmodel,node_screen,node_service,node_state,node_reconnect,node_user toneBlue
class node_session,node_adapter,node_snapshot,node_channel,node_models,node_identitycodec toneAmber
class node_router,node_player,node_decoder,node_mixer,node_capture,node_encoder,node_denoiser,node_server toneMint
class node_vault toneRose
```

## Components

### Android app

- [Activity](https://github.com/gamezad/ts3-mobile/blob/main/app/src/main/java/io/github/ts3mobile/app/MainActivity.kt): `app/src/main/java/io/github/ts3mobile/app/MainActivity.kt`
- [Connection form](https://github.com/gamezad/ts3-mobile/blob/main/app/src/main/java/io/github/ts3mobile/app/MainViewModel.kt): `app/src/main/java/io/github/ts3mobile/app/MainViewModel.kt`
- [Main screen](https://github.com/gamezad/ts3-mobile/blob/main/app/src/main/java/io/github/ts3mobile/app/ui/MainScreen.kt): `app/src/main/java/io/github/ts3mobile/app/ui/MainScreen.kt`
- [Foreground service](https://github.com/gamezad/ts3-mobile/blob/main/app/src/main/java/io/github/ts3mobile/app/service/TeamSpeakService.kt): `app/src/main/java/io/github/ts3mobile/app/service/TeamSpeakService.kt`
- [Service state](https://github.com/gamezad/ts3-mobile/blob/main/app/src/main/java/io/github/ts3mobile/app/service/TeamSpeakServiceState.kt): `app/src/main/java/io/github/ts3mobile/app/service/TeamSpeakServiceState.kt`
- [Reconnect policy](https://github.com/gamezad/ts3-mobile/blob/main/app/src/main/java/io/github/ts3mobile/app/service/ReconnectPolicy.kt): `app/src/main/java/io/github/ts3mobile/app/service/ReconnectPolicy.kt`

### TeamSpeak protocol

- [Session client API](https://github.com/gamezad/ts3-mobile/blob/main/ts3-protocol/src/main/kotlin/io/github/ts3mobile/protocol/Ts3SessionClient.kt): `ts3-protocol/src/main/kotlin/io/github/ts3mobile/protocol/Ts3SessionClient.kt`
- [ts3j adapter](https://github.com/gamezad/ts3-mobile/blob/main/ts3-protocol/src/main/kotlin/io/github/ts3mobile/protocol/Ts3jSessionClient.kt): `ts3-protocol/src/main/kotlin/io/github/ts3mobile/protocol/Ts3jSessionClient.kt`
- [Snapshot store](https://github.com/gamezad/ts3-mobile/blob/main/ts3-protocol/src/main/kotlin/io/github/ts3mobile/protocol/SessionSnapshotStore.kt): `ts3-protocol/src/main/kotlin/io/github/ts3mobile/protocol/SessionSnapshotStore.kt`
- [Channel ordering](https://github.com/gamezad/ts3-mobile/blob/main/ts3-protocol/src/main/kotlin/io/github/ts3mobile/protocol/ChannelTree.kt): `ts3-protocol/src/main/kotlin/io/github/ts3mobile/protocol/ChannelTree.kt`
- [Session models](https://github.com/gamezad/ts3-mobile/blob/main/ts3-protocol/src/main/kotlin/io/github/ts3mobile/protocol/Model.kt): `ts3-protocol/src/main/kotlin/io/github/ts3mobile/protocol/Model.kt`
- [Identity codec](https://github.com/gamezad/ts3-mobile/blob/main/ts3-protocol/src/main/kotlin/io/github/ts3mobile/protocol/Ts3IdentityCodec.kt): `ts3-protocol/src/main/kotlin/io/github/ts3mobile/protocol/Ts3IdentityCodec.kt`

### Voice audio

- [Audio routing](https://github.com/gamezad/ts3-mobile/blob/main/audio-opus/src/main/java/io/github/ts3mobile/audio/opus/AudioDeviceRouter.kt): `audio-opus/src/main/java/io/github/ts3mobile/audio/opus/AudioDeviceRouter.kt`
- [Voice playback](https://github.com/gamezad/ts3-mobile/blob/main/audio-opus/src/main/java/io/github/ts3mobile/audio/opus/OpusAudioPlayer.kt): `audio-opus/src/main/java/io/github/ts3mobile/audio/opus/OpusAudioPlayer.kt`
- [Opus decoder](https://github.com/gamezad/ts3-mobile/blob/main/audio-opus/src/main/java/io/github/ts3mobile/audio/opus/NativeOpusDecoder.kt): `audio-opus/src/main/java/io/github/ts3mobile/audio/opus/NativeOpusDecoder.kt`
- [Participant mixer](https://github.com/gamezad/ts3-mobile/blob/main/audio-opus/src/main/java/io/github/ts3mobile/audio/opus/ParticipantGainMixer.kt): `audio-opus/src/main/java/io/github/ts3mobile/audio/opus/ParticipantGainMixer.kt`
- [Microphone capture](https://github.com/gamezad/ts3-mobile/blob/main/audio-opus/src/main/java/io/github/ts3mobile/audio/opus/OpusMicrophoneCapture.kt): `audio-opus/src/main/java/io/github/ts3mobile/audio/opus/OpusMicrophoneCapture.kt`
- [Opus encoder](https://github.com/gamezad/ts3-mobile/blob/main/audio-opus/src/main/java/io/github/ts3mobile/audio/opus/NativeOpusEncoder.kt): `audio-opus/src/main/java/io/github/ts3mobile/audio/opus/NativeOpusEncoder.kt`
- [RNNoise processor](https://github.com/gamezad/ts3-mobile/blob/main/audio-opus/src/main/java/io/github/ts3mobile/audio/opus/NativeRnNoiseProcessor.kt): `audio-opus/src/main/java/io/github/ts3mobile/audio/opus/NativeRnNoiseProcessor.kt`

### Identity security

- [Identity vault](https://github.com/gamezad/ts3-mobile/blob/main/app/src/main/java/io/github/ts3mobile/app/identity/IdentityVault.kt): `app/src/main/java/io/github/ts3mobile/app/identity/IdentityVault.kt`

### Other components

- **User**
- **TeamSpeak server**

## Connections

- User → Activity: uses (evidence: `README.md`)
- Activity → Connection form: updates form (evidence: `app/src/main/java/io/github/ts3mobile/app/MainActivity.kt`)
- Activity → Main screen: renders (evidence: `app/src/main/java/io/github/ts3mobile/app/MainActivity.kt`)
- Activity → Foreground service: starts and binds (evidence: `app/src/main/java/io/github/ts3mobile/app/MainActivity.kt`)
- Main screen → Channel ordering: orders channels (evidence: `app/src/main/java/io/github/ts3mobile/app/ui/MainScreen.kt`)
- Foreground service → Service state: publishes state (evidence: `app/src/main/java/io/github/ts3mobile/app/service/TeamSpeakService.kt`)
- Foreground service → Reconnect policy: applies backoff (evidence: `app/src/main/java/io/github/ts3mobile/app/service/TeamSpeakService.kt`)
- Foreground service → Identity vault: loads identity (evidence: `app/src/main/java/io/github/ts3mobile/app/service/TeamSpeakService.kt`)
- Identity vault → Identity codec: generates identity (evidence: `app/src/main/java/io/github/ts3mobile/app/identity/IdentityVault.kt`)
- Foreground service → Session client API: controls session (evidence: `app/src/main/java/io/github/ts3mobile/app/service/TeamSpeakService.kt`)
- Session client API → ts3j adapter: implemented by (evidence: `ts3-protocol/src/main/kotlin/io/github/ts3mobile/protocol/Ts3jSessionClient.kt`)
- ts3j adapter → TeamSpeak server: connects and transmits (evidence: `README.md`)
- ts3j adapter → Snapshot store: updates and reads (evidence: `ts3-protocol/src/main/kotlin/io/github/ts3mobile/protocol/Ts3jSessionClient.kt`)
- ts3j adapter → Identity codec: uses identity (evidence: `ts3-protocol/src/main/kotlin/io/github/ts3mobile/protocol/Ts3jSessionClient.kt`)
- ts3j adapter → Session models: maps session data
- Main screen → Session models: displays roster
- Foreground service → Audio routing: controls routing (evidence: `app/src/main/java/io/github/ts3mobile/app/service/TeamSpeakService.kt`)
- Foreground service → Voice playback: controls playback (evidence: `app/src/main/java/io/github/ts3mobile/app/service/TeamSpeakService.kt`)
- ts3j adapter → Voice playback: delivers voice frames
- Voice playback → Opus decoder: decodes packets (evidence: `audio-opus/src/main/java/io/github/ts3mobile/audio/opus/OpusAudioPlayer.kt`)
- Voice playback → Participant mixer: applies participant gains (evidence: `audio-opus/src/main/java/io/github/ts3mobile/audio/opus/OpusAudioPlayer.kt`)
- Foreground service → Microphone capture: controls transmission (evidence: `app/src/main/java/io/github/ts3mobile/app/service/TeamSpeakService.kt`)
- Microphone capture → Opus encoder: encodes frames (evidence: `audio-opus/src/main/java/io/github/ts3mobile/audio/opus/OpusMicrophoneCapture.kt`)
- Microphone capture → RNNoise processor: denoises audio (evidence: `audio-opus/src/main/java/io/github/ts3mobile/audio/opus/OpusMicrophoneCapture.kt`)
- Microphone capture → Session client API: provides voice source
