Reference on ApplauseLab

API Reference

Mon, 01 Jan 0001 00:00:00 +0000

Yap exposes Go methods to the React frontend via Wails bindings. This reference documents all available methods.

State Management

GetState

Get the current application state.

import { GetState } from '../wailsjs/go/main/App';

const state = await GetState();

Returns: AppState

interface AppState {
 state: 'ready' | 'recording' | 'transcribing' | 'error';
 recordingTime: number; // Duration in seconds
 lastTranscript: string; // Most recent transcription
 error: string; // Error message if state is 'error'
 currentModel: string; // Active model name
 currentProvider: string; // 'local' or 'openai'
 modelReady: boolean; // Whether model is ready
 hotkeyEnabled: boolean; // Whether hotkey is active
}

Recording

ToggleRecording

Start or stop recording based on current state.

Configuration

Mon, 01 Jan 0001 00:00:00 +0000

Configuration File

Yap stores settings in a JSON configuration file:

Location:

macOS: ~/Library/Application Support/yap/config.json
Windows: %APPDATA%\yap\config.json
Linux: ~/.config/yap/config.json

Configuration Options

provider

Transcription provider to use.

Value	Description
`"local"`	Use whisper.cpp (default)
`"openai"`	Use OpenAI Whisper API

{
 "provider": "local"
}

model

Active Whisper model for local transcription.

Value	Size	Notes
`"tiny"`	~75 MB	Fastest, multilingual
`"tiny.en"`	~75 MB	Fastest, English-only
`"base"`	~150 MB	Good balance, multilingual
`"base.en"`	~150 MB	Good balance, English-only (default)
`"small"`	~500 MB	Better accuracy, multilingual
`"small.en"`	~500 MB	Better accuracy, English-only
`"medium"`	~1.5 GB	High accuracy, multilingual
`"medium.en"`	~1.5 GB	High accuracy, English-only
`"large-v3"`	~3 GB	Highest accuracy, multilingual

{
 "model": "base.en"
}

openaiApiKey

API key for OpenAI Whisper (required for cloud provider).

Troubleshooting

Tue, 18 Aug 2026 00:00:00 +0000

Recording Issues

Hotkey Not Working

Symptoms:

Pressing the hotkey does nothing
No recording overlay appears

Solutions:

Check Accessibility permissions (macOS)
- Go to System Settings → Privacy & Security → Accessibility
- Ensure Yap is enabled
- Try removing and re-adding if already enabled
Try a different hotkey
- Go to Settings → Recording Hotkey
- Select an alternative (Left Option, Fn, or Double-tap)
Check for conflicts
- Other apps may be capturing the hotkey
- Try quitting other apps that use global hotkeys
Restart Yap

FAQ

Mon, 01 Jan 0001 00:00:00 +0000

General

What is Yap?

Yap is a desktop speech-to-text application. Press a hotkey, speak, and your words are transcribed and pasted into any application.

Is it free?

Yes. Yap is free and open source under the MIT license.

What platforms are supported?

macOS: Apple Silicon (native) and Intel (via Rosetta)
Windows: Windows 10/11 (x64)
Linux: AppImage and DEB packages

Does it work offline?

Yes, when using local transcription with whisper.cpp. Models are downloaded once and work entirely offline.