SoundSwitch

https://soundswitch.aaflalo.me/
Admin
SoundSwitch is an open-source Windows application that allows users to quickly switch between audio...
Tokens:19,982
Snippets:223
Trust Score:8.9
Update:3 weeks ago
Show doc for...
Tokens:
Raw
### profile --list --json output

Source: https://soundswitch.aaflalo.me/usage/cli

Example JSON output from `SoundSwitch.CLI.exe profile --list --json`, showing an array of profile objects with name and device fields.

```json
[
  {
    "name": "Gaming",
    "playbackDevice": "Speakers (Realtek(R) Audio)",
    "playbackCommunicationDevice": "Headset Earphone (HyperX Cloud II)",
    "recordingDevice": "Microphone (USB Audio Device)",
    "recordingCommunicationDevice": "Headset Microphone (HyperX Cloud II)"
  }
]
```

--------------------------------

### devices --json output

Source: https://soundswitch.aaflalo.me/usage/cli

Example JSON output from `SoundSwitch.CLI.exe devices --json`, listing playback and recording devices that are active and selected for switching.

```json
{
  "playbackDevices": [
    "Speakers (Realtek(R) Audio)",
    "Headset Earphone (HyperX Cloud II)"
  ],
  "recordingDevices": [
    "Microphone (USB Audio Device)"
  ]
}
```

--------------------------------

### SoundSwitch CLI commands

Source: https://soundswitch.aaflalo.me/faq/command-line

Example commands for controlling SoundSwitch from the command line. All commands accept --json for machine-readable output; failures in JSON mode print a JSON object with an error field and exit with code 1.

```bash
SoundSwitch.CLI.exe switch --type Playback
SoundSwitch.CLI.exe switch --type Recording
SoundSwitch.CLI.exe mute --toggle
SoundSwitch.CLI.exe profile --list --json
SoundSwitch.CLI.exe status
SoundSwitch.CLI.exe devices
```

--------------------------------

### status --json output

Source: https://soundswitch.aaflalo.me/usage/cli

Example JSON output from `SoundSwitch.CLI.exe status --json`. `activeProfile` is null when no profile has been triggered since startup; device fields are empty strings when no matching device is present.

```json
{
  "activeProfile": "Gaming",
  "playbackDevice": "Speakers (Realtek(R) Audio)",
  "recordingDevice": "Microphone (USB Audio Device)",
  "playbackCommunicationDevice": "Headset Earphone (HyperX Cloud II)",
  "recordingCommunicationDevice": "Headset Microphone (HyperX Cloud II)"
}
```

--------------------------------

### SoundSwitch.CLI.exe profile --list

Source: https://soundswitch.aaflalo.me/usage/cli

Lists all available audio profiles. Optionally accepts --json for machine-readable output.

```APIDOC
## [CLI] SoundSwitch.CLI.exe profile --list

### Description
Lists all available audio profiles. Optionally accepts --json for machine-readable output.

### Command
`SoundSwitch.CLI.exe profile --list`

### Parameters
- `--list` (flag) - Required - List all available profiles.
- `--json` (flag) - Optional - Output in JSON format.

### Response
When `--json` is used, returns a JSON array of profile objects, each with `name`, `playbackDevice`, `playbackCommunicationDevice`, `recordingDevice`, and `recordingCommunicationDevice` fields. On failure, returns `{ "error": "..." }` and exits with code 1.
```

--------------------------------

### SoundSwitch.CLI.exe settings

Source: https://soundswitch.aaflalo.me/usage/cli

Opens the SoundSwitch settings window. Optionally accepts --json for machine-readable output.

```APIDOC
## [CLI] SoundSwitch.CLI.exe settings

### Description
Opens the SoundSwitch settings window. Optionally accepts --json for machine-readable output.

### Command
`SoundSwitch.CLI.exe settings`

### Parameters
- `--json` (flag) - Optional - Output in JSON format.

### Response
When `--json` is used, returns a JSON object with `success` field (e.g., `{ "success": true }`). On failure, returns `{ "error": "..." }` and exits with code 1.
```

--------------------------------

### SoundSwitch.CLI.exe profile --name "Gaming"

Source: https://soundswitch.aaflalo.me/usage/cli

Activates the specified audio profile. Optionally accepts --json for machine-readable output.

```APIDOC
## [CLI] SoundSwitch.CLI.exe profile --name "Gaming"

### Description
Activates the specified audio profile. Optionally accepts --json for machine-readable output.

### Command
`SoundSwitch.CLI.exe profile --name "Gaming"`

### Parameters
- `--name` (string) - Required - Name of the profile to activate.
- `--json` (flag) - Optional - Output in JSON format.

### Response
When `--json` is used, returns a JSON object with `success` field (e.g., `{ "success": true }`). On failure, returns `{ "error": "..." }` and exits with code 1.
```

--------------------------------

### SoundSwitch.CLI.exe devices

Source: https://soundswitch.aaflalo.me/usage/cli

Lists devices that are both active and selected for switching in SoundSwitch settings. Optionally accepts --json for machine-readable output.

```APIDOC
## [CLI] SoundSwitch.CLI.exe devices

### Description
Lists devices that are both active and selected for switching in SoundSwitch settings. Optionally accepts --json for machine-readable output.

### Command
`SoundSwitch.CLI.exe devices`

### Parameters
- `--json` (flag) - Optional - Output in JSON format.

### Response
When `--json` is used, returns a JSON object with `playbackDevices` and `recordingDevices` arrays. On failure, returns `{ "error": "..." }` and exits with code 1.
```

--------------------------------

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

Source: https://soundswitch.aaflalo.me/usage/cli

Cycles to the next playback device. Optionally accepts --json for machine-readable output.

```APIDOC
## [CLI] SoundSwitch.CLI.exe switch --type Playback

### Description
Cycles to the next playback device. Optionally accepts --json for machine-readable output.

### Command
`SoundSwitch.CLI.exe switch --type Playback`

### Parameters
- `--type` (string) - Required - Device type: `Playback` or `Recording`.
- `--json` (flag) - Optional - Output in JSON format.

### Response
When `--json` is used, returns a JSON object with `success` field (e.g., `{ "success": true }`). On failure, returns `{ "error": "..." }` and exits with code 1.
```

--------------------------------

### SoundSwitch.CLI.exe status

Source: https://soundswitch.aaflalo.me/usage/cli

Shows the active profile and current default audio endpoints (playback, recording, and communication). Optionally accepts --json for machine-readable output.

```APIDOC
## [CLI] SoundSwitch.CLI.exe status

### Description
Shows the active profile and current default audio endpoints (playback, recording, and communication). Optionally accepts --json for machine-readable output.

### Command
`SoundSwitch.CLI.exe status`

### Parameters
- `--json` (flag) - Optional - Output in JSON format.

### Response
When `--json` is used, returns a JSON object with fields: `activeProfile`, `playbackDevice`, `recordingDevice`, `playbackCommunicationDevice`, and `recordingCommunicationDevice`. `activeProfile` is `null` when no profile has been triggered since startup. Device fields are empty strings when no matching device is present. On failure, returns `{ "error": "..." }` and exits with code 1.
```
Tokens:
Raw