Data

Tools

Indexes

Applications

Experiments

Awesome

An open API service indexing awesome lists of open source software.

https://github.com/mssoftjp/obsidian-voice-input

AI-powered high-accuracy voice input using OpenAI GPT-4o Transcribe API
https://github.com/mssoftjp/obsidian-voice-input

Last synced: 4 months ago
JSON representation

AI-powered high-accuracy voice input using OpenAI GPT-4o Transcribe API

Awesome Lists containing this project

README 

          
# Voice Input Plugin for Obsidian



Capture notes with high-accuracy multilingual voice input using OpenAI Speech-to-Text. Uses GPT-4o Audio Transcriptions (with tuned prompts for ja/en/zh/ko) and inserts into your notes with one click or push-to-talk.



## Features



- One‑click recording: start/stop from a microphone ribbon icon

- Push‑to‑talk: long‑press to record, release to stop

- Model selection: GPT‑4o Transcribe or GPT‑4o mini Transcribe

- Language separation: independent UI language and voice recognition language settings

- Language linking: voice recognition follows the UI locale (ja/en/zh/ko) with optional overrides

- AI post‑processing: optional dictionary-based cleanup (applied to all languages when enabled)

- Quick controls in view: copy/clear/insert at cursor/append to end

- Auto‑save drafts: periodic and on blur, automatic restore

- Multilingual support: Japanese, English, Chinese, Korean interface languages

- Voice activity detection modes: Off by default for maximum accuracy. Optional server-side chunking or local auto‑stop (requires fvad.wasm/fvad.js, installed manually)



## Requirements



- OpenAI API key (Audio Transcriptions)

- Internet connectivity

- Obsidian desktop (Windows/macOS). This plugin is desktop‑only.



Note: OpenAI usage is billed by API.



## Installation (manual)



1. Download the latest assets from Releases.

2. Copy `main.js`, `manifest.json`, and `styles.css` into `/.obsidian/plugins/voice-input/`.

3. Restart Obsidian and enable the plugin.



Compatibility: requires Obsidian 1.8.0 or later (per `minAppVersion`).



Local VAD (optional): this plugin does not ship the WebAssembly files. If you want local VAD auto‑stop, download `fvad.wasm` and `fvad.js` from the fvad‑wasm project and place them in the same plugin folder, or use the “Choose fvad.wasm / fvad.js…” button in Settings → Voice Activity Detection to copy them. The loader uses `fetch` only to read these local files—no external network requests are made. Local VAD is desktop‑only.



## Commands



- Open Voice Input (`open-view`): opens the Voice Input view. Assign a hotkey from Obsidian’s Settings → Hotkeys if desired.



## Usage



1) Open the view

- Click the microphone ribbon icon, or run “Open Voice Input”.



2) Record

- Click “Start Voice Input” to toggle recording, or use push‑to‑talk: long‑press the record button (starts after a short threshold), release to stop.



3) Use the result

- Copy, Insert at Cursor, or Append to End of the active note. Clear resets the area.



Tip: A settings gear in the view header opens the plugin’s settings.



## Settings



- OpenAI API Key: stored locally (encrypted at rest)

- Transcription Model: `gpt-4o-transcribe` or `gpt-4o-mini-transcribe`

- **Transcription Language**: Japanese/English/Chinese/Korean (defaults to the UI language when linking is enabled; advanced settings let you override per language)

- AI Post‑processing: enable dictionary‑based cleanup (applied to all languages when enabled)

- Maximum Recording Duration: slider (default 5 min)

- Plugin Language: Japanese/English/Chinese/Korean (controls UI display only, auto-detected from Obsidian, adjustable)

- Voice Activity Detection: choose Off (default, most accurate), Server (faster turnaround via upstream silence trimming), or Local (desktop auto‑stop; requires `fvad.wasm`/`fvad.js` installed manually)



### Drafts and sync



- The plugin periodically auto‑saves your in‑progress text as a draft under `/.obsidian/plugins/voice-input/draft.txt` and restores it when you reopen the view.

- Drafts are device‑local and are not synchronized by Obsidian Sync or other services. If you clear the text area, the draft is removed.



## Security & Privacy



- Processing in memory; audio is not written to disk by the plugin

- Audio you record is transmitted to OpenAI for transcription over HTTPS (via Obsidian’s `requestUrl`).

- API key is encrypted for storage



Note: When Electron SafeStorage is unavailable, the plugin falls back to lightweight obfuscation for the stored key; the plugin is desktop‑only by design.



See also OpenAI’s Privacy Policy.



## Troubleshooting



- Microphone not recognized: allow mic access and restart Obsidian

- Transcription fails: verify API key, connectivity, and OpenAI credit

- Quiet audio: move closer to the mic and reduce background noise



Third‑party licensing: see `THIRD_PARTY_LICENSES.md`.



—



# Voice Input Plugin for Obsidian（日本語）



高精度な多言語音声認識でメモを作成できるプラグインです。OpenAI GPT‑4o Audio Transcriptions を利用し、日・英・中・韓向けに調整したプロンプトで文字起こしを行います。



## 機能



- ワンクリック録音（リボンのマイクアイコン）

- プッシュトゥトーク（長押しで録音開始、離して停止）

- モデル選択（GPT‑4o Transcribe / GPT‑4o mini Transcribe）

- 言語設定の分離（UI言語と音声認識言語を独立設定）

- 言語リンク（UIロケールに合わせて音声認識言語を自動追従。高度設定で個別指定も可能）

- AI後処理（辞書ベースの補正。全言語に適用可能）

- ビュー内のクイック操作（コピー/クリア/カーソル位置へ挿入/末尾へ追記）

- 自動保存（定期保存とフォーカス外れ時）。再オープン時に自動復元

- 多言語サポート（日本語、英語、中国語、韓国語のインターフェース）

- VADモード選択（標準はオフ＝精度重視。必要に応じてサーバーVAD（応答を速めたい場合）や `fvad.wasm` / `fvad.js` を使ったローカルVAD（デスクトップの自動停止）を利用可能）



## 必要条件



- OpenAI APIキー（Audio Transcriptions）

- インターネット接続

- Obsidianデスクトップ版（Windows/macOS）。本プラグインはデスクトップ専用です。



※ OpenAI APIの利用には課金が発生します。



## インストール（手動）



1. Releases から最新版を取得

2. `main.js`、`manifest.json`、`styles.css` を `/.obsidian/plugins/voice-input/` に配置

3. `/.obsidian/plugins/voice-input/` に置く

4. Obsidianを再起動し、プラグインを有効化



ローカルVAD（任意）: 本プラグインは WebAssembly ファイルを同梱しません。ローカルVADの自動停止を使う場合、`fvad.wasm` と `fvad.js` を fvad‑wasm プロジェクトから取得して同じフォルダに配置するか、設定 → 音声区間検出 の「fvad.wasm / fvad.js を選択…」ボタンでコピーしてください。ローカルVADはデスクトップ専用です。



## コマンド



- Open Voice Input（`open-view`）: 音声入力ビューを開きます。必要に応じてホットキーを割り当ててください。



## 使い方



1) ビューを開く

- リボンのマイクアイコンをクリック、またはコマンドパレットから “Open Voice Input”。



2) 録音

- 「音声入力開始」でトグル録音、またはプッシュトゥトーク（ボタン長押しで短い閾値後に録音開始、指を離すと停止）。



3) 結果の利用

- コピー、カーソル位置へ挿入、末尾へ追記。クリアでテキストエリアを初期化。



ヒント: ビューのヘッダにある歯車ボタンから設定を開けます。



## 設定



- OpenAI APIキー: ローカルに暗号化して保存

- 文字起こしモデル: `gpt-4o-transcribe` または `gpt-4o-mini-transcribe`

- **音声認識言語**: 日本語/英語/中国語/韓国語（既定ではUI言語にリンクし、高度設定で個別指定が可能）

- AI後処理: 辞書ベースの補正（有効時は全言語に適用）

- 最大録音時間: スライダー（初期値5分）

- **プラグイン言語**: UI表示のみを制御。Obsidianの言語設定から自動検出（ja/zh/ko/en）。

- 音声区間検出 (VAD): オフ（標準・精度重視）、サーバー（応答を速めたい場合の無音カット）、ローカル（デスクトップの自動停止。`fvad.wasm`/`fvad.js` を手動導入）から選択



### ドラフトと同期



- 入力途中のテキストは定期的にドラフトとして `/.obsidian/plugins/voice-input/draft.txt` に保存され、ビュー再オープン時に復元されます。

- ドラフトは端末ローカルの一時保存であり、Obsidian Sync 等では同期されません。テキストエリアを空にするとドラフトは削除されます。



### 言語設定



- **プラグイン言語**: UI表示のみを制御。Obsidianの言語設定から自動検出（ja/zh/ko/en）。

- **音声認識言語**: 音声認識/文字起こしの言語。既定ではプラグイン言語にリンクし、高度設定で個別指定が可能。



#### 初期値の決定（Obsidianロケールに基づく）



- ja-* → 日本語

- zh-* → 中国語

- ko-* → 韓国語

- その他 → 英語



初回起動時およびリンク有効時は、このロケール判定に基づいて UI 言語と音声認識言語が同期されます。



#### 言語別の処理



- 日本語 (ja): 専用プロンプトを付与し、辞書補正（有効時）や言語別クリーンアップを適用

- 中国語/英語/韓国語 (zh/en/ko): 各言語向けプロンプトとクリーニングルールを適用

- 言語リンク有効時: UI 言語の変更に合わせてこれらの処理を自動的に切り替え



## セキュリティ / プライバシー



- 処理はメモリ内で行い、音声ファイルはプラグイン側でディスク保存しません

- 録音した音声は文字起こしのため OpenAI に送信され、HTTPS（Obsidian の `requestUrl` 経由）で通信します。

- APIキーは保存時に暗号化



補足: Electron の SafeStorage が利用できない環境では保存キーを軽度に難読化して保持します（本プラグインはデスクトップ専用の設計です）。



OpenAIのプライバシーポリシーもご参照ください。



## トラブルシューティング



- マイクが認識されない: マイク許可の付与、Obsidianの再起動

- 文字起こしに失敗: APIキー、通信、OpenAIクレジット残高を確認

- 音量が小さい/雑音が多い: マイクに近づく、静かな環境で録音



サードパーティライセンスは `THIRD_PARTY_LICENSES.md` を参照してください。



## ライセンス



MIT License - 詳細は[LICENSE](LICENSE)ファイルをご確認ください。



詳細なライセンス情報については [THIRD_PARTY_LICENSES.md](THIRD_PARTY_LICENSES.md) をご覧ください。



## 作者



**Musashino Software**



- GitHub: [@mssoftjp](https://github.com/mssoftjp)

- 支援: [Buy Me a Coffee](https://buymeacoffee.com/mssoft)



## 貢献



バグ報告や機能要望は[Issues](https://github.com/mssoftjp/obsidian-voice-input/issues)でお願いします。