# jonataslaw/videocompress architecture

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

- Interactive diagram: https://gitdiagram.com/jonataslaw/videocompress
- Repository: https://github.com/jonataslaw/videocompress

## Overview

video_compress is a Flutter plugin for native video compression and related media utilities on Android, iOS, and macOS. The user-facing workflow requests compression, thumbnails, media information, cache cleanup, or progress through the Dart API; native platform code performs the media work and returns results. The README documents the capabilities, while excerpts show the iOS/macOS method-channel handlers and their use of AVFoundation controllers and utilities. Dart and Android implementation details were not sampled, so their internal links are omitted.

Main entry points: [`lib/video_compress.dart`](https://github.com/jonataslaw/videocompress/blob/master/lib/video_compress.dart) (VideoCompress API), [`ios/Classes/SwiftVideoCompressPlugin.swift`](https://github.com/jonataslaw/videocompress/blob/master/ios/Classes/SwiftVideoCompressPlugin.swift) (iOS method handler), [`macos/Classes/VideoCompressPlugin.swift`](https://github.com/jonataslaw/videocompress/blob/master/macos/Classes/VideoCompressPlugin.swift) (macOS method handler), [`lib/src/progress_callback/compress_mixin.dart`](https://github.com/jonataslaw/videocompress/blob/master/lib/src/progress_callback/compress_mixin.dart) (Progress callbacks)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_dart["Dart API"]
  node_dart_api["VideoCompress API"]
  node_compressor["Video compressor"]
  node_quality["Quality options<br/>[video_quality.dart]"]
  node_media_info["Media models<br/>[media_info.dart]"]
  node_media_data["Media data<br/>[media_data.dart]"]
  node_progress["Progress callbacks"]
  node_subscription["Progress subscription<br/>[subscription.dart]"]
end

subgraph group_android["Android Native"]
  node_android_plugin["Android plugin"]
  node_android_utility["Android utilities<br/>[Utility.kt]"]
  node_android_thumbnail["Thumbnail utility"]
end

subgraph group_ios["iOS Native"]
  node_ios_plugin["iOS method handler"]
  node_ios_controller["AV controller<br/>[AvController.swift]"]
  node_ios_utility["iOS utilities<br/>[Utility.swift]"]
end

subgraph group_macos["macOS Native"]
  node_mac_plugin["macOS method handler"]
  node_mac_controller["AV controller<br/>[AvController.swift]"]
  node_mac_utility["macOS utilities<br/>[Utility.swift]"]
end

node_client(("Flutter app"))

node_client -->|"uses"| node_dart_api
node_dart_api -->|"compresses media"| node_compressor
node_dart_api -->|"selects quality"| node_quality
node_dart_api -->|"returns media info"| node_media_info
node_dart_api -->|"exposes progress"| node_progress
node_progress -->|"supports listening"| node_subscription
node_ios_plugin -->|"reads assets"| node_ios_controller
node_ios_plugin -->|"uses file helpers"| node_ios_utility
node_mac_plugin -->|"reads assets"| node_mac_controller
node_mac_plugin -->|"uses file helpers"| node_mac_utility

click node_dart_api "https://github.com/jonataslaw/videocompress/blob/master/lib/video_compress.dart"
click node_compressor "https://github.com/jonataslaw/videocompress/blob/master/lib/src/video_compress/video_compressor.dart"
click node_quality "https://github.com/jonataslaw/videocompress/blob/master/lib/src/video_compress/video_quality.dart"
click node_media_info "https://github.com/jonataslaw/videocompress/blob/master/lib/src/media/media_info.dart"
click node_media_data "https://github.com/jonataslaw/videocompress/blob/master/lib/src/media/media_data.dart"
click node_progress "https://github.com/jonataslaw/videocompress/blob/master/lib/src/progress_callback/compress_mixin.dart"
click node_subscription "https://github.com/jonataslaw/videocompress/blob/master/lib/src/progress_callback/subscription.dart"
click node_android_plugin "https://github.com/jonataslaw/videocompress/blob/master/android/src/main/kotlin/com/example/video_compress/VideoCompressPlugin.kt"
click node_android_utility "https://github.com/jonataslaw/videocompress/blob/master/android/src/main/kotlin/com/example/video_compress/Utility.kt"
click node_android_thumbnail "https://github.com/jonataslaw/videocompress/blob/master/android/src/main/kotlin/com/example/video_compress/ThumbnailUtility.kt"
click node_ios_plugin "https://github.com/jonataslaw/videocompress/blob/master/ios/Classes/SwiftVideoCompressPlugin.swift"
click node_ios_controller "https://github.com/jonataslaw/videocompress/blob/master/ios/Classes/AvController.swift"
click node_ios_utility "https://github.com/jonataslaw/videocompress/blob/master/ios/Classes/Utility.swift"
click node_mac_plugin "https://github.com/jonataslaw/videocompress/blob/master/macos/Classes/VideoCompressPlugin.swift"
click node_mac_controller "https://github.com/jonataslaw/videocompress/blob/master/macos/Classes/AvController.swift"
click node_mac_utility "https://github.com/jonataslaw/videocompress/blob/master/macos/Classes/Utility.swift"

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_dart_api,node_compressor,node_quality,node_media_info,node_media_data,node_progress,node_subscription toneBlue
class node_android_plugin,node_android_utility,node_android_thumbnail toneAmber
class node_ios_plugin,node_ios_controller,node_ios_utility toneMint
class node_mac_plugin,node_mac_controller,node_mac_utility toneRose
class node_client toneIndigo
```

## Components

### Dart API

- [VideoCompress API](https://github.com/jonataslaw/videocompress/blob/master/lib/video_compress.dart): `lib/video_compress.dart`
- [Video compressor](https://github.com/jonataslaw/videocompress/blob/master/lib/src/video_compress/video_compressor.dart): `lib/src/video_compress/video_compressor.dart`
- [Quality options](https://github.com/jonataslaw/videocompress/blob/master/lib/src/video_compress/video_quality.dart): `lib/src/video_compress/video_quality.dart`
- [Media models](https://github.com/jonataslaw/videocompress/blob/master/lib/src/media/media_info.dart): `lib/src/media/media_info.dart`
- [Media data](https://github.com/jonataslaw/videocompress/blob/master/lib/src/media/media_data.dart): `lib/src/media/media_data.dart`
- [Progress callbacks](https://github.com/jonataslaw/videocompress/blob/master/lib/src/progress_callback/compress_mixin.dart): `lib/src/progress_callback/compress_mixin.dart`
- [Progress subscription](https://github.com/jonataslaw/videocompress/blob/master/lib/src/progress_callback/subscription.dart): `lib/src/progress_callback/subscription.dart`

### Android Native

- [Android plugin](https://github.com/jonataslaw/videocompress/blob/master/android/src/main/kotlin/com/example/video_compress/VideoCompressPlugin.kt): `android/src/main/kotlin/com/example/video_compress/VideoCompressPlugin.kt`
- [Android utilities](https://github.com/jonataslaw/videocompress/blob/master/android/src/main/kotlin/com/example/video_compress/Utility.kt): `android/src/main/kotlin/com/example/video_compress/Utility.kt`
- [Thumbnail utility](https://github.com/jonataslaw/videocompress/blob/master/android/src/main/kotlin/com/example/video_compress/ThumbnailUtility.kt): `android/src/main/kotlin/com/example/video_compress/ThumbnailUtility.kt`

### iOS Native

- [iOS method handler](https://github.com/jonataslaw/videocompress/blob/master/ios/Classes/SwiftVideoCompressPlugin.swift): `ios/Classes/SwiftVideoCompressPlugin.swift`
- [AV controller](https://github.com/jonataslaw/videocompress/blob/master/ios/Classes/AvController.swift): `ios/Classes/AvController.swift`
- [iOS utilities](https://github.com/jonataslaw/videocompress/blob/master/ios/Classes/Utility.swift): `ios/Classes/Utility.swift`

### macOS Native

- [macOS method handler](https://github.com/jonataslaw/videocompress/blob/master/macos/Classes/VideoCompressPlugin.swift): `macos/Classes/VideoCompressPlugin.swift`
- [AV controller](https://github.com/jonataslaw/videocompress/blob/master/macos/Classes/AvController.swift): `macos/Classes/AvController.swift`
- [macOS utilities](https://github.com/jonataslaw/videocompress/blob/master/macos/Classes/Utility.swift): `macos/Classes/Utility.swift`

### Other components

- **Flutter app**

## Connections

- Flutter app → VideoCompress API: uses (evidence: `README.md`)
- VideoCompress API → Video compressor: compresses media (evidence: `README.md`)
- VideoCompress API → Quality options: selects quality (evidence: `README.md`)
- VideoCompress API → Media models: returns media info (evidence: `README.md`)
- VideoCompress API → Progress callbacks: exposes progress (evidence: `README.md`)
- Progress callbacks → Progress subscription: supports listening (evidence: `README.md`)
- iOS method handler → AV controller: reads assets (evidence: `ios/Classes/SwiftVideoCompressPlugin.swift`)
- iOS method handler → iOS utilities: uses file helpers (evidence: `ios/Classes/SwiftVideoCompressPlugin.swift`)
- macOS method handler → AV controller: reads assets (evidence: `macos/Classes/VideoCompressPlugin.swift`)
- macOS method handler → macOS utilities: uses file helpers (evidence: `macos/Classes/VideoCompressPlugin.swift`)
