diff --git a/CHANGELOG.md b/CHANGELOG.md index 5ba96ef..7125b82 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -11,15 +11,17 @@ Before any major/minor/patch bump all unit tests will be run to verify they pass - [x] -## [1.6.0] - 2022-09-14 +## [1.7.0] - 2022-09-14 ### Added +- voicemeeter.NewRemote now accepts a delay int argument (milliseconds). - vm.Sync() can now be used to force the dirty parameters to clear. ### Changed - higher level methods/functions now accept/return float64 +- tests updated to reflect changes. ## [1.5.0] - 2022-09-07 diff --git a/README.md b/README.md index 60066a2..29cb256 100644 --- a/README.md +++ b/README.md @@ -42,8 +42,7 @@ import ( ) func main() { - kindId := "banana" - vm, err := voicemeeter.NewRemote(kindId) + vm, err := voicemeeter.NewRemote("banana", 15) if err != nil { log.Fatal(err) } @@ -56,12 +55,13 @@ func main() { vm.Strip[0].SetLabel("rode podmic") vm.Strip[0].SetMute(true) - vm.Sync() fmt.Printf("Strip 0 (%s) mute was set to %v\n", vm.Strip[0].GetLabel(), vm.Strip[0].GetMute()) } ``` -## `kindId` +## `voicemeeter.NewRemote(, )` + +### `kindId` Pass the kind of Voicemeeter as an argument. kindId may be: @@ -69,6 +69,12 @@ Pass the kind of Voicemeeter as an argument. kindId may be: - `banana` - `potato` +### `delay` + +Pass a delay in milliseconds to force the getters to wait for dirty parameters to clear. + +Useful if not running callbacks. + ## `Remote Type` #### `vm.Strip` @@ -157,7 +163,7 @@ returns True iff a macrobutton parameter has changed #### `vm.Sync()` -Use this to force dirty parameters to clear before continuing. Useful for slowing down getters. +Use this to force dirty parameters to clear after a delay in milliseconds. Useful for slowing down getters. ## `Available commands`