Skip to main content
Settings commands handle application configuration, including hotkeys, models, audio devices, and UI preferences.

Settings Management

get_settings

Retrieve current application settings.
Returns: Complete settings object Usage:

save_settings

Save updated application settings.
Settings
required
Complete settings object to save
Usage:
Side Effects:
  1. Model Change: Preloads new model and updates tray menu
  2. Recording Mode Change: Updates PTT shortcut registration
  3. Pill Indicator Mode Change: Shows/hides pill widget
  4. Pill Position Change: Recreates pill window at new location
  5. Onboarding Complete: Starts device watcher
  6. Emits Event: settings-changed to all windows

AppSettings Interface


Shortcut Management

set_global_shortcut

Update the global recording shortcut.
string
required
Keyboard shortcut (e.g., "CommandOrControl+Shift+Space")
Usage:
Validation:
  1. Checks format validity
  2. Normalizes key names (e.g., Spacespace)
  3. Attempts registration with OS
  4. Returns error if hotkey is already in use
Supported Modifiers:
  • CommandOrControl (Cmd on macOS, Ctrl on Windows/Linux)
  • Shift
  • Alt / Option
  • Control
  • Command (macOS only)
Errors:
  • "Hotkey is already in use by another application" - Conflict detected
  • "Invalid hotkey combination" - Invalid format
  • "Invalid shortcut format" - Parsing error

Language Settings

get_supported_languages

Get list of supported transcription languages.
Returns:
Usage:
Example Response:

Audio Device Settings

set_audio_device

Set the selected microphone device.
string | null
required
Device name or null for system default
Usage:
Side Effects:
  1. Stops any active recording
  2. Updates settings
  3. Refreshes tray menu
  4. Emits audio-device-changed event

validate_microphone_selection

Validate that the selected microphone still exists.
Returns: true if microphone was reset, false if valid or using default Usage:
Behavior:
  • Checks if selected microphone exists in device list
  • If missing, resets to system default
  • Returns true if reset occurred

Model Settings

set_model_from_tray

Set the active model from tray menu selection.
string
required
Model to activate
Usage:
Behavior:
  1. Determines model engine (Whisper/Parakeet/Soniox)
  2. Updates settings
  3. Preloads model (if Whisper)
  4. Updates tray menu
  5. Emits model-changed event

update_tray_menu

Refresh the tray menu (called automatically after model/device changes).
Usage:

Frontend Logging

frontend_log

Log a message from frontend to backend logs.
string
required
Log message
Usage:
Output: Appears in backend logs as [FRONTEND] User clicked download button

Settings Constants


Default Settings


Example: Complete Settings Update

See Also