Skip to content

travisvn/obsidian-edge-tts

Repository files navigation

Obsidian Edge TTS Plugin 🗣️

GitHub stars Obsidian downloads GitHub release GitHub issues GitHub last commit Discord

Free high-quality text-to-speech (narration) in Obsidian

Overview

The Obsidian Edge TTS Plugin is a community plugin for Obsidian that allows you to read your notes aloud using Microsoft's Edge TTS API. It supports a variety of voices and locales, making it an excellent tool for users who want to listen to their notes while multitasking or to improve accessibility.

Features

  • 🔥 NEW: Native Mobile Support - Now works on both Obsidian Desktop and Obsidian Mobile (iOS/Android)
  • Read selected text or entire notes aloud
  • Choose from a list of top voices or specify a custom voice
  • Adjust playback speed of voice over
  • Toggle optional notices for playback status
  • Option to generate mp3 file and embed it directly in note
  • Playback queue: Add multiple notes to a queue for continuous playback with loop and auto-scroll options
  • Listen to voice samples before selecting a voice (via tts.travisvn.com)

Installation

Install Obsidian plugin

  1. Open Obsidian
  2. Go to SettingsCommunity Plugins
  3. Search for Edge TTS
  4. Click Install and then Enable

Alternatively, you can manually download the latest release from GitHub Releases

Usage

  • Open the note you want to read aloud (or select the text)
  • Use the Read note aloud command from the command palette
    • or Click the ribbon icon (if enabled)
    • or Playback button in the status bar — this both starts a narration and then allows you to pause or resume once it's started
    • or Right-click on a file and select Read note aloud
  • Right-click on a file and select Add to playback queue to queue multiple notes for continuous playback
  • Right-click on a file and select Generate MP3 to save the narration to an mp3 and embed it in the note (if enabled).
  • Use the Show floating playback controls command from the command palette to open the player if it has been closed. This command is idempotent, meaning if the player is already open, it won't do anything.
  • Use the Reset floating player position command to move the player back to its default bottom-right screen position.

Settings

To access the plugin settings:

  1. Go to SettingsCommunity PluginsEdge TTS.

  2. Configure the following options:

    • Select voice: Choose from a list of top voices.
    • Custom voice: Manually enter a custom voice.
    • Playback speed: Adjust playback speed multiplier.
    • Show notices: Toggle notices for playback status and errors.
    • Show status bar button: Toggle playback button in status bar.
    • Disable floating playback controls: Hides the floating player during audio playback. If you close the player using the 'X' button, you can reopen it using the "Show floating playback controls" command.
    • Enable replay option: Keeps the playback controls open after audio finishes to allow replaying.
    • Enable queue feature: Toggle the playback queue functionality for continuous playback of multiple notes.
    • Generate MP3: Toggle settings related to the Generate MP3 menu option.
    • Voice Samples: Visit tts.travisvn.com to sample available voices.

    Obsidian Edge TTS Plugin Settings Screenshot

If you like this project, please give it a star on GitHub ⭐️

New Mobile Option 📱

Create audio narration for your Obsidian notes through our free mobile app

Get it on Google Play Download on the App Store

  • Available on iOS and Android
  • Usage:
    • Use the "share" functionality on any given note
    • Select Read Aloud AI from the native mobile share menu
    • Your markdown will be imported from the shared file and formatted like in the Obsidian desktop plugin
    • Narration will playback instantly, and you can export the .mp3 generated back into Obsidian

About

Free, high quality text-to-speech for your Obsidian notes, leveraging Microsoft Edge's Read Aloud API.

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published