Files
hearbit-ai-app/README.md
2026-01-19 17:30:05 +01:00

95 lines
3.5 KiB
Markdown

# Hearbit AI 🦉🎙️
Hearbit AI is a powerful macOS desktop application designed to record system and microphone audio, transcribe it using Infomaniak's Whisper API, and generate intelligent AI summaries.
## Features
* **Dual-Channel Recording**: Capture both your microphone (e.g., for voice notes) and system audio (e.g., for meetings) simultaneously.
* **Powered by Infomaniak AI**:
* **Transcription**: High-accuracy speech-to-text using Infomaniak's Whisper integration.
* **Summarization**: Generate concise summaries, action items, or meeting notes using models like Mixtral or Llama 3 via Infomaniak's LLM API.
* **Auto-Save**: Recordings and summaries are automatically saved to a persistent history.
* **Customizable Prompts**: Define your own AI templates (e.g., "Summarize", "Extract Action Items", "Translate").
* **Privacy-Focused**: Processed securily via your own Infomaniak API keys.
## prerequisites
* **macOS** (Apple Silicon or Intel)
* **Infomaniak AI Account**: You need an API Key and Product ID from [Infomaniak's Developer Portal](https://manager.infomaniak.com/).
## Installation
1. Download the latest release (`.dmg` or `.app`).
## Recording System Audio (Teams, Zoom, etc.)
To record meetings from apps like Microsoft Teams, Zoom, or Google Meet, you need to route the computer's audio into Hearbit AI. This requires **BlackHole 2ch**.
### 1. Install BlackHole
1. Download and install [BlackHole 2ch](https://existential.audio/blackhole/).
2. Restart your computer if required.
### 2. Create a Multi-Output Device (To hear audio while recording)
1. Open **Audio MIDI Setup** (search in Spotlight).
2. Click the `+` icon and select **Create Multi-Output Device**.
3. Check **BlackHole 2ch** AND **MacBook Pro Speakers** (or your headphones).
4. Set "Master Device" to **BlackHole 2ch**.
![Multi-Output Setup](docs/screenshots/multi_output_setup.png)
### 3. Create an Aggregate Device (For Hearbit AI Input)
1. In Audio MIDI Setup, click `+` and select **Create Aggregate Device**.
2. Name it "Hearbit-AI" (or similar).
3. Check **BlackHole 2ch** AND **MacBook Pro Microphone**.
4. Ensure "Drift Correction" is enabled for the Microphone.
![Aggregate Device Setup](docs/screenshots/aggregate_device_setup.png)
### 4. Setup in Hearbit AI
1. Open **Hearbit AI**.
2. In the **Input Device** dropdown, select your Aggregate Device (e.g., "Hearbit-AI").
3. Start Recording.
### 5. Setup in Teams/Zoom
* Set your **Speaker** output in Teams/Zoom to the **Multi-Output Device** you created in Step 2.
1. **Configure**:
* Click the **Settings** (gear icon) in the top right.
* Enter your **Infomaniak API Key** and **Product ID**.
* (Optional) Customize your AI prompts.
2. **Record**:
* Select your **Input Device** (e.g., "MacBook Pro Microphone" or an aggregate device for system audio).
* Select an **LLM Model** (e.g., Mixtral).
* Click **Start Recording**.
3. **Process**:
* Click **Stop Recording**.
* The app will automatically upload, transcribe, and summarize your audio.
4. **History**:
* Click **Records** to view past recordings.
## Development
This app is built with **Tauri**, **React**, and **TypeScript**.
### Setup
```bash
npm install
```
### Run Locally
```bash
npm run dev
# OR
npm run tauri dev
```
### Build for Production
```bash
npm run tauri build
```
## Icons
The app uses a custom generated icon set located in `src-tauri/icons`.
## License
[License Name]