Skip to content

README.md

Latest commit

 

History

History
83 lines (66 loc) · 1.74 KB

README.md

File metadata and controls

83 lines (66 loc) · 1.74 KB

SoundSwitch CLI

A command-line interface for controlling SoundSwitch.

Commands

Switch Audio Device

Switch between recording or playback devices:

SoundSwitch.CLI.exe switch --type Recording
SoundSwitch.CLI.exe switch --type Playback

Microphone Control

Manage microphone mute state:

SoundSwitch.CLI.exe mute              # Show current mute state
SoundSwitch.CLI.exe mute --state true # Mute the microphone
SoundSwitch.CLI.exe mute -s false     # Unmute the microphone
SoundSwitch.CLI.exe mute --toggle     # Toggle mute state

Profile Management

List all available profiles:

SoundSwitch.CLI.exe profile --list

Trigger a specific profile:

SoundSwitch.CLI.exe profile --name "Profile Name"

Settings

Open SoundSwitch settings:

SoundSwitch.CLI.exe settings

Examples

  1. Switch to next playback device:
SoundSwitch.CLI.exe switch --type Playback
  1. Switch to next recording device:
SoundSwitch.CLI.exe switch --type Recording
  1. List all available profiles:
SoundSwitch.CLI.exe profile --list
  1. Trigger a specific profile:
SoundSwitch.CLI.exe profile --name "Headphones + Mic"
  1. Open settings window:
SoundSwitch.CLI.exe settings
  1. Mute/Unmute microphone:
SoundSwitch.CLI.exe mute -t          # Toggle mute
SoundSwitch.CLI.exe mute -s true     # Mute
SoundSwitch.CLI.exe mute --state false # Unmute

Error Handling

The CLI provides clear error messages when:

  • SoundSwitch is not running
  • Profile names are invalid
  • Connection issues occur
  • Invalid commands or options are provided
  • No default microphone is set (for mute commands)

All commands support the --help flag for additional information.