mirror of
https://github.com/onyx-and-iris/voicemeeter-api-powershell.git
synced 2026-04-18 13:33:31 +00:00
update to .md files
Added CHANGELOG to document changes. Added installation instructions to README and link to FROM_SOURCE for alternative script loading instructions. Modified examples in README to reflect recent changes to module
This commit is contained in:
36
README.md
36
README.md
@@ -3,6 +3,8 @@ This wrapper was written in response to a request in the VB-AUDIO discord for
|
||||
a way to invoke commands using Powershell. It is designed to be simple to use
|
||||
but not every feature is added.
|
||||
|
||||
For past/future changes to this project refer to: [CHANGELOG](.\CHANGELOG.md)
|
||||
|
||||
## Tested against
|
||||
- Basic 1.0.7.8
|
||||
- Banana 2.0.5.8
|
||||
@@ -15,15 +17,28 @@ You may have success with many commands in earlier versions but some commands
|
||||
- Voicemeeter: https://voicemeeter.com/
|
||||
- Powershell 5.1
|
||||
|
||||
## Installation
|
||||
#### Powershell:
|
||||
`Install-Module Voicemeeter`
|
||||
|
||||
You will need to add PSGallery as a trusted repository source.
|
||||
More info: [PSGallery](https://www.powershellgallery.com/)
|
||||
|
||||
#### Direct download:
|
||||
`git clone https://github.com/onyx-and-iris/voicemeeter-api-powershell.git`
|
||||
|
||||
All examples in this readme assume you've installed as a module.
|
||||
If you decide to direct download see [alternative instructions](.\FROM_SOURCE.md).
|
||||
|
||||
## Use
|
||||
When you instantiate Remote class you will automatically be logged in. Use a
|
||||
try finally block to ensure you logout at the end of your code.
|
||||
```powershell
|
||||
. $PSScriptRoot\lib\voicemeeter.ps1
|
||||
Import-Module Voicemeeter
|
||||
|
||||
try {
|
||||
# pass a Voicemeeter type to class Remote
|
||||
$vmr = [Remote]::new('banana')
|
||||
# Run the factory function for required Voicemeeter type
|
||||
$vmr = Get-RemoteBanana
|
||||
|
||||
# Set strip and bus params
|
||||
$vmr.strip[0].mono = $true
|
||||
@@ -38,19 +53,20 @@ try {
|
||||
finally { $vmr.Logout() }
|
||||
```
|
||||
|
||||
Voicemeeter type can be one of:
|
||||
- basic
|
||||
- banana
|
||||
- potato
|
||||
Voicemeeter factory function can be:
|
||||
- Get-RemoteBasic
|
||||
- Get-RemoteBanana
|
||||
- Get-RemotePotato
|
||||
|
||||
There is no bounds checking in this wrapper, meaning if you attempt to set a
|
||||
parameter that does not exist for that version of Voicemeeter the wrapper will
|
||||
throw an error and crash. So make sure what you are settings actually exists.
|
||||
throw an error. So make sure what you are settings actually exists.
|
||||
|
||||
### Multiple parameters
|
||||
Set many strip/bus parameters at once, for Example
|
||||
```powershell
|
||||
. $PSScriptRoot\lib\voicemeeter.ps1
|
||||
Import-Module Voicemeeter
|
||||
|
||||
try {
|
||||
$hash = @{
|
||||
"Strip[0].Mute" = $true
|
||||
@@ -61,7 +77,7 @@ try {
|
||||
"Strip[2].Mono" = $true
|
||||
}
|
||||
|
||||
Param_Set_Multi -HASH $hash
|
||||
$vmr.Set_Multi($hash)
|
||||
}
|
||||
finally { $vmr.Logout() }
|
||||
```
|
||||
|
||||
Reference in New Issue
Block a user