joplin-plugin-record
v1.5.0
Published
This plugin allows you to record audio directly within Joplin using your system's microphone. The recording is then saved as a resource (attachment) to the current note, and a Markdown link to the recording is inserted.
Readme
Joplin Audio Recorder Plugin
This plugin allows you to record audio directly within Joplin using your system's microphone. The recording is then saved as a resource (attachment) to the current note, and a Markdown link to the recording is inserted.
Installation
- Go to the GitHub Releases page
- Download the
io.sigmasd.record.jplfile from the latest release assets. - In Joplin, go to
Tools > Options > Plugins. - Click
Install pluginand select the downloaded.jplfile. - Restart Joplin if prompted.
Usage
- Install: Download the
.jplfile and install it in Joplin viaTools > Options > Plugins. - Select Note: Open the Joplin note where you want to add the audio recording.
- Start Recording:
- Go to the
Toolsmenu and clickToggle Audio Recording. - Alternatively, press the keyboard shortcut
CmdOrCtrl+Alt+R.
- Go to the
- Grant Permissions: If prompted by your system or Joplin, grant permission to access the microphone.
- Recording Dialog: A dialog box will appear with the message "🔴 Recording audio..." and a "Stop" button.
- Stop Recording:
- Click the "Stop" button in the dialog.
- Alternatively, use the menu item (
Tools > Toggle Audio Recording) or the shortcut (CmdOrCtrl+Alt+R) again.
- Processing: The plugin will process the audio, save it as a Joplin resource, and insert a link into your note. The dialog will update to show "✅ Recording finished and inserted." or an error message.
- Close Dialog: Click "OK" on the final status dialog.
Technical Notes
- Relies on the standard Web
MediaRecorderAPI available within Joplin's Electron environment. - Attempts to use the following MIME types in order of preference:
audio/webm;codecs=opus,audio/ogg;codecs=opus,audio/webm,audio/ogg. The actual format used depends on your system's capabilities. - Temporary audio data is stored in
<Your OS Temporary Directory>/joplin-audio-recorder. This directory is automatically cleaned up when Joplin exits or when the recording is successfully processed (or fails).
