# indiaolx/media-picker-android architecture

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

- Interactive diagram: https://gitdiagram.com/indiaolx/media-picker-android
- Repository: https://github.com/indiaolx/media-picker-android

## Overview

##### Project Type & Purpose
- Two Gradle modules:
– “mediapicker”: a reusable Android library exposing a gallery-style media picker.
– “app”: a sample Android application demonstrating library usage.
- Purpose: scan device media (photos/videos), apply validation rules, and display in a carousel/grid UI.

##### File Structure
- Top-level:
– settings.gradle, build scripts, jitpack.yml.
– Modules: “mediapicker” (library) and “app” (sample app).
- “mediapicker/src/main/java/com/mediapicker/gallery”:
– domain (entities, actions, contracts, repositories)
– data (repository implementations, GalleryService)
– presentation (activities, fragments, adapters, viewmodels, factories, utils)
- “app/src/main/java/com/mediapicker/sample”:
– MainActivity, DemoHomeFragment, StepFragment – sample UI.

##### Key Architecture Patterns
- MVVM (ViewModels in presentation → domain/repositories → data/service → Android MediaStore).
- Clean-separation: UI (Activities/Fragments) vs. Presentation (ViewModel) vs. Domain (contracts/entities) vs. Data (GalleryService).
- Consumer-provider: the library exposes Gallery.init(config) and GalleryCommunicator to return selected media.

##### Main Components
a. Sample App UI
– MainActivity / DemoHomeFragment / StepFragment
– Invokes library via Gallery.init() and GalleryActivity / HomeFragment from library.
b. Library UI Bridge
– GalleryActivity, FolderViewActivity, HomeFragment, PhotoGridFragment, VideoGridFragment, PhotoCarousalFragment
– Adapters & custom Views (MediaGalleryViewPager, CarousalView, etc.)
c. Presentation Layer (MVVM)
– ViewModels (BridgeViewModel, HomeViewModel, LoadAlbumViewModel, LoadPhotoViewModel, LoadVideoViewModel)
– ViewModelFactory
d. Domain Layer
– Contracts (GalleryCommunicator, OnItemClickListener)
– Entities (Photo, PhotoAlbum, MediaGalleryEntity, Validation, RuleAction, etc.)
– Repositories interface (GalleryRepository)
e. Data Layer
– GalleryService (implements repository, queries Android MediaStore via ContentResolver)
f. External/System Dependencies
– Android Framework (Activities, Fragments, ViewModelProviders)
– MediaStore / ContentResolver
– FileProvider (for camera URIs)
– Device file system (camera photos/videos)
– JitPack / Gradle (build & distribution)

##### Interactions & Data Flow
- Startup:
Sample App → calls Gallery.init(GalleryConfig) → config stored in library core.
- Launch:
Sample App → launches GalleryActivity or injects HomeFragment.
- UI Event:
User taps media → Fragment → ViewModel receives event → consults validation/rules.
- Data Query:
ViewModel → GalleryRepository (contract) → GalleryService → Android MediaStore → returns media list.
- UI Rendering:
Data returned to ViewModel → LiveData/observers → Adapters populate RecyclerViews/ViewPager.
- Selection:
Selected items communicated back via GalleryCommunicator callback to Sample App.

##### Essential Elements
– Clear labels: e.g., “GalleryActivity (UI)”, “LoadPhotoViewModel”, “GalleryService”.
– Component groupings: package boundaries (com.mediapicker.gallery.presentation, etc.).

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Sample App Module
    subgraph "Sample App Module"
        direction TB
        MA["MainActivity"]:::ui
        DHF["DemoHomeFragment"]:::ui
        SF["StepFragment"]:::ui
    end

    %% Library Core
    subgraph "Library Core"
        direction TB
        GInit["Gallery.init(GalleryConfig)"]:::core
        GConfig["GalleryConfig Builder"]:::core
    end

    %% Library UI Layer
    subgraph "Library UI Layer"
        direction TB
        BFA["BaseFragmentActivity"]:::ui
        GA["GalleryActivity"]:::ui
        FVA["FolderViewActivity"]:::ui
        MGA["MediaGalleryActivity"]:::ui
        HF["HomeFragment"]:::ui
        PGF["PhotoGridFragment"]:::ui
        VGF["VideoGridFragment"]:::ui
        PCF["PhotoCarousalFragment"]:::ui
        FVF["FolderViewFragment"]:::ui
        GPVF["GalleryPhotoViewFragment"]:::ui
    end

    %% Presentation Layer
    subgraph "Presentation Layer"
        direction TB
        BVM["BridgeViewModel"]:::presentation
        HVM["HomeViewModel"]:::presentation
        LAVM["LoadAlbumViewModel"]:::presentation
        LPVM["LoadPhotoViewModel"]:::presentation
        LVM["LoadVideoViewModel"]:::presentation
        VMF["ViewModelFactory"]:::presentation
    end

    %% Domain Layer
    subgraph "Domain Layer"
        direction TB
        GCCom["GalleryCommunicator"]:::domain
        OIC["OnItemClickListener"]:::domain
        GR["GalleryRepository"]:::domain
        RA["RuleAction"]:::domain
        MGE["MediaGalleryEntity"]:::domain
        PhE["Photo"]:::domain
        PA["PhotoAlbum"]:::domain
        VE["Validation"]:::domain
        ODE["OtherDomainEntities"]:::domain
    end

    %% Data Layer
    subgraph "Data Layer"
        direction TB
        GS["GalleryService"]:::data
    end

    %% External Dependencies
    subgraph "External Dependencies"
        direction TB
        FP["FileProvider paths"]:::external
        AM["AndroidManifest entries"]:::external
        AF["Android Framework"]:::external
        MS["MediaStore / ContentResolver"]:::external
        DS["Device Storage"]:::external
    end

    %% Flows
    MA -->|calls init| GInit
    DHF -->|calls init| GInit
    SF -->|calls init| GInit
    GInit -->|builds config| GConfig
    GInit -->|launch| GA
    GA -->|uses| HF
    GA -->|extends| BFA
    HF -->|navigates to| PGF
    HF -->|navigates to| VGF
    HF -->|navigates to| PCF
    HF -->|navigates to| FVF
    HF -->|navigates to| GPVF
    GA -->|injects| BVM

    %% Presentation to Domain to Data
    BVM -->|uses| GR
    HVM -->|uses| GR
    LAVM -->|uses| GR
    LPVM -->|uses| GR
    LVM -->|uses| GR
    VMF -->|creates| BVM
    VMF -->|creates| HVM

    GR -->|implemented by| GS
    GS -->|queries| MS
    GS -->|reads| FP
    MS -->|retrieves from| DS

    %% Data return (dotted)
    GS -.->|onMediaLoaded| BVM
    BVM -.->|update LiveData| HF
    HF -.->|render| HF

    %% Domain contracts & entities connections
    GCCom -->|callback| MA
    OIC -->|callback| GPVF
    VE -->|validates| PhE
    RA -->|applies| VE

    %% External usage
    AF -->|provides| BFA
    AF -->|provides| VMF

    %% Click Events
    click MA "https://github.com/indiaolx/media-picker-android/blob/master/app/src/main/java/com/mediapicker/sample/MainActivity.kt"
    click DHF "https://github.com/indiaolx/media-picker-android/blob/master/app/src/main/java/com/mediapicker/sample/DemoHomeFragment.kt"
    click SF "https://github.com/indiaolx/media-picker-android/blob/master/app/src/main/java/com/mediapicker/sample/StepFragment.kt"
    click GInit "https://github.com/indiaolx/media-picker-android/blob/master/mediapicker/src/main/java/com/mediapicker/gallery/Gallery.kt"
    click GConfig "https://github.com/indiaolx/media-picker-android/blob/master/mediapicker/src/main/java/com/mediapicker/gallery/GalleryConfig.kt"
    click GA "https://github.com/indiaolx/media-picker-android/blob/master/mediapicker/src/main/java/com/mediapicker/gallery/presentation/activity/GalleryActivity.kt"
    click FVA "https://github.com/indiaolx/media-picker-android/blob/master/mediapicker/src/main/java/com/mediapicker/gallery/presentation/activity/FolderViewActivity.kt"
    click MGA "https://github.com/indiaolx/media-picker-android/blob/master/mediapicker/src/main/java/com/mediapicker/gallery/presentation/activity/MediaGalleryActivity.kt"
    click BFA "https://github.com/indiaolx/media-picker-android/blob/master/mediapicker/src/main/java/com/mediapicker/gallery/presentation/activity/BaseFragmentActivity.kt"
    click HF "https://github.com/indiaolx/media-picker-android/blob/master/mediapicker/src/main/java/com/mediapicker/gallery/presentation/fragments/HomeFragment.kt"
    click PGF "https://github.com/indiaolx/media-picker-android/blob/master/mediapicker/src/main/java/com/mediapicker/gallery/presentation/fragments/PhotoGridFragment.kt"
    click VGF "https://github.com/indiaolx/media-picker-android/blob/master/mediapicker/src/main/java/com/mediapicker/gallery/presentation/fragments/VideoGridFragment.kt"
    click PCF "https://github.com/indiaolx/media-picker-android/blob/master/mediapicker/src/main/java/com/mediapicker/gallery/presentation/fragments/PhotoCarousalFragment.kt"
    click FVF "https://github.com/indiaolx/media-picker-android/blob/master/mediapicker/src/main/java/com/mediapicker/gallery/presentation/fragments/FolderViewFragment.kt"
    click GPVF "https://github.com/indiaolx/media-picker-android/blob/master/mediapicker/src/main/java/com/mediapicker/gallery/presentation/fragments/GalleryPhotoViewFragment.kt"
    click BVM "https://github.com/indiaolx/media-picker-android/blob/master/mediapicker/src/main/java/com/mediapicker/gallery/presentation/viewmodels/BridgeViewModel.kt"
    click HVM "https://github.com/indiaolx/media-picker-android/blob/master/mediapicker/src/main/java/com/mediapicker/gallery/presentation/viewmodels/HomeViewModel.kt"
    click LAVM "https://github.com/indiaolx/media-picker-android/blob/master/mediapicker/src/main/java/com/mediapicker/gallery/presentation/viewmodels/LoadAlbumViewModel.kt"
    click LPVM "https://github.com/indiaolx/media-picker-android/blob/master/mediapicker/src/main/java/com/mediapicker/gallery/presentation/viewmodels/LoadPhotoViewModel.kt"
    click LVM "https://github.com/indiaolx/media-picker-android/blob/master/mediapicker/src/main/java/com/mediapicker/gallery/presentation/viewmodels/LoadVideoViewModel.kt"
    click VMF "https://github.com/indiaolx/media-picker-android/blob/master/mediapicker/src/main/java/com/mediapicker/gallery/presentation/viewmodels/factory/BaseViewModelFactory.kt"
    click GCCom "https://github.com/indiaolx/media-picker-android/blob/master/mediapicker/src/main/java/com/mediapicker/gallery/domain/contract/GalleryCommunicator.kt"
    click OIC "https://github.com/indiaolx/media-picker-android/blob/master/mediapicker/src/main/java/com/mediapicker/gallery/domain/contract/OnItemClickListener.kt"
    click GR "https://github.com/indiaolx/media-picker-android/blob/master/mediapicker/src/main/java/com/mediapicker/gallery/domain/repositories/GalleryRepository.kt"
    click RA "https://github.com/indiaolx/media-picker-android/blob/master/mediapicker/src/main/java/com/mediapicker/gallery/domain/action/RuleAction.kt"
    click MGE "https://github.com/indiaolx/media-picker-android/blob/master/mediapicker/src/main/java/com/mediapicker/gallery/domain/entity/MediaGalleryEntity.kt"
    click PhE "https://github.com/indiaolx/media-picker-android/blob/master/mediapicker/src/main/java/com/mediapicker/gallery/domain/entity/Photo.kt"
    click PA "https://github.com/indiaolx/media-picker-android/blob/master/mediapicker/src/main/java/com/mediapicker/gallery/domain/entity/PhotoAlbum.kt"
    click VE "https://github.com/indiaolx/media-picker-android/blob/master/mediapicker/src/main/java/com/mediapicker/gallery/domain/entity/Validation.kt"
    click GS "https://github.com/indiaolx/media-picker-android/blob/master/mediapicker/src/main/java/com/mediapicker/gallery/data/repositories/GalleryService.kt"
    click FP "https://github.com/indiaolx/media-picker-android/blob/master/mediapicker/src/main/res/xml/provider_paths.xml"
    click AM "https://github.com/indiaolx/media-picker-android/blob/master/mediapicker/src/main/AndroidManifest.xml"

    %% Styles
    classDef ui fill:#ADD8E6,stroke:#333,stroke-width:1px
    classDef presentation fill:#90EE90,stroke:#333,stroke-width:1px
    classDef domain fill:#FFFF99,stroke:#333,stroke-width:1px
    classDef data fill:#FFD580,stroke:#333,stroke-width:1px
    classDef external fill:#D3D3D3,stroke:#333,stroke-width:1px
    classDef core fill:#E0FFFF,stroke:#333,stroke-width:1px
```
