readme, changelog updated

update to reflect recent changes
This commit is contained in:
onyx-and-iris 2022-01-19 21:57:48 +00:00
parent 0fe465d33e
commit a4b7f66984
2 changed files with 33 additions and 25 deletions

View File

@ -7,7 +7,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
Before any minor/major patch is released all test units will be run to verify they pass.
## [Unreleased]
- [x]
- [x] Add VMRemoteErrors class and subclass other error classes.
- [x] Rework set many parameters so class properties are set through the wrapper instead by VBVMR_SetParameters
- [x] Expose lower level setters and getters as well as polling parameters through Remote class.
- [x] Add throw LoginError if multiple login attempts are made.
- [x] Update pester tests to reflect latest changes
## [2.1] - 2021-01-11
### Added

View File

@ -74,30 +74,6 @@ 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. So make sure what you are settings actually exists.
### Multiple parameters
Set many strip/bus/macrobutton/vban parameters at once, for Example
```powershell
Import-Module Voicemeeter
try {
$vmr = Get-RemoteBanana
$hash = @{
strip_0 = @{mute = $true; mono = $true};
strip_2 = @{mute = $true; mono = $true};
bus_1 = @{mute = $true; mono = $true};
button_34 = @{state = $true};
button_12 = @{trigger = $false};
vban_instream_3 = @{name = 'streamname'};
vban_outstream_0 = @{on = $false};
}
$vmr.Set_Multi($hash)
}
finally { $vmr.Logout() }
```
### Strip|Bus
The following strip/bus commands are available:
- mute
@ -171,6 +147,31 @@ $vmr.command.show
$vmr.command.lock = $true
```
### Multiple parameters
Set many strip/bus/macrobutton/vban parameters at once, for Example
```powershell
Import-Module Voicemeeter
try {
$vmr = Get-RemoteBanana
$hash = @{
strip_0 = @{mute = $true; mono = $true};
strip_2 = @{mute = $true; mono = $true};
bus_1 = @{mute = $true; mono = $true};
button_34 = @{state = $true};
button_12 = @{trigger = $false};
vban_instream_3 = @{name = 'streamname'};
vban_outstream_0 = @{on = $false};
}
$vmr.Set_Multi($hash)
}
finally { $vmr.Logout() }
```
### Run tests
Run tests using .\runall.ps1 which accepts two parameters:
- tag Run tests of this type
@ -182,3 +183,6 @@ Example:
`.\runall.ps1 -tag 'higher' -num 3`
Results will be logged and summary file written.
### Official Documentation
- [Voicemeeter Remote C API](https://forum.vb-audio.com/viewtopic.php?f=8&t=346)