fix deregister in observer example

minor version bump

CHANGELOG.md

@@ -11,6 +11,22 @@ Before any major/minor/patch bump all unit tests will be run to verify they pass
 
 -   [x]
 
+## [1.3.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.
+
+### 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
+
 ## [1.2.0] - 2022-07-10
 
 ### Added

README.md

@@ -8,9 +8,9 @@ For an outline of past/future changes refer to: [CHANGELOG](CHANGELOG.md)
 
 ## Tested against
 
--   Basic 1.0.8.2
--   Banana 2.0.6.2
--   Potato 3.0.2.2
+-   Basic 1.0.8.4
+-   Banana 2.0.6.4
+-   Potato 3.0.2.4
 
 ## Requirements
 
@@ -48,15 +48,15 @@ import (
 
 func main() {
 	kindId := "banana"
-	vmRem := voicemeeter.NewRemote(kindId)
+	vm := voicemeeter.NewRemote(kindId)
 
-	vmRem.Login()
+	vm.Login()
 
-	vmRem.Strip[0].SetLabel("rode podmic")
-	vmRem.Strip[0].SetMute(true)
-	fmt.Printf("Strip 0 (%s) mute was set to %v\n", vmRem.Strip[0].GetLabel(), vmRem.Strip[0].GetMute())
+	vm.Strip[0].SetLabel("rode podmic")
+	vm.Strip[0].SetMute(true)
+	fmt.Printf("Strip 0 (%s) mute was set to %v\n", vm.Strip[0].GetLabel(), vm.Strip[0].GetMute())
 
-	vmRem.Logout()
+	vm.Logout()
 }
 ```
 
@@ -70,61 +70,89 @@ Pass the kind of Voicemeeter as an argument. kindId may be:
 
 ## `Remote Type`
 
-#### `vmRem.Strip`
+#### `vm.Strip`
 
 []t_strip slice containing both physicalStrip and virtualStrip types
 
-#### `vmRem.Bus`
+#### `vm.Bus`
 
 []t_bus slice containing both physicalBus and virtualBus types
 
-#### `vmRem.Button`
+#### `vm.Button`
 
 []button slice containing button types, one for each macrobutton
 
-#### `vmRem.Command`
+#### `vm.Command`
 
 pointer to command type, represents action type functions
 
-#### `vmRem.Vban`
+#### `vm.Vban`
 
 pointer to vban type, containing both vbanInStream and vbanOutStream slices
 
-#### `vmRem.Device`
+#### `vm.Device`
 
 pointer to device type, represents physical input/output hardware devices
 
-#### `vmRem.Recorder`
+#### `vm.Recorder`
 
 pointer to recorder type, represents the recorder
 
-#### `vmRem.Type()`
+#### `vm.Midi`
+
+pointer to midi type, represents a connected midi device
+
+#### `vm.Type()`
 
 returns the type of Voicemeeter as a string
 
-#### `vmRem.Version()`
+#### `vm.Version()`
 
 returns the version of Voicemeeter as a string
 
-#### `vmRem.SendText(<script>)`
+#### `vm.GetFloat(<param>)`
+
+gets a float parameter value
+
+#### `vm.SetFloat(<param>, <value>)`
+
+sets a float parameter value eg. vm.SetFloat("strip[0].mute", 1)
+
+#### `vm.GetString(<param>)`
+
+gets a string parameter value
+
+#### `vm.SetString(<param>, <value>)`
+
+sets a string parameter value eg. vm.SetString("strip[0].label", "podmic")
+
+#### `vm.SendText(<script>)`
 
 sets many parameters in script format eg. ("Strip[0].Mute=1;Bus[3].Gain=3.6")
 
-#### `vmRem.Register(o observer)`
+#### `vm.Register(o observer)`
 
 register an object as an observer
 
-#### `vmRem.Deregister(o observer)`
+#### `vm.Deregister(o observer)`
 
 deregister an object as an observer
 
-#### `vmRem.Pdirty()`
+#### `vm.EventAdd(<event>)`
+
+adds an event to the pooler eg. vm.EventAdd("ldirty")
+
+#### `vm.EventRemove(<event>)`
+
+removes an event to the pooler eg. vm.EventRemove("pdirty")
+
+#### `vm.Pdirty()`
 
 returns True iff a GUI parameter has changed
 
-#### `vmRem.Mdirty()`
+#### `vm.Mdirty()`
 
-returns True iff a macrobutton paramter has changed
+returns True iff a macrobutton parameter has changed
 
 ## `Available commands`
 
@@ -158,14 +186,14 @@ The following methods are available
 example:
 
 ```go
-vmRem.Strip[3].SetGain(3.7)
-fmt.Println(vmRem.Strip[0].GetLabel())
-vmRem.Strip[4].SetA1(true)
+vm.Strip[3].SetGain(3.7)
+fmt.Println(vm.Strip[0].GetLabel())
+vm.Strip[4].SetA1(true)
 ```
 
 ##### Gainlayers
 
--   `vmRem.Strip[i].GainLayer()[j]`
+-   `vm.Strip[i].GainLayer()[j]`
 
 The following methods are available
 
@@ -175,12 +203,12 @@ The following methods are available
 example:
 
 ```go
-vmRem.Strip[6].GainLayer()[3].Set(-13.6)
+vm.Strip[6].GainLayer()[3].Set(-13.6)
 ```
 
 ##### Levels
 
--   `vmRem.Strip[i].Levels()`
+-   `vm.Strip[i].Levels()`
 
 The following methods are available
 
@@ -191,7 +219,7 @@ The following methods are available
 example:
 
 ```go
-fmt.Println(vmRem.Strip[5].Levels().PreFader())
+fmt.Println(vm.Strip[5].Levels().PreFader())
 ```
 
 ### Bus
@@ -211,13 +239,13 @@ The following methods are available
 -   `SetGain(val float32)` from -60.0 to 12.0
 
 ```go
-vmRem.Bus[3].SetEq(true)
-fmt.Println(vmRem.Bus[0].GetLabel())
+vm.Bus[3].SetEq(true)
+fmt.Println(vm.Bus[0].GetLabel())
 ```
 
 ##### Modes
 
--   `vmRem.Bus[i].Mode()`
+-   `vm.Bus[i].Mode()`
 
 The following methods are available
 
@@ -249,13 +277,13 @@ The following methods are available
 example:
 
 ```go
-vmRem.Bus[3].Mode().SetAmix(true)
-vmRem.Bus[4].Mode().SetCenterOnly(true)
+vm.Bus[3].Mode().SetAmix(true)
+vm.Bus[4].Mode().SetCenterOnly(true)
 ```
 
 ##### Levels
 
--   `vmRem.Bus[i].Levels()`
+-   `vm.Bus[i].Levels()`
 
 The following methods are available
 
@@ -264,7 +292,7 @@ The following methods are available
 example:
 
 ```go
-fmt.Println(vmRem.Bus[1].Levels().All())
+fmt.Println(vm.Bus[1].Levels().All())
 ```
 
 ### Button
@@ -281,8 +309,8 @@ The following methods are available
 example:
 
 ```go
-vmRem.Button[37].SetState(true)
-fmt.Println(vmRem.Button[64].GetStateOnly())
+vm.Button[37].SetState(true)
+fmt.Println(vm.Button[64].GetStateOnly())
 ```
 
 ### Command
@@ -298,17 +326,17 @@ The following methods are available
 example:
 
 ```go
-vmRem.Command.Restart()
-vmRem.Command.Show()
+vm.Command.Restart()
+vm.Command.Show()
 ```
 
 ### VBAN
 
--   `vmRem.Vban.Enable()` `vmRem.Vban.Disable()` Turn VBAN on or off
+-   `vm.Vban.Enable()` `vm.Vban.Disable()` Turn VBAN on or off
 
 ##### Instream | Outstream
 
--   `vmRem.Vban.InStream` `vmRem.Vban.OutStream`
+-   `vm.Vban.InStream` `vm.Vban.OutStream`
 
 The following methods are available
 
@@ -335,29 +363,29 @@ example:
 
 ```go
 # turn VBAN on
-vmRem.Vban.Enable()
+vm.Vban.Enable()
 
 // turn on vban instream 0
-vmRem.Vban.InStream[0].SetOn(true)
+vm.Vban.InStream[0].SetOn(true)
 
 // set bit property for outstream 3 to 24
-vmRem.Vban.OutStream[3].SetBit(24)
+vm.Vban.OutStream[3].SetBit(24)
 ```
 
 ### Device
 
 The following methods are available
 
--   `Ins`
--   `Outs`
+-   `Ins()`
+-   `Outs()`
 -   `Input(val int)`
 -   `Output(val int)`
 
 example:
 
 ```go
-for i := 0; i < int(vmRem.Device.Ins()); i++ {
-	fmt.Println(vmRem.Device.Input(i))
+for i := 0; i < int(vm.Device.Ins()); i++ {
+	fmt.Println(vm.Device.Input(i))
 }
 ```
 
@@ -376,14 +404,46 @@ The following methods are available
 example:
 
 ```go
-vmRem.Recorder.Play()
-vmRem.Recorder.Stop()
+vm.Recorder.Play()
+vm.Recorder.Stop()
 
 # Enable loop play
-vmRem.Recorder.Loop(true)
+vm.Recorder.Loop(true)
 
 # Disable recorder out channel B2
-vmRem.Recorder.SetB2(false)
+vm.Recorder.SetB2(false)
+```
+
+### Midi
+
+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
+
+example:
+
+```go
+var current = vm.Midi.Current()
+var val = vm.Midi.Get(current)
+```
+
+### Events
+
+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
+
+example:
+
+```go
+vm.EventAdd("ldirty")
+
+vm.EventRemove("pdirty")
 ```
 
 ### Run tests

base.go

@@ -37,6 +37,8 @@ var (
 	vmMdirty         = mod.NewProc("VBVMR_MacroButton_IsDirty")
 	vmGetMacroStatus = mod.NewProc("VBVMR_MacroButton_GetStatus")
 	vmSetMacroStatus = mod.NewProc("VBVMR_MacroButton_SetStatus")
+
+	vmGetMidiMessage = mod.NewProc("VBVMR_GetMidiMessage")
 )
 
 // login logs into the API,
@@ -115,18 +117,18 @@ func mdirty() bool {
 
 // ldirty returns true iff a level value has changed
 func ldirty(k *kind) bool {
-	_levelCache.stripLevelsBuff = make([]float32, (2*k.physIn)+(8*k.virtIn))
-	_levelCache.busLevelsBuff = make([]float32, 8*k.numBus())
+	_levelCache.stripLevelsBuff = make([]float32, (2*k.PhysIn)+(8*k.VirtIn))
+	_levelCache.busLevelsBuff = make([]float32, 8*k.NumBus())
 
-	for i := 0; i < (2*k.physIn)+(8*k.virtIn); i++ {
+	for i := 0; i < (2*k.PhysIn)+(8*k.VirtIn); i++ {
 		_levelCache.stripLevelsBuff[i] = float32(getLevel(_levelCache.stripMode, i))
 		_levelCache.stripComp[i] = _levelCache.stripLevelsBuff[i] == _levelCache.stripLevels[i]
 	}
-	for i := 0; i < 8*k.numBus(); i++ {
+	for i := 0; i < 8*k.NumBus(); i++ {
 		_levelCache.busLevelsBuff[i] = float32(getLevel(3, i))
 		_levelCache.busComp[i] = _levelCache.busLevelsBuff[i] == _levelCache.busLevels[i]
 	}
-	return !(allTrue(_levelCache.stripComp, (2*k.physIn)+(8*k.virtIn)) && allTrue(_levelCache.busComp, 8*k.numBus()))
+	return !(allTrue(_levelCache.stripComp, (2*k.PhysIn)+(8*k.VirtIn)) && allTrue(_levelCache.busComp, 8*k.NumBus()))
 }
 
 // getVMType returns the type of Voicemeeter, as a string
@@ -315,3 +317,34 @@ func getLevel(type_, i int) float32 {
 	}
 	return val
 }
+
+// getMidiMessage gets midi channel, pitch and velocity for a single midi input
+func getMidiMessage() bool {
+	var midi = newMidi()
+	var b1 [1024]byte
+	res, _, _ := vmGetMidiMessage.Call(
+		uintptr(unsafe.Pointer(&b1[0])),
+		uintptr(1024),
+	)
+	if int(res) < 0 {
+		err := fmt.Errorf("VBVMR_GetMidiMessage returned %d", res)
+		fmt.Println(err)
+		os.Exit(1)
+	}
+	msg := bytes.Trim(b1[:], "\x00")
+	if len(msg) > 0 {
+		for i := 0; i < len(msg)%3; i++ {
+			msg = append(msg, 0)
+		}
+
+		for i := 0; i < len(msg); i += 3 {
+			var ch = int(msg[i])
+			var pitch = int(msg[i+1])
+			var vel = int(msg[i+2])
+			midi.channel = ch
+			midi.current = pitch
+			midi.cache[pitch] = vel
+		}
+	}
+	return len(msg) > 0
+}

examples/observer/observer.go

@@ -2,7 +2,6 @@ package main
 
 import (
 	"fmt"
-	"strings"
 	"time"
 
 	"github.com/onyx-and-iris/voicemeeter-api-go"
@@ -12,14 +11,27 @@ type observer struct {
 	vm *voicemeeter.Remote
 }
 
+func (o observer) Register() {
+	o.vm.Register(o)
+}
+
+func (o observer) Deregister() {
+	o.vm.Deregister(o)
+}
+
 func (o observer) OnUpdate(subject string) {
-	if strings.Compare(subject, "pdirty") == 0 {
+	if subject == "pdirty" {
 		fmt.Println("pdirty!")
 	}
-	if strings.Compare(subject, "mdirty") == 0 {
+	if subject == "mdirty" {
 		fmt.Println("mdirty!")
 	}
-	if strings.Compare(subject, "ldirty") == 0 {
+	if subject == "midi" {
+		var current = o.vm.Midi.Current()
+		var val = o.vm.Midi.Get(current)
+		fmt.Printf("Value of midi button %d: %d\n", current, val)
+	}
+	if subject == "ldirty" {
 		fmt.Printf("%v %v %v %v %v %v %v %v\n",
 			o.vm.Bus[0].Levels().IsDirty(),
 			o.vm.Bus[1].Levels().IsDirty(),
@@ -34,13 +46,15 @@ func (o observer) OnUpdate(subject string) {
 }
 
 func main() {
-	vmRem := voicemeeter.NewRemote("potato")
-	vmRem.Login()
+	vm := voicemeeter.NewRemote("potato")
+	vm.Login()
+	// enable level updates (disabled by default)
+	vm.EventAdd("ldirty")
 
-	o := observer{vmRem}
-	vmRem.Register(o)
+	o := observer{vm}
+	o.Register()
 	time.Sleep(30 * time.Second)
-	vmRem.Deregister(o)
+	o.Deregister()
 
-	vmRem.Logout()
+	vm.Logout()
 }

helper_test.go

@@ -0,0 +1,24 @@
+package voicemeeter
+
+import (
+	"os"
+	"testing"
+	"time"
+)
+
+var (
+	vm = NewRemote("potato")
+)
+
+func TestMain(m *testing.M) {
+	vm.Login()
+	code := m.Run()
+	vm.Logout()
+	os.Exit(code)
+}
+
+func sync() {
+	time.Sleep(30 * time.Millisecond)
+	for vm.Pdirty() || vm.Mdirty() {
+	}
+}

kinds.go

@@ -9,25 +9,25 @@ var basic, banana, potato *kind
 
 // A kind represents a Voicemeeter kinds layout
 type kind struct {
-	name                                              string
-	physIn, virtIn, physOut, virtOut, vbanIn, vbanOut int
+	Name                                              string
+	PhysIn, VirtIn, PhysOut, VirtOut, VbanIn, VbanOut int
 }
 
 // numStrip returns the total number of strips for a kind
-func (k *kind) numStrip() int {
-	n := k.physIn + k.virtIn
+func (k *kind) NumStrip() int {
+	n := k.PhysIn + k.VirtIn
 	return n
 }
 
 // numBus returns the total number of buses for a kind
-func (k *kind) numBus() int {
-	n := k.physOut + k.virtOut
+func (k *kind) NumBus() int {
+	n := k.PhysOut + k.VirtOut
 	return n
 }
 
 // String implements the fmt.stringer interface
 func (k *kind) String() string {
-	return fmt.Sprintf("%s%s", strings.ToUpper(k.name[:1]), k.name[1:])
+	return fmt.Sprintf("%s%s", strings.ToUpper(k.Name[:1]), k.Name[1:])
 }
 
 // newBasicKind returns a basic kind struct address

levels.go

@@ -35,10 +35,10 @@ type levelCache struct {
 
 // newLevelCache returns a levelCache struct address
 func newLevelCache(k *kind) *levelCache {
-	stripLevels := make([]float32, (2*k.physIn)+(8*k.virtIn))
-	busLevels := make([]float32, 8*k.numBus())
-	stripComp := make([]bool, (2*k.physIn)+(8*k.virtIn))
-	busComp := make([]bool, 8*k.numBus())
+	stripLevels := make([]float32, (2*k.PhysIn)+(8*k.VirtIn))
+	busLevels := make([]float32, 8*k.NumBus())
+	stripComp := make([]bool, (2*k.PhysIn)+(8*k.VirtIn))
+	busComp := make([]bool, 8*k.NumBus())
 	if _levelCache == nil {
 		_levelCache = &levelCache{stripMode: 0, stripLevels: stripLevels, busLevels: busLevels, stripComp: stripComp, busComp: busComp}
 	}

midi.go

@@ -0,0 +1,28 @@
+package voicemeeter
+
+var midi *midi_t
+
+type midi_t struct {
+	channel int
+	current int
+	cache   map[int]int
+}
+
+func newMidi() *midi_t {
+	if midi == nil {
+		midi = &midi_t{0, 0, map[int]int{}}
+	}
+	return midi
+}
+
+func (m *midi_t) Channel() int {
+	return m.channel
+}
+
+func (m *midi_t) Current() int {
+	return m.current
+}
+
+func (m *midi_t) Get(key int) int {
+	return m.cache[key]
+}

publisher.go

@@ -40,43 +40,99 @@ func (p *publisher) notify(subject string) {
 	}
 }
 
+type event struct {
+	pdirty bool
+	mdirty bool
+	midi   bool
+	ldirty bool
+}
+
+func newEvent() *event {
+	return &event{true, true, true, false}
+}
+
+func (e *event) Add(ev string) {
+	switch ev {
+	case "pdirty":
+		e.pdirty = true
+	case "mdirty":
+		e.mdirty = true
+	case "midi":
+		e.midi = true
+	case "ldirty":
+		e.ldirty = true
+	}
+}
+
+func (e *event) Remove(ev string) {
+	switch ev {
+	case "pdirty":
+		e.pdirty = false
+	case "mdirty":
+		e.mdirty = false
+	case "midi":
+		e.midi = false
+	case "ldirty":
+		e.ldirty = false
+	}
+}
+
 // pooler continuously polls the dirty paramters
 // it is expected to be run in a goroutine
 type pooler struct {
-	k   *kind
-	run bool
+	k     *kind
+	run   bool
+	event *event
 	publisher
 }
 
 func newPooler(k *kind) *pooler {
 	p := &pooler{
-		k:   k,
-		run: true,
+		k:     k,
+		run:   true,
+		event: newEvent(),
 	}
-	go p.runner()
+	go p.parameters()
+	go p.macrobuttons()
+	go p.midi()
 	go p.levels()
 	return p
 }
 
-func (p *pooler) runner() {
+func (p *pooler) parameters() {
 	for p.run {
-		if pdirty() {
+		if p.event.pdirty && pdirty() {
 			p.notify("pdirty")
 		}
-		if mdirty() {
+		time.Sleep(33 * time.Millisecond)
+	}
+}
+
+func (p *pooler) macrobuttons() {
+	for p.run {
+		if p.event.mdirty && mdirty() {
 			p.notify("mdirty")
 		}
 		time.Sleep(33 * time.Millisecond)
 	}
 }
 
+func (p *pooler) midi() {
+	for p.run {
+		if getMidiMessage() {
+			p.notify("midi")
+		}
+		time.Sleep(33 * time.Millisecond)
+	}
+}
+
 func (p *pooler) levels() {
 	_levelCache = newLevelCache(p.k)
 
 	for p.run {
-		if ldirty(p.k) {
-			update(_levelCache.stripLevels, _levelCache.stripLevelsBuff, (2*p.k.physIn)+(8*p.k.virtIn))
-			update(_levelCache.busLevels, _levelCache.busLevelsBuff, 8*p.k.numBus())
+		if p.event.ldirty && ldirty(p.k) {
+			update(_levelCache.stripLevels, _levelCache.stripLevelsBuff, (2*p.k.PhysIn)+(8*p.k.VirtIn))
+			update(_levelCache.busLevels, _levelCache.busLevelsBuff, 8*p.k.NumBus())
 			p.notify("ldirty")
 		}
 		time.Sleep(33 * time.Millisecond)

remote.go

@@ -7,7 +7,7 @@ import (
 
 // A Remote type represents the API for a kind
 type Remote struct {
-	kind     *kind
+	Kind     *kind
 	Strip    []iStrip
 	Bus      []iBus
 	Button   []button
@@ -15,20 +15,21 @@ type Remote struct {
 	Vban     *vban
 	Device   *device
 	Recorder *recorder
+	Midi     *midi_t
 
 	pooler *pooler
 }
 
 // String implements the fmt.stringer interface
 func (r *Remote) String() string {
-	return fmt.Sprintf("Voicemeeter %s", r.kind)
+	return fmt.Sprintf("Voicemeeter %s", r.Kind)
 }
 
 // Login logs into the API
 // then it intializes the pooler
 func (r *Remote) Login() {
-	login(r.kind.name)
-	r.pooler = newPooler(r.kind)
+	login(r.Kind.Name)
+	r.pooler = newPooler(r.Kind)
 }
 
 // Logout logs out of the API
@@ -38,10 +39,12 @@ func (r *Remote) Logout() {
 	logout()
 }
 
+// Type returns the type of Voicemeeter (basic, banana, potato)
 func (r *Remote) Type() string {
 	return getVMType()
 }
 
+// Version returns the version of Voicemeeter as a string
 func (r *Remote) Version() string {
 	return getVersion()
 }
@@ -56,6 +59,27 @@ func (r *Remote) Mdirty() bool {
 	return mdirty()
 }
 
+// Gets a float parameter value
+func (r *Remote) GetFloat(name string) float64 {
+	return getParameterFloat(name)
+}
+
+// Sets a float paramter value
+func (r *Remote) SetFloat(name string, value float32) {
+	setParameterFloat(name, value)
+}
+
+// Gets a string parameter value
+func (r *Remote) GetString(name string) string {
+	return getParameterString(name)
+}
+
+// Sets a string paramter value
+func (r *Remote) SetString(name, value string) {
+	setParameterString(name, value)
+}
+
+// SendText sets multiple parameters by script
 func (r *Remote) SendText(script string) {
 	setParametersMulti(script)
 }
@@ -65,11 +89,22 @@ func (r *Remote) Register(o observer) {
 	r.pooler.Register(o)
 }
 
-// Register forwards the deregister method to Pooler
+// Deregister forwards the deregister method to Pooler
 func (r *Remote) Deregister(o observer) {
 	r.pooler.Deregister(o)
 }
 
+// EventAdd adds an event to the Pooler
+func (r *Remote) EventAdd(event string) {
+	r.pooler.event.Add(event)
+}
+
+// EventRemove removes an event from the Pooler
+func (r *Remote) EventRemove(event string) {
+	r.pooler.event.Remove(event)
+}
+
+// remoteBuilder defines the interface builder types must satisfy
 type remoteBuilder interface {
 	setKind() remoteBuilder
 	makeStrip() remoteBuilder
@@ -79,6 +114,7 @@ type remoteBuilder interface {
 	makeVban() remoteBuilder
 	makeDevice() remoteBuilder
 	makeRecorder() remoteBuilder
+	makeMidi() remoteBuilder
 	Build() remoteBuilder
 	Get() *Remote
 }
@@ -103,13 +139,15 @@ func (d *director) Get() *Remote {
 	return d.builder.Get()
 }
 
+// genericBuilder represents a generic builder type
 type genericBuilder struct {
 	k *kind
 	r Remote
 }
 
+// setKind sets the kind for a builder of a kind
 func (b *genericBuilder) setKind() remoteBuilder {
-	b.r.kind = b.k
+	b.r.Kind = b.k
 	return b
 }
 
@@ -117,9 +155,9 @@ func (b *genericBuilder) setKind() remoteBuilder {
 // []iStrip comprises of both physical and virtual strip types
 func (b *genericBuilder) makeStrip() remoteBuilder {
 	fmt.Println("building strip")
-	_strip := make([]iStrip, b.k.numStrip())
-	for i := 0; i < b.k.numStrip(); i++ {
-		if i < b.k.physIn {
+	_strip := make([]iStrip, b.k.NumStrip())
+	for i := 0; i < b.k.NumStrip(); i++ {
+		if i < b.k.PhysIn {
 			_strip[i] = newPhysicalStrip(i, b.k)
 		} else {
 			_strip[i] = newVirtualStrip(i, b.k)
@@ -133,9 +171,9 @@ func (b *genericBuilder) makeStrip() remoteBuilder {
 // []t_bus comprises of both physical and virtual bus types
 func (b *genericBuilder) makeBus() remoteBuilder {
 	fmt.Println("building bus")
-	_bus := make([]iBus, b.k.numBus())
-	for i := 0; i < b.k.numBus(); i++ {
-		if i < b.k.physOut {
+	_bus := make([]iBus, b.k.NumBus())
+	for i := 0; i < b.k.NumBus(); i++ {
+		if i < b.k.PhysOut {
 			_bus[i] = newPhysicalBus(i, b.k)
 		} else {
 			_bus[i] = newVirtualBus(i, b.k)
@@ -184,36 +222,69 @@ func (b *genericBuilder) makeRecorder() remoteBuilder {
 	return b
 }
 
+// makeMidi makes a midi type and assigns it to remote.Midi
+func (b *genericBuilder) makeMidi() remoteBuilder {
+	fmt.Println("building midi")
+	b.r.Midi = newMidi()
+	return b
+}
+
 // Get returns a fully constructed remote type for a kind
 func (b *genericBuilder) Get() *Remote {
 	return &b.r
 }
 
+// basicBuilder represents a builder specific to basic type
 type basicBuilder struct {
 	genericBuilder
 }
 
 // Build defines the steps required to build a basic type
 func (basb *genericBuilder) Build() remoteBuilder {
-	return basb.setKind().makeStrip().makeBus().makeButton().makeCommand().makeVban().makeDevice()
+	return basb.setKind().
+		makeStrip().
+		makeBus().
+		makeButton().
+		makeCommand().
+		makeVban().
+		makeDevice().
+		makeMidi()
 }
 
+// bananaBuilder represents a builder specific to banana type
 type bananaBuilder struct {
 	genericBuilder
 }
 
 // Build defines the steps required to build a banana type
 func (banb *bananaBuilder) Build() remoteBuilder {
-	return banb.setKind().makeStrip().makeBus().makeButton().makeCommand().makeVban().makeDevice().makeRecorder()
+	return banb.setKind().
+		makeStrip().
+		makeBus().
+		makeButton().
+		makeCommand().
+		makeVban().
+		makeDevice().
+		makeRecorder().
+		makeMidi()
 }
 
+// potatoBuilder represents a builder specific to potato type
 type potatoBuilder struct {
 	genericBuilder
 }
 
 // Build defines the steps required to build a potato type
 func (potb *potatoBuilder) Build() remoteBuilder {
-	return potb.setKind().makeStrip().makeBus().makeButton().makeCommand().makeVban().makeDevice().makeRecorder()
+	return potb.setKind().
+		makeStrip().
+		makeBus().
+		makeButton().
+		makeCommand().
+		makeVban().
+		makeDevice().
+		makeRecorder().
+		makeMidi()
 }
 
 // NewRemote returns a Remote type for a kind
@@ -227,7 +298,7 @@ func NewRemote(kindId string) *Remote {
 	}
 
 	director := director{}
-	switch _kind.name {
+	switch _kind.Name {
 	case "basic":
 		director.SetBuilder(&basicBuilder{genericBuilder{_kind, Remote{}}})
 	case "banana":

remote_test.go

@@ -83,3 +83,24 @@ func TestGetPotatoRemote(t *testing.T) {
 		assert.NotNil(t, __rem.Recorder)
 	})
 }
+
+func TestSetAndGetFloatParameter(t *testing.T) {
+	//t.Skip("skipping test")
+	var param = "strip[0].mute"
+	vm.SetFloat(param, 1)
+	sync()
+	t.Run("Should get a float parameter", func(t *testing.T) {
+		assert.Equal(t, float64(1), vm.GetFloat(param))
+	})
+}
+
+func TestSetAndGetStringParameter(t *testing.T) {
+	//t.Skip("skipping test")
+	var param = "strip[0].label"
+	var val = "test0"
+	vm.SetString(param, val)
+	sync()
+	t.Run("Should get a string parameter", func(t *testing.T) {
+		assert.Equal(t, val, vm.GetString(param))
+	})
+}

strip.go

@@ -292,17 +292,17 @@ func (gl *gainLayer) Set(val float32) {
 func newStripLevels(i int, k *kind) levels {
 	var init int
 	var os int
-	if i < k.physIn {
+	if i < k.PhysIn {
 		init = i * 2
 		os = 2
 	} else {
-		init = (k.physIn * 2) + ((i - k.physIn) * 8)
+		init = (k.PhysIn * 2) + ((i - k.PhysIn) * 8)
 		os = 8
 	}
 	return levels{iRemote{fmt.Sprintf("strip[%d]", i), i}, k, init, os, "strip"}
 }
 
-// PreFader returns the level valuess for this strip, PREFADER mode
+// PreFader returns the level values for this strip, PREFADER mode
 func (l *levels) PreFader() []float32 {
 	_levelCache.stripMode = 0
 	var levels []float32
@@ -312,7 +312,7 @@ func (l *levels) PreFader() []float32 {
 	return levels
 }
 
-// PreFader returns the level valuess for this strip, POSTFADER mode
+// PostFader returns the level values for this strip, POSTFADER mode
 func (l *levels) PostFader() []float32 {
 	_levelCache.stripMode = 1
 	var levels []float32
@@ -322,7 +322,7 @@ func (l *levels) PostFader() []float32 {
 	return levels
 }
 
-// PreFader returns the level valuess for this strip, POSTMUTE mode
+// PostMute returns the level values for this strip, POSTMUTE mode
 func (l *levels) PostMute() []float32 {
 	_levelCache.stripMode = 2
 	var levels []float32

tests/helper_test.go

@@ -9,18 +9,18 @@ import (
 )
 
 var (
-	vmRem = voicemeeter.NewRemote("potato")
+	vm = voicemeeter.NewRemote("potato")
 )
 
 func TestMain(m *testing.M) {
-	vmRem.Login()
+	vm.Login()
 	code := m.Run()
-	vmRem.Logout()
+	vm.Logout()
 	os.Exit(code)
 }
 
 func sync() {
 	time.Sleep(30 * time.Millisecond)
-	for vmRem.Pdirty() || vmRem.Mdirty() {
+	for vm.Pdirty() || vm.Mdirty() {
 	}
 }

tests/higher_test.go

@@ -8,206 +8,206 @@ import (
 
 func TestStrip0Mute(t *testing.T) {
 	//t.Skip("skipping test")
-	vmRem.Strip[0].SetMute(true)
+	vm.Strip[0].SetMute(true)
 	sync()
 	t.Run("Should return true when SetMute(true)", func(t *testing.T) {
-		assert.True(t, vmRem.Strip[0].GetMute())
+		assert.True(t, vm.Strip[0].GetMute())
 	})
 
-	vmRem.Strip[0].SetMute(false)
+	vm.Strip[0].SetMute(false)
 	sync()
 	t.Run("Should return false when SetMute(false)", func(t *testing.T) {
-		assert.False(t, vmRem.Strip[0].GetMute())
+		assert.False(t, vm.Strip[0].GetMute())
 	})
 }
 
 func TestStrip3A1(t *testing.T) {
 	//t.Skip("skipping test")
-	vmRem.Strip[3].SetA1(true)
+	vm.Strip[3].SetA1(true)
 	sync()
 	t.Run("Should return true when SetA1(true)", func(t *testing.T) {
-		assert.True(t, vmRem.Strip[3].GetA1())
+		assert.True(t, vm.Strip[3].GetA1())
 	})
 
-	vmRem.Strip[3].SetA1(false)
+	vm.Strip[3].SetA1(false)
 	sync()
 	t.Run("Should return false when SetA1(false)", func(t *testing.T) {
-		assert.False(t, vmRem.Strip[3].GetA1())
+		assert.False(t, vm.Strip[3].GetA1())
 	})
 }
 
 func TestStrip2Limit(t *testing.T) {
 	//t.Skip("skipping test")
-	vmRem.Strip[2].SetLimit(-8)
+	vm.Strip[2].SetLimit(-8)
 	sync()
 	t.Run("Should return -8 when SetLimit(-8)", func(t *testing.T) {
-		assert.Equal(t, vmRem.Strip[2].GetLimit(), -8)
+		assert.Equal(t, vm.Strip[2].GetLimit(), -8)
 	})
 
-	vmRem.Strip[2].SetLimit(-32)
+	vm.Strip[2].SetLimit(-32)
 	sync()
 	t.Run("Should return -32 when SetLimit(-8)", func(t *testing.T) {
-		assert.Equal(t, vmRem.Strip[2].GetLimit(), -32)
+		assert.Equal(t, vm.Strip[2].GetLimit(), -32)
 	})
 
 }
 
 func TestStrip4Label(t *testing.T) {
 	//t.Skip("skipping test")
-	vmRem.Strip[4].SetLabel("test0")
+	vm.Strip[4].SetLabel("test0")
 	sync()
 	t.Run("Should return test0 when SetLimit('test0')", func(t *testing.T) {
-		assert.Equal(t, "test0", vmRem.Strip[4].GetLabel())
+		assert.Equal(t, "test0", vm.Strip[4].GetLabel())
 	})
 
-	vmRem.Strip[4].SetLabel("test1")
+	vm.Strip[4].SetLabel("test1")
 	sync()
 	t.Run("Should return test1 when SetLimit('test1')", func(t *testing.T) {
-		assert.Equal(t, "test1", vmRem.Strip[4].GetLabel())
+		assert.Equal(t, "test1", vm.Strip[4].GetLabel())
 	})
 }
 
 func TestStrip5Gain(t *testing.T) {
 	//t.Skip("skipping test")
-	vmRem.Strip[4].SetGain(-20.8)
+	vm.Strip[4].SetGain(-20.8)
 	sync()
 	t.Run("Should return -20.8 when SetGain(-20.8)", func(t *testing.T) {
-		assert.Equal(t, vmRem.Strip[4].GetGain(), -20.8)
+		assert.Equal(t, vm.Strip[4].GetGain(), -20.8)
 	})
 
-	vmRem.Strip[4].SetGain(-3.6)
+	vm.Strip[4].SetGain(-3.6)
 	sync()
 	t.Run("Should return -3.6 when SetGain(-3.6)", func(t *testing.T) {
-		assert.Equal(t, vmRem.Strip[4].GetGain(), -3.6)
+		assert.Equal(t, vm.Strip[4].GetGain(), -3.6)
 	})
 }
 
 func TestStrip3Comp(t *testing.T) {
 	//t.Skip("skipping test")
-	vmRem.Strip[4].SetComp(8.1)
+	vm.Strip[4].SetComp(8.1)
 	sync()
 	t.Run("Should return 8.1 when SetGain(8.1)", func(t *testing.T) {
-		assert.Equal(t, vmRem.Strip[4].GetComp(), 8.1)
+		assert.Equal(t, vm.Strip[4].GetComp(), 8.1)
 	})
 
-	vmRem.Strip[4].SetComp(1.6)
+	vm.Strip[4].SetComp(1.6)
 	sync()
 	t.Run("Should return 1.6 when SetGain(1.6)", func(t *testing.T) {
-		assert.Equal(t, vmRem.Strip[4].GetComp(), 1.6)
+		assert.Equal(t, vm.Strip[4].GetComp(), 1.6)
 	})
 }
 
 func TestStrip5Mc(t *testing.T) {
 	//t.Skip("skipping test")
-	vmRem.Strip[5].SetMc(true)
+	vm.Strip[5].SetMc(true)
 	sync()
 	t.Run("Should return true when SetMc(true)", func(t *testing.T) {
-		assert.True(t, vmRem.Strip[5].GetMc())
+		assert.True(t, vm.Strip[5].GetMc())
 	})
 
-	vmRem.Strip[5].SetMc(false)
+	vm.Strip[5].SetMc(false)
 	sync()
 	t.Run("Should return false when SetMc(false)", func(t *testing.T) {
-		assert.False(t, vmRem.Strip[5].GetMc())
+		assert.False(t, vm.Strip[5].GetMc())
 	})
 }
 
 func TestStrip2GainLayer3(t *testing.T) {
 	//t.Skip("skipping test")
-	vmRem.Strip[2].GainLayer()[3].Set(-18.3)
+	vm.Strip[2].GainLayer()[3].Set(-18.3)
 	sync()
 	t.Run("Should return -18.3 when SetMc(true)", func(t *testing.T) {
-		assert.Equal(t, vmRem.Strip[2].GainLayer()[3].Get(), -18.3)
+		assert.Equal(t, vm.Strip[2].GainLayer()[3].Get(), -18.3)
 	})
 
-	vmRem.Strip[2].GainLayer()[3].Set(-25.6)
+	vm.Strip[2].GainLayer()[3].Set(-25.6)
 	sync()
 	t.Run("Should return -25.6 when SetMc(true)", func(t *testing.T) {
-		assert.Equal(t, vmRem.Strip[2].GainLayer()[3].Get(), -25.6)
+		assert.Equal(t, vm.Strip[2].GainLayer()[3].Get(), -25.6)
 	})
 }
 
 func TestBus3Eq(t *testing.T) {
 	//t.Skip("skipping test")
-	vmRem.Bus[3].SetEq(true)
+	vm.Bus[3].SetEq(true)
 	sync()
 	t.Run("Should return true when SetEq(true)", func(t *testing.T) {
-		assert.True(t, vmRem.Bus[3].GetEq())
+		assert.True(t, vm.Bus[3].GetEq())
 	})
 
-	vmRem.Bus[3].SetEq(false)
+	vm.Bus[3].SetEq(false)
 	sync()
 	t.Run("Should return false when SetEq(false)", func(t *testing.T) {
-		assert.False(t, vmRem.Bus[3].GetEq())
+		assert.False(t, vm.Bus[3].GetEq())
 	})
 }
 
 func TestBus4Label(t *testing.T) {
 	//t.Skip("skipping test")
-	vmRem.Bus[4].SetLabel("test0")
+	vm.Bus[4].SetLabel("test0")
 	sync()
 	t.Run("Should return test0 when SetEq('test0')", func(t *testing.T) {
-		assert.Equal(t, "test0", vmRem.Bus[4].GetLabel())
+		assert.Equal(t, "test0", vm.Bus[4].GetLabel())
 	})
 
-	vmRem.Bus[4].SetLabel("test1")
+	vm.Bus[4].SetLabel("test1")
 	sync()
 	t.Run("Should return test1 when SetEq('test1')", func(t *testing.T) {
-		assert.Equal(t, "test1", vmRem.Bus[4].GetLabel())
+		assert.Equal(t, "test1", vm.Bus[4].GetLabel())
 	})
 }
 
 func TestBus3ModeAmix(t *testing.T) {
 	//t.Skip("skipping test")
-	vmRem.Bus[3].Mode().SetAmix(true)
+	vm.Bus[3].Mode().SetAmix(true)
 	sync()
 	t.Run("Should return true when Mode().SetAmix(true)", func(t *testing.T) {
-		assert.True(t, vmRem.Bus[3].Mode().GetAmix())
+		assert.True(t, vm.Bus[3].Mode().GetAmix())
 	})
 }
 
 func TestVbanInStream0On(t *testing.T) {
 	//t.Skip("skipping test")
-	vmRem.Vban.InStream[0].SetOn(true)
+	vm.Vban.InStream[0].SetOn(true)
 	sync()
 	t.Run("Should return true when SetOn(true)", func(t *testing.T) {
-		assert.True(t, vmRem.Vban.InStream[0].GetOn())
+		assert.True(t, vm.Vban.InStream[0].GetOn())
 	})
 
-	vmRem.Vban.InStream[0].SetOn(false)
+	vm.Vban.InStream[0].SetOn(false)
 	sync()
 	t.Run("Should return false when SetOn(false)", func(t *testing.T) {
-		assert.False(t, vmRem.Vban.InStream[0].GetOn())
+		assert.False(t, vm.Vban.InStream[0].GetOn())
 	})
 }
 
 func TestVbanOutStream6On(t *testing.T) {
 	//t.Skip("skipping test")
-	vmRem.Vban.OutStream[6].SetOn(true)
+	vm.Vban.OutStream[6].SetOn(true)
 	sync()
 	t.Run("Should return true when SetOn(true)", func(t *testing.T) {
-		assert.True(t, vmRem.Vban.OutStream[6].GetOn())
+		assert.True(t, vm.Vban.OutStream[6].GetOn())
 	})
 
-	vmRem.Vban.OutStream[6].SetOn(false)
+	vm.Vban.OutStream[6].SetOn(false)
 	sync()
 	t.Run("Should return false when SetOn(false)", func(t *testing.T) {
-		assert.False(t, vmRem.Vban.OutStream[6].GetOn())
+		assert.False(t, vm.Vban.OutStream[6].GetOn())
 	})
 }
 
 func TestVbanOutStream3Name(t *testing.T) {
 	t.Skip("skipping test")
-	vmRem.Vban.OutStream[3].SetName("test0")
+	vm.Vban.OutStream[3].SetName("test0")
 	sync()
 	t.Run("Should return test0 when SetName('test0')", func(t *testing.T) {
-		assert.Equal(t, "test0", vmRem.Vban.OutStream[3].GetName())
+		assert.Equal(t, "test0", vm.Vban.OutStream[3].GetName())
 	})
 
-	vmRem.Vban.OutStream[3].SetName("test1")
+	vm.Vban.OutStream[3].SetName("test1")
 	sync()
 	t.Run("Should return test1 when SetName('test1')", func(t *testing.T) {
-		assert.Equal(t, "test1", vmRem.Vban.OutStream[3].GetName())
+		assert.Equal(t, "test1", vm.Vban.OutStream[3].GetName())
 	})
 }
 
@@ -219,21 +219,21 @@ func TestVbanInStream4Bit(t *testing.T) {
 				t.Error("expected panic")
 			}
 		}()
-		vmRem.Vban.InStream[4].SetBit(16)
+		vm.Vban.InStream[4].SetBit(16)
 	})
 }
 
 func TestVbanOutStream4Bit(t *testing.T) {
 	//t.Skip("skipping test")
-	vmRem.Vban.OutStream[4].SetBit(16)
+	vm.Vban.OutStream[4].SetBit(16)
 	sync()
 	t.Run("Should return 16 when SetBit(16)", func(t *testing.T) {
-		assert.Equal(t, vmRem.Vban.OutStream[4].GetBit(), 16)
+		assert.Equal(t, vm.Vban.OutStream[4].GetBit(), 16)
 	})
 
-	vmRem.Vban.OutStream[4].SetBit(24)
+	vm.Vban.OutStream[4].SetBit(24)
 	sync()
 	t.Run("Should return 24 when SetBit(24)", func(t *testing.T) {
-		assert.Equal(t, vmRem.Vban.OutStream[4].GetBit(), 24)
+		assert.Equal(t, vm.Vban.OutStream[4].GetBit(), 24)
 	})
 }

vban.go

@@ -169,12 +169,12 @@ type vban struct {
 }
 
 func newVban(k *kind) *vban {
-	_vbanIn := make([]iVban, k.vbanIn)
-	for i := 0; i < k.vbanIn; i++ {
+	_vbanIn := make([]iVban, k.VbanIn)
+	for i := 0; i < k.VbanIn; i++ {
 		_vbanIn[i] = newVbanInStream(i)
 	}
-	_vbanOut := make([]iVban, k.vbanOut)
-	for i := 0; i < k.vbanOut; i++ {
+	_vbanOut := make([]iVban, k.VbanOut)
+	for i := 0; i < k.VbanOut; i++ {
 		_vbanOut[i] = newVbanOutStream(i)
 	}
 	return &vban{