Skip to content

solarslurpi/obsidian-transcriber-plugin

Repository files navigation

Obsidian Transcriber Plugin

📢 Description

The Obsidian Transcriber plugin converts an audio file or YouTube video into an Obsidian note. Both the metadata and the text are captured in the note.

Note: The Obsidian Transcriber plugin requires a connection to an Obsidian Transcriber service.

🎥 Demo of Transcript with Chapters and Titles from YouTube Video

YouTube video: Bluelab Pulse Meter Review

Obsidian Transcriber
Note: The source is a YouTube video with chapters and the Timestamp Notes community plugin installed and enabled.

✨ Features

After the plugin finishes its work with the Obsidian Transcriber Service, the created note includes:

  • YouTube metadata as YAML frontmatter.
  • A YouTube URL "button" that when clicked invokes a YouTube player in Obsidian's sidebar.
  • The transcript broken into chapters with topic titles and timestamps.
  • Below each topic title is a timestamp "button" that when clicked will move the player to that time in the video.

🎥 Demo of Transcript without Chapters from YouTube Video

YouTube video: Jeff Lowenfels - The Updated Soil Food Web

Obsidian Transcriber
Note: The source is a YouTube video without chapters and the Timestamp Notes community plugin installed and enabled.

✨ Features

The features are identical to the previous example except instead of breaking the text into chapters, the transcribed text is broken up into time segments.

🎥 Demo of Transcript from Audio File

Obsidian Transcriber

✨ Features

Compared with audio sources that originate from YouTube, the front matter of an uploaded audio file contains far less metadata. The transcript is broken into chapters based on the time chunk setting in the settings UI.

Note: 😔The integration with the Timestamp Notes community plugin will load a player and start the audio. However, clicking on the timestamp will not move the player to that time.

🛠️ Installation

Manual Installation

  1. Go to your Obsidian vault's plugin folder (<vault name>/.obsidian/plugins).
  2. Create the folder obsidian-transcriber-plugin.
  3. Go to release.
  4. Copy main.js and manifest.json to the obsidian-transcriber-plugin folder.
  5. Open your Obsidian vault and go into Settings. Choose core plugins and enable the Obsidian Transcriber Plugin.

From Obsidian Community Plugins

Note: 😔 This installation method does not work. It is here to document the steps to install as a community plugin once the community wants that to happen.
  • Open Obsidian.
  • Go to Settings > Community plugins > Browse.
  • Search for "Obsidian Transcriber".
  • Click Install.
  • Once installed, enable the plugin in the Community plugins section.
  • 👍 Use

    Click on the ❀ flower in the left ribbon to bring up the UI - OR - <ctrl-p> (PC) <cmd-p> (Mac) then type t then r.

    Form UI

    Enter either a YouTube URL, or click on the button to choose an audio file. Then click the Submit button.

    Progress notifications will start to be shown. It can take quite a bit of time to complete a transcription, particularly if the desired audio quality loaded a larger model.

    Note: Don't forget! You'll also need a connection to an Obsidian Transcriber service.

    ⚙️ Settings

    You can configure the plugin settings by navigating to Settings > Plugin Options > Obsidian Transcriber.

    settings ui

    The default values are set in plugin_settings.ts

    • 📂 Transcripts Folder: Specify the vault folder for transcripts. The folder will be created if it does not exist.
    • 🌐 Obsidian Transcriber Service URL: Set the URL to the endpoint running the Obsidian Transcriber Service endpoint.
    • 🎧 Audio Quality: Choose audio quality from tiny to large. Higher quality increases processing time.
    • 💻 Compute Type: The compute type determines the precision and efficiency of the computations performed by the model.
    • 📘 Chapter Chunk Time: The amount of time to chunk the transcript into chapters if there is no chapter info in the metadata.
    • 🐞 Debug: If toggled on, debug, warning, and error messages are sent to the console debugger. If not on, only error messages are sent to the console.

    Troubleshooting

    To troubleshoot, set the logging to debug and check the console for messages. The steps:

    • Toggle on the debug setting in the settings UI.
    • Open the console debugger.
      • On Windows, press Ctrl+Shift+I.
      • On Mac, press Cmd+Option+I.
    • Press Ctrl-L (or equivalent on Mac) to clear the console.
    • Run the plugin.

    Debug, warning, and error messages will be sent to the console. If you cannot fix the issue, please:

    • Save the console output by right-clicking on the console and choosing Save as....
    FConsole log ui
    ![console log](docs/images/console_log.jpg)
    • Open an issue and attach the saved console output.