Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
ckep1 authored Sep 6, 2024
1 parent 331a464 commit e3a11a0
Showing 1 changed file with 7 additions and 5 deletions.
12 changes: 7 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,25 @@
# AutoPause

AutoPause is a simple Obsidian plugin that automatically pauses playing audio when a new clip is played, with the option to reset to the beginning instead of just pausing.
AutoPause is a simple Obsidian plugin that automatically pauses playing audio when a new clip is played, with the option to reset to the beginning instead of just pausing. This is to allow for one audio stream maximum without needing to locate the previous playing file.

## Features

- Automatically pauses playing audio when a new clip is played
- Option to reset to the beginning instead of just pausing
- Works on desktop and mobile across tabs and document types.

## Installation

1. Download the latest release from the [Releases](https://github.com/ckep1/obsidian-autopause/releases) page
2. Extract the zip file and copy the `obsidian-autopause` folder to your `.obsidian/plugins` folder
1. Download the latest release from the [Releases](https://github.com/ckep1/obsidian-autopause/releases) page (manifest.json and main.js)
2. Add these files to a folder called `auto-pause` in the Plugins folder of your Obsidian Vault
3. Reload Obsidian

## Usage

- With an audio clip playing, playing another one will pause the first one (or reset it to the beginning if enabled).
- No interaction is required besides enabling the plugin.
- With an audio clip playing, starting another one will pause or stop the initial playing one depending on the setting.
- Tested and working with local audio files and the default Obsidian audio embed.

## Settings

- Reset to beginning: When enabled, other audio clips will be reset to the beginning instead of just pausing.
- Reset to beginning: When enabled, other audio clips will be reset to the beginning instead of just pausing. This is the same as stopping in other audio players.

0 comments on commit e3a11a0

Please sign in to comment.