@raphiiko/wavelink-cli 0.0.5 → 0.0.6

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -35,22 +35,26 @@ wavelink-cli <category> <command> [options]
35
35
  Manage your output devices (Headphones, Speakers, etc).
36
36
 
37
37
  ```bash
38
- # List all output devices
38
+ # List all output devices (shows names, IDs, and Wave Device status)
39
39
  wavelink-cli output list
40
40
 
41
- # Assign an output device to a mix
42
- wavelink-cli output assign <output-id> <mix-id-or-name>
41
+ # Assign an output device to a mix (use ID or name)
42
+ wavelink-cli output assign <output-id-or-name> <mix-id-or-name>
43
+ # Example: wavelink-cli output assign "Headphones (Arctis Nova Pro Wireless)" "Stream Mix"
43
44
 
44
45
  # Remove an output device from its mix
45
- wavelink-cli output unassign <output-id>
46
+ wavelink-cli output unassign <output-id-or-name>
47
+ # Example: wavelink-cli output unassign "Speakers (Realtek)"
46
48
 
47
49
  # Set volume (0-100)
48
- wavelink-cli output set-volume <output-id> <volume>
50
+ wavelink-cli output set-volume <output-id-or-name> <volume>
51
+ # Example: wavelink-cli output set-volume "Headphones (Arctis Nova Pro Wireless)" 75
49
52
 
50
53
  # Mute/Unmute
51
- wavelink-cli output mute <output-id>
52
- wavelink-cli output unmute <output-id>
53
- wavelink-cli output toggle-mute <output-id>
54
+ wavelink-cli output mute <output-id-or-name>
55
+ wavelink-cli output unmute <output-id-or-name>
56
+ wavelink-cli output toggle-mute <output-id-or-name>
57
+ # Example: wavelink-cli output toggle-mute "Speakers (Realtek)"
54
58
  ```
55
59
 
56
60
  ### Mixes
@@ -62,59 +66,67 @@ wavelink-cli mix list
62
66
 
63
67
  # Set a device as the ONLY output for a mix
64
68
  wavelink-cli mix set-output <mix-id-or-name> <output-id>
69
+ # Example: wavelink-cli mix set-output "Stream Mix" "{0.0.0.00000000}.{abc12345-...}"
65
70
 
66
71
  # Set master volume (0-100)
67
72
  wavelink-cli mix set-volume <mix-id-or-name> <volume>
73
+ # Example: wavelink-cli mix set-volume "Personal Mix" 80
68
74
 
69
75
  # Mute/Unmute/Toggle
70
76
  wavelink-cli mix mute <mix-id-or-name>
71
77
  wavelink-cli mix unmute <mix-id-or-name>
72
78
  wavelink-cli mix toggle-mute <mix-id-or-name>
79
+ # Example: wavelink-cli mix toggle-mute "Monitor Mix"
73
80
  ```
74
81
 
75
82
  ### Channels
76
83
  Manage audio channels (System, Music, Browser, etc).
77
84
 
78
85
  ```bash
79
- # List all channels
86
+ # List all channels (shows names and IDs)
80
87
  wavelink-cli channel list
81
88
 
82
- # Set master channel volume (0-100)
83
- wavelink-cli channel set-volume <channel-id> <volume>
89
+ # Set master channel volume (0-100, use ID or name)
90
+ wavelink-cli channel set-volume <channel-id-or-name> <volume>
91
+ # Example: wavelink-cli channel set-volume "Game Audio" 70
84
92
 
85
93
  # Mute/Unmute/Toggle channel globally
86
- wavelink-cli channel mute <channel-id>
87
- wavelink-cli channel unmute <channel-id>
88
- wavelink-cli channel toggle-mute <channel-id>
94
+ wavelink-cli channel mute <channel-id-or-name>
95
+ wavelink-cli channel unmute <channel-id-or-name>
96
+ wavelink-cli channel toggle-mute <channel-id-or-name>
97
+ # Example: wavelink-cli channel toggle-mute "Voice Chat"
89
98
 
90
99
  # Set volume for a specific mix
91
- wavelink-cli channel set-mix-volume <channel-id> <mix-id-or-name> <volume>
100
+ wavelink-cli channel set-mix-volume <channel-id-or-name> <mix-id-or-name> <volume>
101
+ # Example: wavelink-cli channel set-mix-volume browser "Stream Mix" 60
92
102
 
93
103
  # Mute/Unmute in a specific mix
94
- wavelink-cli channel mute-in-mix <channel-id> <mix-id-or-name>
95
- wavelink-cli channel unmute-in-mix <channel-id> <mix-id-or-name>
96
- wavelink-cli channel toggle-mute-in-mix <channel-id> <mix-id-or-name>
104
+ wavelink-cli channel mute-in-mix <channel-id-or-name> <mix-id-or-name>
105
+ wavelink-cli channel unmute-in-mix <channel-id-or-name> <mix-id-or-name>
106
+ wavelink-cli channel toggle-mute-in-mix <channel-id-or-name> <mix-id-or-name>
107
+ # Example: wavelink-cli channel toggle-mute-in-mix game "Monitor Mix"
97
108
 
98
109
  # Isolate a channel in a mix (mute all others)
99
- wavelink-cli channel isolate <channel-id> <mix-id-or-name>
100
-
101
-
110
+ wavelink-cli channel isolate <channel-id-or-name> <mix-id-or-name>
111
+ # Example: wavelink-cli channel isolate voice "Personal Mix"
102
112
  ```
103
113
 
104
114
  ### Inputs
105
115
  Control hardware inputs (Microphones, etc).
106
116
 
107
117
  ```bash
108
- # List all input devices
118
+ # List all input devices (shows names, IDs, gain ranges, gain lock status, and mic/PC mix settings)
109
119
  wavelink-cli input list
110
120
 
111
- # Set gain (0-100)
112
- wavelink-cli input set-gain <input-id> <gain>
121
+ # Set gain (0-100, use ID or name)
122
+ wavelink-cli input set-gain <input-id-or-name> <gain>
123
+ # Example: wavelink-cli input set-gain "Microphone (Blue Yeti)" 65
113
124
 
114
125
  # Mute/Unmute
115
- wavelink-cli input mute <input-id>
116
- wavelink-cli input unmute <input-id>
117
- wavelink-cli input toggle-mute <input-id>
126
+ wavelink-cli input mute <input-id-or-name>
127
+ wavelink-cli input unmute <input-id-or-name>
128
+ wavelink-cli input toggle-mute <input-id-or-name>
129
+ # Example: wavelink-cli input toggle-mute "Wave:3"
118
130
  ```
119
131
 
120
132
  ### General