Skip to content

docs: Add comprehensive action descriptions to README #2

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

docs: Add comprehensive action descriptions to README #2

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
@@ -1 +1,14 @@
# VolumeMixer

A StreamController plugin for managing audio volumes through PulseAudio.

## Actions

- **OpenVolumeMixer**: Opens the volume mixer interface page and allows configuring the volume increment percentage.
- **ExitVolumeMixer**: Exits the volume mixer interface and returns to the previous page.
- **MoveLeft**: Navigates left to view additional audio inputs when more inputs exist than can be displayed at once.
- **MoveRight**: Navigates right to return to previously viewed audio inputs in the volume mixer.
- **VolumeUpKey**: Increases the volume of the associated audio input by the configured increment amount.
- **VolumeDownKey**: Decreases the volume of the associated audio input by the configured increment amount.
- **MuteKey**: Toggles the mute state of the associated audio input.
- **Dial**: Controls audio input volume via dial rotation and toggles mute with a short press (for Stream Deck Plus).