Skip to content

Add README with plugin action summaries #21

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
ImDevinC wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add README with plugin action summaries #21

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# MediaPlugin

A StreamController plugin for controlling media playback via MPRIS.

## Actions

- **Play** - Starts media playback if the player is not currently playing.
- **Pause** - Pauses media playback if the player is currently playing.
- **PlayPause** - Toggles between play and pause states based on the current playback status.
- **Next** - Skips to the next track in the media queue.
- **Previous** - Returns to the previous track in the media queue.
- **Info** - Displays the current media title and artist information with an optional separator.
- **ThumbnailBackground** - Sets the current media thumbnail as the deck background image.