Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/eatgrass/obsidian-lyrics
Enhance your Obsidian audio player by adding a interactive lyrics display feature.
https://github.com/eatgrass/obsidian-lyrics
audio lyrics obsidian-plugin subtitle transcript
Last synced: 11 days ago
JSON representation
Enhance your Obsidian audio player by adding a interactive lyrics display feature.
- Host: GitHub
- URL: https://github.com/eatgrass/obsidian-lyrics
- Owner: eatgrass
- License: mit
- Created: 2023-12-02T11:54:03.000Z (11 months ago)
- Default Branch: master
- Last Pushed: 2024-02-18T05:41:22.000Z (9 months ago)
- Last Synced: 2024-10-13T17:45:46.529Z (26 days ago)
- Topics: audio, lyrics, obsidian-plugin, subtitle, transcript
- Language: TypeScript
- Homepage:
- Size: 113 KB
- Stars: 23
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- project-awesome - eatgrass/obsidian-lyrics - Enhance your Obsidian audio player by adding a interactive lyrics display feature. (TypeScript)
README
## Screenshot
## Description
Enhance your audio player by adding a interactive lyrics display feature.
Now you can navigate through the player using the lyrics for a more engaging and organized listening experience.
It allows you to seamlessly review your audio notes and highlights.
## Usage
### Installation
Obsidian Community Plugins
`obsidian://show-plugin?id=lyrics`
### Basic Usage
Include an audio source and subtitle contents in the `lrc` code block.
**Supported Subtitle Format**
- [LRC](https://en.wikipedia.org/wiki/LRC_(file_format))
- [SRT](https://en.wikipedia.org/wiki/SubRip)
**Specifying the Audio Source**
You can specify the source of the audio file either as a filepath or as an internal link.
1. Using an internal link source:
```lrc
source [[audio_file.mp3]]
[00:01.00] Your .lrc format contents
[00:02.00] ....
```
2. Using a filepath source:
```lrc
source path/to/your_audio_file.mp3
1
00:02:16,612 --> 00:02:19,376
Your .srt format contents
2
00:02:19,482 --> 00:02:21,609
Hello ==Lyrics==
```
### Context Menu
In the `Reading View`, right-click on the area where lyrics are displayed to use context menu.
- play/pause audio player
- toggle auto-scroll
- toggle sentence mode
- seek
- edit
## Styling
Customize your own styles by utilizing the CSS classes provided below.
```html
Hello Lyrics
```
- `.lyrics-line`: the entire lyrics line.
- `.lyrics-line .lyrics-timestamp`: timestamp of the lyrics.
- `.lyrics-line .lyrics-text`: text content of the lyrics.
- `.lyrics-highlighted`: mark the current highlighted lyrics.
---
[
](https://www.buymeacoffee.com/eatgrass)