# aitum/obs-aitum-multistream architecture

> Architecture diagram of the GitHub repository aitum/obs-aitum-multistream, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-01-11). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/aitum/obs-aitum-multistream
- Repository: https://github.com/aitum/obs-aitum-multistream

## Overview

##### Main Components

a. Core Plugin Components:
- Sub-components for:
- Configuration Dialog (config-dialog.cpp)
- Output Dialog (output-dialog.cpp)
- Stream Key Input (stream-key-input.cpp)
- Multistream Handler (multistream.cpp)
- File Updater (file-updater.c)

b. External Dependencies:
- OBS Studio Core (show as an external system)
- Aitum Services (show as a cloud service)

c. Resource Components:
- Localization System (data/locale)
- Configuration Storage
- Resource Management (resources.qrc)

##### Interaction Flows

- OBS Studio ↔ Plugin Interface
- Plugin ↔ Aitum Services
- Configuration Dialog ↔ Config Utils
- Output Dialog ↔ Multistream Handler
- File Updater ↔ External Updates

##### Architectural Patterns to Highlight

- Frontend Integration Pattern (as it's a UI/frontend plugin)
- Event-Driven Architecture (for stream handling)
- Resource Management Pattern (for translations and configs)

##### Technical Details

- Qt Framework integration (evident from .qrc files)
- Multi-platform support (shown by cmake/windows, cmake/linux, cmake/macos)
- Build system integration points

**[OBS Studio Core]**
- ↕
**[Aitum Multistream Plugin]**
- ↙     ↓     ↘
**[UI Layer] [Core] [Services]**

**[Config]  [Stream]  [Aitum API]**

**[Resources]--+--------+**

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Main Components
    OBS[OBS Studio Core]
    AMP[Aitum Multistream Plugin]:::core
    AS[Aitum Services]:::external

    %% Core Components
    subgraph Plugin["Plugin Core"]
        MH[Multistream Handler]:::core
        FU[File Updater]:::core
        CU[Configuration Utils]:::core
    end

    %% UI Components
    subgraph Interface["User Interface"]
        CD[Configuration Dialog]:::ui
        OD[Output Dialog]:::ui
        SKI[Stream Key Input]:::ui
    end

    %% Resource Components
    subgraph Resources["Resource Management"]
        LS[Localization System]:::resource
        RM[Resource Manager]:::resource
        CS[Configuration Storage]:::resource
    end

    %% Build System
    subgraph BuildSystem["Build Configuration"]
        BC[Build Config]:::build
        WB[Windows Build]:::build
        LB[Linux Build]:::build
        MB[MacOS Build]:::build
        CBU[Common Build Utils]:::build
        VC[Version Control]:::build
    end

    %% Relationships
    OBS <--> AMP
    AMP <--> AS
    AMP --> Plugin
    AMP --> Interface
    AMP --> Resources

    MH <--> CD
    MH <--> OD
    MH <--> SKI
    CU <--> CS
    FU <--> AS

    CD <--> CU
    OD <--> CU
    SKI <--> CU

    LS --> RM
    CS --> RM

    %% Build System Relationships
    BC --> WB
    BC --> LB
    BC --> MB
    BC --> CBU
    BC --> VC

    %% Click Events
    click CD "https://github.com/Aitum/obs-aitum-multistream/blob/main/config-dialog.cpp"
    click OD "https://github.com/Aitum/obs-aitum-multistream/blob/main/output-dialog.cpp"
    click SKI "https://github.com/Aitum/obs-aitum-multistream/blob/main/stream-key-input.cpp"
    click MH "https://github.com/Aitum/obs-aitum-multistream/blob/main/multistream.cpp"
    click FU "https://github.com/Aitum/obs-aitum-multistream/blob/main/file-updater.c"
    click CU "https://github.com/Aitum/obs-aitum-multistream/blob/main/config-utils.cpp"
    click LS "https://github.com/Aitum/obs-aitum-multistream/tree/main/data/locale"
    click RM "https://github.com/Aitum/obs-aitum-multistream/blob/main/resources.qrc"
    click WB "https://github.com/Aitum/obs-aitum-multistream/tree/main/cmake/windows"
    click LB "https://github.com/Aitum/obs-aitum-multistream/tree/main/cmake/linux"
    click MB "https://github.com/Aitum/obs-aitum-multistream/tree/main/cmake/macos"
    click CBU "https://github.com/Aitum/obs-aitum-multistream/tree/main/cmake/common"
    click BC "https://github.com/Aitum/obs-aitum-multistream/blob/main/CMakeLists.txt"
    click VC "https://github.com/Aitum/obs-aitum-multistream/blob/main/version.h.in"

    %% Styles
    classDef core fill:#2374ab
    classDef external fill:#57a773
    classDef ui fill:#ffd166
    classDef resource fill:#ef767a
    classDef build fill:#7d7abc

    %% Legend
    subgraph Legend
        C[Core Components]:::core
        E[External Services]:::external
        U[User Interface]:::ui
        R[Resources]:::resource
        B[Build System]:::build
    end
```
