define custom usage handler.

add guard for toggleCmd to prevent unsafe gain changes.

use logrus for control of log levels.

add an input prompt for interactive mode

.gitignore

@@ -19,3 +19,7 @@ config.toml
 
 # Dependency directories (remove the comment below to include it)
 # vendor/
+
+# work files
+go.work
+go.work.sum

CHANGELOG.md

@@ -9,7 +9,20 @@ Before any major/minor/patch bump all unit tests will be run to verify they pass
 
 ## [Unreleased]
 
--   [x]
+- [x]
+
+## [2.1.0] - 2024-07-01
+
+### Added
+
+- Added a configurable login timeout in seconds (defaults to 2).
+- Option function added for overriding the type of Voicemeeter GUI runVoicemeeter() will launch.
+- Explanation of Option functions added to README.
+
+### Changed
+
+- runVoicemeeter() now launches x64 GUIs for all kinds if on a 64 bit system.
+  - this can be overridden to force 32 bit GUI using voicemeeter.WithBits(32) Option function
 
 ## [2.0.0] - 2022-10-25
 
@@ -17,150 +30,150 @@ V2 introduces some breaking changes.
 
 ### Changed
 
--   Removed Get prefix from getters in Bus, Strip, Vban, Button and Output types.
--   Pooler now communicates event updates over a channel.
--   strip.comp now references comp struct type. (see readme for changes in setting comp parameters)
--   strip.gate now references gate struct type. (see readme for changes in setting gate parameters)
--   strip.eq, bus.eq now reference eQ struct type. (see readme for changes in setting eq parameters)
--   All examples and tests have been updated to reflect the changes.
+- Removed Get prefix from getters in Bus, Strip, Vban, Button and Output types.
+- Pooler now communicates event updates over a channel.
+- strip.comp now references comp struct type. (see readme for changes in setting comp parameters)
+- strip.gate now references gate struct type. (see readme for changes in setting gate parameters)
+- strip.eq, bus.eq now reference eQ struct type. (see readme for changes in setting eq parameters)
+- All examples and tests have been updated to reflect the changes.
 
 ### Added
 
--   denoiser type to strip types.
--   XY parameters added to strip type
--   extra logging added to getters/setters in iRemote type.
--   InitPooler to Remote type in case the Pooler needs reinitiating. (perhaps the GUI closed unexpectedly)
+- denoiser type to strip types.
+- XY parameters added to strip type
+- extra logging added to getters/setters in iRemote type.
+- InitPooler to Remote type in case the Pooler needs reinitiating. (perhaps the GUI closed unexpectedly)
 
 ### Fixed
 
--   Functions that wrap CAPI calls in base.go now return correct error values.
+- Functions that wrap CAPI calls in base.go now return correct error values.
 
 ## [1.11.0] - 2022-10-10
 
 ### Fixed
 
--   type error in getLevel
+- type error in getLevel
 
 ## [1.8.0] - 2022-09-17
 
 ### Added
 
--   vm-cli example added + example README
--   Fade, App methods added to project README
+- vm-cli example added + example README
+- Fade, App methods added to project README
 
 ## [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.
+- 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.
+- higher level methods/functions now accept/return float64
+- tests updated to reflect changes.
 
 ## [1.5.0] - 2022-09-07
 
 ### Changed
 
--   changes to error handling.
-    -   functions that wrap capi calls now return error types.
-    -   higher level functions print error messages
+- changes to error handling.
+  - functions that wrap capi calls now return error types.
+  - higher level functions print error messages
 
 ## [1.4.0] - 2022-08-22
 
 ### Added
 
--   midi type, supports midi devices
--   midi updates added to the pooler
--   event type, supports toggling event updates through EventAdd() and EventRemove() methods.
--   Forwarder methods for get/set float/string parameters added to Remote type
--   Midi, Events sections added to README.
+- midi type, supports midi devices
+- midi updates added to the pooler
+- event type, supports toggling event updates through EventAdd() and EventRemove() methods.
+- Forwarder methods for get/set float/string parameters added to Remote type
+- Midi, Events sections added to README.
 
 ### Changed
 
--   macrobutton updates moved into its own goroutine
--   observer example updated to include midi updates
--   level updates are now disabled by default, should be enabled explicitly
+- macrobutton updates moved into its own goroutine
+- observer example updated to include midi updates
+- level updates are now disabled by default, should be enabled explicitly
 
 ## [1.2.0] - 2022-07-10
 
 ### Added
 
--   docstrings added to types, methods and functions
--   version retractions added to go.mod
+- docstrings added to types, methods and functions
+- version retractions added to go.mod
 
 ### Changed
 
--   Entry method renamed from GetRemote to NewRemote
--   Readme updated to reflect latest changes
+- Entry method renamed from GetRemote to NewRemote
+- Readme updated to reflect latest changes
 
 ## [1.1.0] - 2022-06-30
 
 ### Added
 
--   Level updates implemented in Pooler struct. Runs in its own goroutine.
+- Level updates implemented in Pooler struct. Runs in its own goroutine.
 
 ### Fixed
 
--   Fixed bug with identifier in outputs struct.
+- Fixed bug with identifier in outputs struct.
 
 ### Changed
 
--   Package files moved into root of repository.
--   Remote struct now exported type
+- Package files moved into root of repository.
+- Remote struct now exported type
 
 ## [1.0.0] - 2022-06-30
 
 ### Added
 
--   recorder, device structs implemented
--   gainlayers field in strip struct implemented
--   levels field in strip, bus structs implemented
--   pooler ratelimit set at 33ms
+- recorder, device structs implemented
+- gainlayers field in strip struct implemented
+- levels field in strip, bus structs implemented
+- pooler ratelimit set at 33ms
 
 ## [0.0.3] - 2022-06-25
 
 ### Added
 
--   pre-commit.ps1 added for use with git hook
--   unit tests for factory functions added
--   vban parameter methods added
--   support for observers added. publisher/observer structs defined
--   Pooler struct added, pdirty, mdirty now updated continously in a goroutine
+- pre-commit.ps1 added for use with git hook
+- unit tests for factory functions added
+- vban parameter methods added
+- support for observers added. publisher/observer structs defined
+- Pooler struct added, pdirty, mdirty now updated continously in a goroutine
 
 ### Changed
 
--   NewRemote factory method now uses director, builder types to create Remote types.
--   cdll renamed to path
--   test suite now using testify/assert
+- NewRemote factory method now uses director, builder types to create Remote types.
+- cdll renamed to path
+- test suite now using testify/assert
 
 ## [0.0.2] - 2022-06-23
 
 ### Added
 
--   physicalStrip, virtualStrip, physicalBus and virtualBus types defined.
--   factory methods for strip, bus now cast return values to interface types.
--   parameter methods added to strip, bus types.
--   command struct implemented
--   bus, vban unit tests added
+- physicalStrip, virtualStrip, physicalBus and virtualBus types defined.
+- factory methods for strip, bus now cast return values to interface types.
+- parameter methods added to strip, bus types.
+- command struct implemented
+- bus, vban unit tests added
 
 ### Changed
 
--   strip, bus slices in remote type defined as interface slice types.
--   bindings in base now prepended with vm.
--   vban fields added to kind structs
+- strip, bus slices in remote type defined as interface slice types.
+- bindings in base now prepended with vm.
+- vban fields added to kind structs
 
 ## [0.0.1] - 2022-06-22
 
 ### Added
 
--   interface entry point defined in remote
--   some base functions are exported through forwarding methods in Remote type (Login, Logout etc)
--   wrapper around the CAPI defined in base
--   path helper functions defined in cdll
--   kind structs defined in kinds. These describe the layout for each version.
--   channel, strip, bus structs getter/setter procedures defined.
--   button struct fully implemented.
--   initial test commit
+- interface entry point defined in remote
+- some base functions are exported through forwarding methods in Remote type (Login, Logout etc)
+- wrapper around the CAPI defined in base
+- path helper functions defined in cdll
+- kind structs defined in kinds. These describe the layout for each version.
+- channel, strip, bus structs getter/setter procedures defined.
+- button struct fully implemented.
+- initial test commit

README.md

@@ -1,21 +1,19 @@
 [![Go Reference](https://pkg.go.dev/badge/github.com/onyx-and-iris/voicemeeter.svg)](https://pkg.go.dev/github.com/onyx-and-iris/voicemeeter/v2)
 
-# A Go Wrapper for Voicemeeter API
-
-This package offers a Go interface for the Voicemeeter Remote C API.
+# A Go Wrapper for the Voicemeeter API
 
 For an outline of past/future changes refer to: [CHANGELOG](CHANGELOG.md)
 
 ## Tested against
 
--   Basic 1.0.8.8
--   Banana 2.0.6.8
--   Potato 3.0.2.8
+- Basic 1.1.1.1
+- Banana 2.1.1.1
+- Potato 3.1.1.1
 
 ## Requirements
 
--   [Voicemeeter](https://voicemeeter.com/)
--   Go 1.18 or greater
+- [Voicemeeter](https://voicemeeter.com/)
+- Go 1.18 or greater
 
 ## Installation
 
@@ -67,15 +65,15 @@ func vmConnect() (*voicemeeter.Remote, error) {
 }
 ```
 
-## `voicemeeter.NewRemote(<kindId>, <delay>)`
+## `voicemeeter.NewRemote(<kindId>, <delay>, opts ...Option)`
 
 ### `kindId`
 
 Pass the kind of Voicemeeter as an argument. kindId may be:
 
--   `basic`
--   `banana`
--   `potato`
+- `basic`
+- `banana`
+- `potato`
 
 ### `delay`
 
@@ -83,6 +81,18 @@ Pass a delay in milliseconds to force the getters to wait for dirty parameters t
 
 Useful if not listening for event updates.
 
+### `voicemeeter.WithTimeout(timeout int)`
+
+Set a login timeout, defaults to 2 seconds. For example to set it to 1s:
+
+`voicemeeter.NewRemote("banana", 20, voicemeeter.WithTimeout(1))`
+
+### `voicemeeter.WithBits(bits int)`
+
+Override the type of Voicemeeter GUI to launch on 64 bit systems. For example, to force 32 bit GUI:
+
+`voicemeeter.NewRemote("banana", 20, voicemeeter.WithBits(32))`
+
 ## `Remote Type`
 
 #### `vm.Strip`
@@ -179,28 +189,28 @@ Use this to force dirty parameters to clear after a delay in milliseconds.
 
 The following methods are available
 
--   `Mute() bool`
--   `SetMute(val bool)`
--   `Mono() bool`
--   `SetMono(val bool)`
--   `Solo() bool`
--   `SetSolo(val bool)`
--   `Limit() int`
--   `SetLimit(val int)` from -40 to 12
--   `Label() string`
--   `SetLabel(val string)`
--   `Gain() float64`
--   `SetGain(val float64)` from -60.0 to 12.0
--   `Mc() bool`
--   `SetMc(val bool)`
--   `Audibility() float64`
--   `SetAudibility(val float64)` from 0.0 to 10.0
--   `A1() bool - A5() bool`
--   `SetA1(val bool) - SetA5(val bool)`
--   `B1() bool - B3() bool`
--   `SetB1(val bool) bool - SetB3(val bool) bool`
--   `AppGain(name string, gain float64)`
--   `AppMute(name string, val bool)`
+- `Mute() bool`
+- `SetMute(val bool)`
+- `Mono() bool`
+- `SetMono(val bool)`
+- `Solo() bool`
+- `SetSolo(val bool)`
+- `Limit() int`
+- `SetLimit(val int)` from -40 to 12
+- `Label() string`
+- `SetLabel(val string)`
+- `Gain() float64`
+- `SetGain(val float64)` from -60.0 to 12.0
+- `Mc() bool`
+- `SetMc(val bool)`
+- `Audibility() float64`
+- `SetAudibility(val float64)` from 0.0 to 10.0
+- `A1() bool - A5() bool`
+- `SetA1(val bool) - SetA5(val bool)`
+- `B1() bool - B3() bool`
+- `SetB1(val bool) bool - SetB3(val bool) bool`
+- `AppGain(name string, gain float64)`
+- `AppMute(name string, val bool)`
 
 example:
 
@@ -215,28 +225,28 @@ vm.Strip[5].AppMute("Spotify", true)
 
 ##### Comp
 
--   `vm.Strip[i].Comp()`
+- `vm.Strip[i].Comp()`
 
 The following methods are available
 
--   `Knob() float64`
--   `SetKnob(val float64)` from 0.0 to 10.0
--   `GainIn() float64`
--   `SetGainIn(val float64)` from -24.0 to 24.0
--   `Ratio() float64`
--   `SetRatio(val float64)` from 1.0 to 8.0
--   `Threshold() float64`
--   `SetThreshold(val float64)` from -40.0 to -3.0
--   `Attack() float64`
--   `SetAttack(val float64)` from 0.0 to 200.0
--   `Release() float64`
--   `SetRelease(val float64)` from 0.0 to 5000.0
--   `Knee() float64`
--   `SetKnee(val float64)` from 0.0 to 1.0
--   `GainOut() float64`
--   `SetGainOut(val float64)` from -24.0 to 24.0
--   `MakeUp() bool`
--   `SetMakeUp(val bool)`
+- `Knob() float64`
+- `SetKnob(val float64)` from 0.0 to 10.0
+- `GainIn() float64`
+- `SetGainIn(val float64)` from -24.0 to 24.0
+- `Ratio() float64`
+- `SetRatio(val float64)` from 1.0 to 8.0
+- `Threshold() float64`
+- `SetThreshold(val float64)` from -40.0 to -3.0
+- `Attack() float64`
+- `SetAttack(val float64)` from 0.0 to 200.0
+- `Release() float64`
+- `SetRelease(val float64)` from 0.0 to 5000.0
+- `Knee() float64`
+- `SetKnee(val float64)` from 0.0 to 1.0
+- `GainOut() float64`
+- `SetGainOut(val float64)` from -24.0 to 24.0
+- `MakeUp() bool`
+- `SetMakeUp(val bool)`
 
 example:
 
@@ -246,24 +256,24 @@ vm.Strip[3].Comp().SetRatio(3.5)
 
 ##### Gate
 
--   `vm.Strip[i].Gate()`
+- `vm.Strip[i].Gate()`
 
 The following methods are available
 
--   `Knob() float64`
--   `SetKnob(val float64)` from 0.0 to 10.0
--   `Threshold() float64`
--   `SetThreshold(val float64)` from -60.0 to -10.0
--   `Damping() float64`
--   `SetDamping(val float64)` from -60.0 to -10.0
--   `BPSidechain() int`
--   `SetBPSidechain(val int)` from 100 to 4000
--   `Attack() float64`
--   `SetAttack(val float64)` from 0.0 to 1000.0
--   `Hold() float64`
--   `SetHold(val float64)` from 0.0 to 5000.0
--   `Release() float64`
--   `SetRelease(val float64)` from 0.0 to 5000.0
+- `Knob() float64`
+- `SetKnob(val float64)` from 0.0 to 10.0
+- `Threshold() float64`
+- `SetThreshold(val float64)` from -60.0 to -10.0
+- `Damping() float64`
+- `SetDamping(val float64)` from -60.0 to -10.0
+- `BPSidechain() int`
+- `SetBPSidechain(val int)` from 100 to 4000
+- `Attack() float64`
+- `SetAttack(val float64)` from 0.0 to 1000.0
+- `Hold() float64`
+- `SetHold(val float64)` from 0.0 to 5000.0
+- `Release() float64`
+- `SetRelease(val float64)` from 0.0 to 5000.0
 
 example:
 
@@ -273,12 +283,12 @@ fmt.Println(vm.Strip[4].Gate().Attack())
 
 ##### Denoiser
 
--   `vm.Strip[i].Denoiser()`
+- `vm.Strip[i].Denoiser()`
 
 The following methods are available
 
--   `Knob() float64`
--   `SetKnob(val float64)` from 0.0 to 10.0
+- `Knob() float64`
+- `SetKnob(val float64)` from 0.0 to 10.0
 
 example:
 
@@ -288,12 +298,12 @@ vm.Strip[1].Denoiser().SetKnob(4.2)
 
 ##### Gainlayer
 
--   `vm.Strip[i].Gainlayer()[j]`
+- `vm.Strip[i].Gainlayer()[j]`
 
 The following methods are available
 
--   `Get() float64`
--   `Set(val float64)`
+- `Get() float64`
+- `Set(val float64)`
 
 example:
 
@@ -303,13 +313,13 @@ vm.Strip[6].GainLayer()[3].Set(-13.6)
 
 ##### Levels
 
--   `vm.Strip[i].Levels()`
+- `vm.Strip[i].Levels()`
 
 The following methods are available
 
--   `PreFader() []float64`
--   `PostFader() []float64`
--   `PostMute() []float64`
+- `PreFader() []float64`
+- `PostFader() []float64`
+- `PostMute() []float64`
 
 example:
 
@@ -321,15 +331,15 @@ fmt.Println(vm.Strip[5].Levels().PreFader())
 
 The following methods are available
 
--   `String() string`
--   `Mute() bool`
--   `SetMute(val bool)`
--   `Mono() bool`
--   `SetMono(val bool)`
--   `Label() string`
--   `SetLabel(val string)`
--   `Gain() float64`
--   `SetGain(val float64)` from -60.0 to 12.0
+- `String() string`
+- `Mute() bool`
+- `SetMute(val bool)`
+- `Mono() bool`
+- `SetMono(val bool)`
+- `Label() string`
+- `SetLabel(val string)`
+- `Gain() float64`
+- `SetGain(val float64)` from -60.0 to 12.0
 
 example:
 
@@ -340,34 +350,34 @@ fmt.Println(vm.Bus[0].Label())
 
 ##### Modes
 
--   `vm.Bus[i].Mode()`
+- `vm.Bus[i].Mode()`
 
 The following methods are available
 
--   `SetNormal(val bool)`
--   `Normal() bool`
--   `SetAmix(val bool)`
--   `Amix() bool`
--   `SetBmix(val bool)`
--   `Bmix() bool`
--   `SetRepeat(val bool)`
--   `Repeat() bool`
--   `SetComposite(val bool)`
--   `Composite() bool`
--   `SetTvMix(val bool)`
--   `TvMix() bool`
--   `SetUpMix21(val bool)`
--   `UpMix21() bool`
--   `SetUpMix41(val bool)`
--   `UpMix41() bool`
--   `SetUpMix61(val bool)`
--   `UpMix61() bool`
--   `SetCenterOnly(val bool)`
--   `CenterOnly() bool`
--   `SetLfeOnly(val bool)`
--   `LfeOnly() bool`
--   `SetRearOnly(val bool)`
--   `RearOnly() bool`
+- `SetNormal(val bool)`
+- `Normal() bool`
+- `SetAmix(val bool)`
+- `Amix() bool`
+- `SetBmix(val bool)`
+- `Bmix() bool`
+- `SetRepeat(val bool)`
+- `Repeat() bool`
+- `SetComposite(val bool)`
+- `Composite() bool`
+- `SetTvMix(val bool)`
+- `TvMix() bool`
+- `SetUpMix21(val bool)`
+- `UpMix21() bool`
+- `SetUpMix41(val bool)`
+- `UpMix41() bool`
+- `SetUpMix61(val bool)`
+- `UpMix61() bool`
+- `SetCenterOnly(val bool)`
+- `CenterOnly() bool`
+- `SetLfeOnly(val bool)`
+- `LfeOnly() bool`
+- `SetRearOnly(val bool)`
+- `RearOnly() bool`
 
 example:
 
@@ -378,11 +388,11 @@ vm.Bus[4].Mode().SetCenterOnly(true)
 
 ##### Levels
 
--   `vm.Bus[i].Levels()`
+- `vm.Bus[i].Levels()`
 
 The following methods are available
 
--   `All() []float64`
+- `All() []float64`
 
 example:
 
@@ -394,14 +404,14 @@ fmt.Println(vm.Bus[1].Levels().All())
 
 ##### EQ
 
--   `vm.Strip[i].Eq()` `vm.Bus[i].Eq()`
+- `vm.Strip[i].Eq()` `vm.Bus[i].Eq()`
 
 The following methods are available.
 
--   `On() bool`
--   `SetOn(val bool)`
--   `Ab() bool`
--   `SetAb(val bool)`
+- `On() bool`
+- `SetOn(val bool)`
+- `Ab() bool`
+- `SetAb(val bool)`
 
 example:
 
@@ -412,8 +422,8 @@ fmt.Println(vm.Bus[3].Eq().Ab())
 
 The following methods are available.
 
--   `FadeTo(target float64, time_ int)`: float, int
--   `FadeBy(change float64, time_ int)`: float, int
+- `FadeTo(target float64, time_ int)`: float, int
+- `FadeBy(change float64, time_ int)`: float, int
 
 Modify gain to or by the selected amount in db over a time interval in ms.
 
@@ -428,12 +438,12 @@ vm.Bus[3].FadeTo(-12.8, 500)
 
 The following methods are available
 
--   `State() bool`
--   `SetState(val bool)`
--   `StateOnly() bool`
--   `SetStateOnly(val bool)`
--   `Trigger() bool`
--   `SetTrigger(val bool)`
+- `State() bool`
+- `SetState(val bool)`
+- `StateOnly() bool`
+- `SetStateOnly(val bool)`
+- `Trigger() bool`
+- `SetTrigger(val bool)`
 
 example:
 
@@ -446,11 +456,11 @@ fmt.Println(vm.Button[64].StateOnly())
 
 The following methods are available
 
--   `Show()` Show Voicemeeter GUI if it's hidden
--   `Hide()` Hide Voicemeeter GUI if it's shown
--   `Shutdown()` Shuts down the GUI
--   `Restart()` Restart the audio engine
--   `Lock(val bool)` Lock the Voicemeeter GUI
+- `Show()` Show Voicemeeter GUI if it's hidden
+- `Hide()` Hide Voicemeeter GUI if it's shown
+- `Shutdown()` Shuts down the GUI
+- `Restart()` Restart the audio engine
+- `Lock(val bool)` Lock the Voicemeeter GUI
 
 example:
 
@@ -461,32 +471,32 @@ vm.Command.Show()
 
 ### VBAN
 
--   `vm.Vban.Enable()` `vm.Vban.Disable()` Turn VBAN on or off
+- `vm.Vban.Enable()` `vm.Vban.Disable()` Turn VBAN on or off
 
 ##### Instream | Outstream
 
--   `vm.Vban.InStream[i]` `vm.Vban.OutStream[i]`
+- `vm.Vban.InStream[i]` `vm.Vban.OutStream[i]`
 
 The following methods are available
 
--   `On() bool`
--   `SetOn(val bool)`
--   `Name() string`
--   `SetName(val string)`
--   `Ip() string`
--   `SetIp(val string)`
--   `Port() int`
--   `SetPort(val int)` from 1024 to 65535
--   `Sr() int`
--   `SetSr(val int)` (11025, 16000, 22050, 24000, 32000, 44100, 48000, 64000, 88200, 96000)
--   `Channel() int`
--   `SetChannel(val int)` from 1 to 8
--   `Bit() int`
--   `SetBit(val int)` 16 or 24
--   `Quality() int`
--   `SetQuality(val int)` from 0 to 4
--   `Route() int`
--   `SetRoute(val int)` from 0 to 8
+- `On() bool`
+- `SetOn(val bool)`
+- `Name() string`
+- `SetName(val string)`
+- `Ip() string`
+- `SetIp(val string)`
+- `Port() int`
+- `SetPort(val int)` from 1024 to 65535
+- `Sr() int`
+- `SetSr(val int)` (11025, 16000, 22050, 24000, 32000, 44100, 48000, 64000, 88200, 96000)
+- `Channel() int`
+- `SetChannel(val int)` from 1 to 8
+- `Bit() int`
+- `SetBit(val int)` 16 or 24
+- `Quality() int`
+- `SetQuality(val int)` from 0 to 4
+- `Route() int`
+- `SetRoute(val int)` from 0 to 8
 
 example:
 
@@ -505,10 +515,10 @@ vm.Vban.OutStream[3].SetBit(24)
 
 The following methods are available
 
--   `Ins()`
--   `Outs()`
--   `Input(val int)`
--   `Output(val int)`
+- `Ins()`
+- `Outs()`
+- `Input(val int)`
+- `Output(val int)`
 
 example:
 
@@ -522,13 +532,13 @@ for i := 0; i < int(vm.Device.Ins()); i++ {
 
 The following methods are available
 
--   `Play()`
--   `Stop()`
--   `Pause()`
--   `Replay()`
--   `Record()`
--   `Ff()`
--   `Rew()`
+- `Play()`
+- `Stop()`
+- `Pause()`
+- `Replay()`
+- `Record()`
+- `Ff()`
+- `Rew()`
 
 example:
 
@@ -547,9 +557,9 @@ vm.Recorder.SetB2(false)
 
 The following methods are available
 
--   `Channel()` returns the current midi channel
--   `Current()` returns the most recently pressed midi button
--   `Get(<button>)` returns the value in cache for the midi button
+- `Channel()` returns the current midi channel
+- `Current()` returns the most recently pressed midi button
+- `Get(<button>)` returns the value in cache for the midi button
 
 example:
 
@@ -562,10 +572,10 @@ var val = vm.Midi.Get(current)
 
 By default level updates are disabled. Any event may be enabled or disabled. The following events exist:
 
--   `pdirty` parameter updates
--   `mdirty` macrobutton updates
--   `midi` midi updates
--   `ldirty` level updates
+- `pdirty` parameter updates
+- `mdirty` macrobutton updates
+- `midi` midi updates
+- `ldirty` level updates
 
 example:
 
@@ -587,4 +597,4 @@ go test ./...
 
 ### Official Documentation
 
--   [Voicemeeter Remote C API](https://github.com/onyx-and-iris/Voicemeeter-SDK/blob/update-docs/VoicemeeterRemoteAPI.pdf)
+- [Voicemeeter Remote C API](https://github.com/onyx-and-iris/Voicemeeter-SDK/blob/main/VoicemeeterRemoteAPI.pdf)

base.go

@@ -2,8 +2,10 @@ package voicemeeter
 
 import (
 	"bytes"
+	"errors"
 	"fmt"
 	"math"
+	"runtime"
 	"strings"
 	"syscall"
 	"time"
@@ -45,16 +47,29 @@ var (
 // login logs into the API,
 // attempts to launch Voicemeeter if it's not running,
 // initializes dirty parameters.
-func login(kindId string) error {
+func login(kindId string, timeout, bits int) error {
 	res, _, _ := vmLogin.Call()
 	if res == 1 {
-		runVoicemeeter(kindId)
-		time.Sleep(time.Second)
+		runVoicemeeter(kindId, bits)
 	} else if res != 0 {
 		err := fmt.Errorf("VBVMR_Login returned %d", res)
 		return err
 	}
-	log.Info("Logged into Voicemeeter ", kindId)
+
+	var ver_s string
+	start := time.Now()
+	var err error
+	for time.Since(start).Seconds() < float64(timeout) {
+		time.Sleep(time.Duration(100) * time.Millisecond)
+		if ver_s, err = getVersion(); err == nil {
+			log.Infof("Logged into Voicemeeter %s v%s", kindMap[kindId], ver_s)
+			log.Debugf("Log in time: %.2f", time.Since(start).Seconds())
+			break
+		}
+	}
+	if err != nil {
+		return errors.New("timeout logging into the API")
+	}
 	clear()
 	return nil
 }
@@ -68,18 +83,22 @@ func logout(kindId string) error {
 		err := fmt.Errorf("VBVMR_Logout returned %d", int32(res))
 		return err
 	}
-	log.Info("Logged out of Voicemeeter ", kindId)
+	log.Infof("Logged out of Voicemeeter %s", kindMap[kindId])
 	return nil
 }
 
 // runVoicemeeter attempts to launch a Voicemeeter GUI of a kind.
-func runVoicemeeter(kindId string) error {
+func runVoicemeeter(kindId string, bits int) error {
 	vals := map[string]uint64{
 		"basic":  1,
 		"banana": 2,
 		"potato": 3,
 	}
-	res, _, _ := vmRunvm.Call(uintptr(vals[kindId]))
+	val := vals[kindId]
+	if strings.Contains(runtime.GOARCH, "64") && bits == 64 {
+		val += 3
+	}
+	res, _, _ := vmRunvm.Call(uintptr(val))
 	if int32(res) != 0 {
 		err := fmt.Errorf("VBVMR_RunVoicemeeter returned %d", int32(res))
 		return err
@@ -93,6 +112,7 @@ func getVersion() (string, error) {
 	res, _, _ := vmGetvmVersion.Call(uintptr(unsafe.Pointer(&ver)))
 	if int32(res) != 0 {
 		err := fmt.Errorf("VBVMR_GetVoicemeeterVersion returned %d", int32(res))
+		log.Error(err.Error())
 		return "", err
 	}
 	v1 := (ver & 0xFF000000) >> 24

examples/hotkeys/go.mod

@@ -1,4 +1,4 @@
-module main
+module hotkeys
 
 go 1.19
 

examples/obs/go.mod

@@ -1,4 +1,4 @@
-module main
+module obs
 
 go 1.18
 

examples/vm-cli/README.md

@@ -1,6 +1,6 @@
 ## About
 
-A simple voicemeeter-cli program. Offers ability to toggle, get and set parameters.
+A Voicemeeter CLI, offers ability to toggle, get and set parameters.
 
 ## Install
 
@@ -8,28 +8,32 @@ First build and install it with `go install` (skip this step if using binary fro
 
 ## Use
 
-Toggle with `!` prefix, get by excluding `=` and set by including `=`. Mix and match arguments.
+Commands that begin with `!` will toggle a parameter, commands that contain `=` will set a parameter, all other commands will get a value.
 
 You may pass the following optional flags:
 
--   -v: (-verbose) to toggle console output.
--   -i: (-interactive) to toggle interactive mode.
--   -k: (-kind) to set the kind of Voicemeeter. Defaults to banana.
--   -d: (-delay) to set a delay on the getters. Defaults to 20ms.
+- -h: Print the help message
+- -i: Enable interactive mode
+- -k: The kind of Voicemeeter GUI to launch, defaults to Banana
+- -l: Log level (0 up to 6), defaults to 3, Warn Level
+- -d: Set the delay between commands, defaults to 20ms
+- -v: Enable extra console output (toggle and set messages).
 
 for example:
 
-`vm-cli.exe -v -k=potato -d=25 strip[0].mute=0 strip[0].mute !strip[0].mute strip[0].mute bus[0].gain=-8.8 command.lock=1`
+`vm-cli.exe -v -l=4 -k=potato strip[0].mute=0 strip[0].mute !strip[0].mute strip[0].mute bus[0].gain=-8.8 command.lock=1`
 
 Expected output:
 
 ```
-Running command strip[0].mute=0
-Value of strip[0].mute is: 0
+time="<timestamp>" level=info msg="Logged into Voicemeeter Potato v3.1.1.1"
+Setting strip[0].mute=0
+strip[0].mute: 0.00
 Toggling strip[0].mute
-Value of strip[0].mute is: 1
-Running command bus[0].gain=-8.8
-Running command command.lock=1
+strip[0].mute: 1.00
+Setting bus[0].gain=-8.8
+Setting command.lock=1
+time="<timestamp>" level=info msg="Logged out of Voicemeeter Potato"
 ```
 
-If running in interactive mode enter `q`, `quit` or `<Enter>` to exit.
+If running in interactive mode enter `Q`, to exit.

examples/vm-cli/main.go

@@ -4,26 +4,36 @@ import (
 	"bufio"
 	"flag"
 	"fmt"
-	"log"
 	"os"
 	"strings"
 
+	log "github.com/sirupsen/logrus"
+
 	"github.com/onyx-and-iris/voicemeeter/v2"
 )
 
-type (
-	verbosePrinter struct {
-		verbose bool
-	}
+const (
+	FLOAT = iota
+	STRING
 )
 
+type result struct {
+	kind        int
+	stringParam string
+	floatParam  float64
+}
+
+type verbosePrinter struct {
+	verbose bool
+}
+
 func newVerbosePrinter() *verbosePrinter {
 	return &verbosePrinter{}
 }
 
 func (v *verbosePrinter) printf(format string, a ...interface{}) {
 	if v.verbose {
-		fmt.Printf(format+"\n", a...)
+		fmt.Printf(format, a...)
 	}
 }
 
@@ -40,28 +50,68 @@ func main() {
 		kind        string
 		delay       int
 		interactive bool
+		loglevel    int
+		help        bool
 	)
 
+	flag.Usage = usage
+
+	flag.BoolVar(&help, "help", false, "print the help message")
+	flag.BoolVar(&help, "h", false, "print the help message (shorthand)")
 	flag.StringVar(&kind, "kind", "banana", "kind of voicemeeter")
 	flag.StringVar(&kind, "k", "banana", "kind of voicemeeter (shorthand)")
 	flag.IntVar(&delay, "delay", 20, "delay between commands")
 	flag.IntVar(&delay, "d", 20, "delay between commands (shorthand)")
-	flag.BoolVar(&vPrinter.verbose, "verbose", false, "toggle console output")
-	flag.BoolVar(&vPrinter.verbose, "v", false, "toggle console output (shorthand)")
 	flag.BoolVar(&interactive, "interactive", false, "toggle interactive mode")
 	flag.BoolVar(&interactive, "i", false, "toggle interactive mode (shorthand)")
+	flag.IntVar(&loglevel, "loglevel", int(log.WarnLevel), "set the log level")
+	flag.IntVar(&loglevel, "l", int(log.WarnLevel), "set the log level (shorthand)")
+	flag.BoolVar(&vPrinter.verbose, "verbose", false, "enable extra console output (toggle and set messages)")
+	flag.BoolVar(&vPrinter.verbose, "v", false, "enable extra console output (toggle and set messages) (shorthand)")
 	flag.Parse()
 
+	if help {
+		flag.Usage()
+		return
+	}
+
+	if loglevel >= int(log.PanicLevel) && loglevel <= int(log.TraceLevel) {
+		log.SetLevel(log.Level(loglevel))
+	}
+
 	vm, err := vmConnect(kind, delay)
 	if err != nil {
 		log.Fatal(err)
 	}
 	defer vm.Logout()
 
-	err = runCommands(vm, interactive)
-	if err != nil {
-		fmt.Println(err)
+	if interactive {
+		interactiveMode(vm)
+		return
 	}
+
+	args := flag.Args()
+	if len(args) == 0 {
+		flag.Usage()
+		return
+	}
+
+	for _, arg := range args {
+		if err := parse(vm, arg); err != nil {
+			log.Error(err.Error())
+		}
+	}
+}
+
+func usage() {
+	fmt.Println("usage: ./vm-cli.exe [-h] [-i] [-k] [-l] [-d] [-v]\n" +
+		"Where:\n" +
+		"\th: Print the help message\n" +
+		"\ti: Enable interactive mode\n" +
+		"\tk: The kind of Voicemeeter GUI to launch, defaults to Banana\n" +
+		"\tl: Log level 0 up to 6, (defaults to 3, Warn Level)\n" +
+		"\td: Set the delay between commands (defaults to 20ms)\n" +
+		"\tv: Enable extra console output (toggle and set messages).")
 }
 
 func vmConnect(kind string, delay int) (*voicemeeter.Remote, error) {
@@ -78,38 +128,23 @@ func vmConnect(kind string, delay int) (*voicemeeter.Remote, error) {
 	return vm, nil
 }
 
-func runCommands(vm *voicemeeter.Remote, interactive bool) error {
-	if interactive {
-		return interactiveMode(vm)
-	}
-	args := flag.Args()
-	if len(args) == 0 {
-		err := fmt.Errorf("must provide some commands to run")
-		return err
-	}
-	for _, arg := range args {
-		err := parse(vm, arg)
-		if err != nil {
-			vPrinter.printf(err.Error())
-		}
-	}
-	return nil
-}
-
 func interactiveMode(vm *voicemeeter.Remote) error {
-	vPrinter.printf("running in interactive mode... waiting for input")
+	fmt.Println("Interactive mode enabled. Enter 'Q' to exit.")
+
 	scanner := bufio.NewScanner(os.Stdin)
+	fmt.Printf(">> ")
 	for scanner.Scan() {
 		input := scanner.Text()
-		if input == "q" || input == "quit" || input == "" {
-			return nil
+		if strings.ToUpper(input) == "Q" {
+			break
 		}
+
 		for _, cmd := range strings.Split(input, " ") {
-			err := parse(vm, cmd)
-			if err != nil {
-				vPrinter.printf(err.Error())
+			if err := parse(vm, cmd); err != nil {
+				log.Error(err.Error())
 			}
 		}
+		fmt.Printf(">> ")
 	}
 	if scanner.Err() != nil {
 		return scanner.Err()
@@ -119,58 +154,60 @@ func interactiveMode(vm *voicemeeter.Remote) error {
 
 func parse(vm *voicemeeter.Remote, cmd string) error {
 	if cmd[0] == '!' {
-		err := toggleCmd(vm, cmd[1:])
-		if err != nil {
+		if err := toggleCmd(vm, cmd[1:]); err != nil {
+			return err
+		}
+	} else if strings.Contains(cmd, "=") {
+		if err := setCmd(vm, cmd); err != nil {
 			return err
 		}
 	} else {
-		if strings.Contains(cmd, "=") {
-			err := setCmd(vm, cmd)
-			if err != nil {
-				return err
-			}
-		} else {
-			err := getCmd(vm, cmd)
-			if err != nil {
-				return err
-			}
+		r := result{kind: FLOAT}
+		if err := getCmd(vm, cmd, &r); err != nil {
+			return err
+		}
+		switch r.kind {
+		case FLOAT:
+			fmt.Printf("%s: %.2f\n", cmd, r.floatParam)
+		case STRING:
+			fmt.Printf("%s: %s\n", cmd, r.stringParam)
 		}
 	}
 	return nil
 }
 
 func toggleCmd(vm *voicemeeter.Remote, cmd string) error {
-	val, err := vm.GetFloat(cmd)
-	if err != nil {
-		err = fmt.Errorf("unable to toggle %s", cmd)
+	r := result{kind: FLOAT}
+	if err := getCmd(vm, cmd, &r); err != nil {
 		return err
 	}
-	vm.SetFloat(cmd, 1-val)
-	vPrinter.printf("Toggling %s", cmd)
+	if r.kind == FLOAT && (r.floatParam == 0 || r.floatParam == 1) {
+		vPrinter.printf("Toggling %s\n", cmd)
+		vm.SetFloat(cmd, 1-r.floatParam)
+	} else {
+		log.Warnf("%s does not appear to be a boolean parameter", cmd)
+	}
 	return nil
 }
 
 func setCmd(vm *voicemeeter.Remote, cmd string) error {
-	vPrinter.printf("Running command %s", cmd)
-	err := vm.SendText(cmd)
-	if err != nil {
+	if err := vm.SendText(cmd); err != nil {
 		err = fmt.Errorf("unable to set %s", cmd)
 		return err
 	}
+	vPrinter.printf("Setting %s\n", cmd)
+	return nil
+}
+
+func getCmd(vm *voicemeeter.Remote, cmd string, r *result) error {
+	if val, err := vm.GetFloat(cmd); err == nil {
+		r.floatParam = val
+	} else if val, err := vm.GetString(cmd); err == nil {
+		r.kind = STRING
+		r.stringParam = val
+	} else {
+		err := fmt.Errorf("unknown parameter '%s'", cmd)
+		return err
+	}
 	return nil
 }
-
-func getCmd(vm *voicemeeter.Remote, cmd string) error {
-	valF, err := vm.GetFloat(cmd)
-	if err != nil {
-		valS, err := vm.GetString(cmd)
-		if err != nil {
-			err = fmt.Errorf("unable to get %s", cmd)
-			return err
-		}
-		fmt.Printf("Value of %s is: %s", cmd, valS)
-	} else {
-		fmt.Printf("Value of %s is: %v", cmd, valF)
-	}
-	return nil
-}

remote.go

@@ -20,7 +20,9 @@ type Remote struct {
 	Recorder *recorder
 	Midi     *midi_t
 
-	pooler *pooler
+	pooler  *pooler
+	timeout int
+	bits    int
 }
 
 // String implements the fmt.stringer interface
@@ -31,7 +33,7 @@ func (r *Remote) String() string {
 // Login logs into the API
 // then it intializes the pooler
 func (r *Remote) Login() error {
-	err := login(r.Kind.Name)
+	err := login(r.Kind.Name, r.timeout, r.bits)
 	if err != nil {
 		return err
 	}
@@ -57,12 +59,10 @@ func (r *Remote) InitPooler() {
 
 // Run launches the Voicemeeter GUI for a kind.
 func (r *Remote) Run(kindId string) error {
-	err := runVoicemeeter(kindId)
+	err := runVoicemeeter(kindId, r.bits)
 	if err != nil {
 		return err
 	}
-	time.Sleep(time.Second)
-	clear()
 	return nil
 }
 
@@ -173,6 +173,7 @@ type remoteBuilder interface {
 	makeDevice() remoteBuilder
 	makeRecorder() remoteBuilder
 	makeMidi() remoteBuilder
+	setDefaults() remoteBuilder
 	Build() remoteBuilder
 	Get() *Remote
 }
@@ -212,7 +213,7 @@ func (b *genericBuilder) setKind() remoteBuilder {
 // makeStrip makes a strip slice and assigns it to remote.Strip
 // []iStrip comprises of both physical and virtual strip types
 func (b *genericBuilder) makeStrip() remoteBuilder {
-	log.Info("building strip")
+	log.Debug("building strip")
 	strip := make([]iStrip, b.k.NumStrip())
 	for i := 0; i < b.k.NumStrip(); i++ {
 		if i < b.k.PhysIn {
@@ -228,7 +229,7 @@ func (b *genericBuilder) makeStrip() remoteBuilder {
 // makeBus makes a bus slice and assigns it to remote.Bus
 // []t_bus comprises of both physical and virtual bus types
 func (b *genericBuilder) makeBus() remoteBuilder {
-	log.Info("building bus")
+	log.Debug("building bus")
 	bus := make([]iBus, b.k.NumBus())
 	for i := 0; i < b.k.NumBus(); i++ {
 		if i < b.k.PhysOut {
@@ -243,7 +244,7 @@ func (b *genericBuilder) makeBus() remoteBuilder {
 
 // makeButton makes a button slice and assigns it to remote.Button
 func (b *genericBuilder) makeButton() remoteBuilder {
-	log.Info("building button")
+	log.Debug("building button")
 	button := make([]button, 80)
 	for i := 0; i < 80; i++ {
 		button[i] = newButton(i)
@@ -254,39 +255,46 @@ func (b *genericBuilder) makeButton() remoteBuilder {
 
 // makeCommand makes a command type and assigns it to remote.Command
 func (b *genericBuilder) makeCommand() remoteBuilder {
-	log.Info("building command")
+	log.Debug("building command")
 	b.r.Command = newCommand()
 	return b
 }
 
 // makeVban makes a vban type and assigns it to remote.Vban
 func (b *genericBuilder) makeVban() remoteBuilder {
-	log.Info("building vban")
+	log.Debug("building vban")
 	b.r.Vban = newVban(b.k)
 	return b
 }
 
 // makeDevice makes a device type and assigns it to remote.Device
 func (b *genericBuilder) makeDevice() remoteBuilder {
-	log.Info("building device")
+	log.Debug("building device")
 	b.r.Device = newDevice()
 	return b
 }
 
 // makeRecorder makes a recorder type and assigns it to remote.Recorder
 func (b *genericBuilder) makeRecorder() remoteBuilder {
-	log.Info("building recorder")
+	log.Debug("building recorder")
 	b.r.Recorder = newRecorder()
 	return b
 }
 
 // makeMidi makes a midi type and assigns it to remote.Midi
 func (b *genericBuilder) makeMidi() remoteBuilder {
-	log.Info("building midi")
+	log.Debug("building midi")
 	b.r.Midi = newMidi()
 	return b
 }
 
+// setDefaults sets defaults for optional members
+func (b *genericBuilder) setDefaults() remoteBuilder {
+	b.r.bits = 64
+	b.r.timeout = 2
+	return b
+}
+
 // Get returns a fully constructed remote type for a kind
 func (b *genericBuilder) Get() *Remote {
 	return &b.r
@@ -306,7 +314,8 @@ func (basb *genericBuilder) Build() remoteBuilder {
 		makeCommand().
 		makeVban().
 		makeDevice().
-		makeMidi()
+		makeMidi().
+		setDefaults()
 }
 
 // bananaBuilder represents a builder specific to banana type
@@ -324,7 +333,8 @@ func (banb *bananaBuilder) Build() remoteBuilder {
 		makeVban().
 		makeDevice().
 		makeRecorder().
-		makeMidi()
+		makeMidi().
+		setDefaults()
 }
 
 // potatoBuilder represents a builder specific to potato type
@@ -342,7 +352,8 @@ func (potb *potatoBuilder) Build() remoteBuilder {
 		makeVban().
 		makeDevice().
 		makeRecorder().
-		makeMidi()
+		makeMidi().
+		setDefaults()
 }
 
 var (
@@ -350,6 +361,22 @@ var (
 	vmdelay int
 )
 
+type Option func(*Remote)
+
+func WithTimeout(timeout int) Option {
+	return func(r *Remote) {
+		r.timeout = timeout
+	}
+}
+
+func WithBits(bits int) Option {
+	return func(r *Remote) {
+		if bits == 32 || bits == 64 {
+			r.bits = bits
+		}
+	}
+}
+
 func init() {
 	log.SetOutput(os.Stdout)
 	log.SetLevel(log.WarnLevel)
@@ -357,7 +384,7 @@ func init() {
 
 // NewRemote returns a Remote type for a kind
 // this is the interface entry point
-func NewRemote(kindId string, delay int) (*Remote, error) {
+func NewRemote(kindId string, delay int, opts ...Option) (*Remote, error) {
 	kind, ok := kindMap[kindId]
 	if !ok {
 		err := fmt.Errorf("unknown Voicemeeter kind '%s'", kindId)
@@ -380,5 +407,11 @@ func NewRemote(kindId string, delay int) (*Remote, error) {
 		director.SetBuilder(&potatoBuilder{genericBuilder{kind, Remote{}}})
 	}
 	director.Construct()
-	return director.Get(), nil
+	r := director.Get()
+
+	for _, opt := range opts {
+		opt(r)
+	}
+
+	return r, nil
 }