rework getters, setters in higher classes

RecorderMode class added to Recorder

RunMacrobuttons() and CloseMacrobuttons() added to Special (Command)

CHANGELOG.md

@@ -9,10 +9,7 @@ Before any major/minor/patch is released all test units will be run to verify th
 
 ## [Unreleased] These changes have not been added to PSGallery yet
 
--   [x] Implement command.load
+- [x] Level methods for Strip,Bus classes implemented.
--   [x] Implement comp/gate parameters introduced in v3.0.2.8 of the api.
--   [x] Add unit tests for new classes.
--   [x] Update README with changes to Strip/Bus classes.
 
 ## [3.0.0]
 

README.md

@@ -79,7 +79,7 @@ Voicemeeter factory function can be:
 - Get-RemoteBanana
 - Get-RemotePotato
 
-Added in v3 you may also use the following entry/exit points:
+Added in `v3` you may also use the following entry/exit points:
 
 - Connect-Voicemeeter
 - Disconnect-Voicemeeter
@@ -90,6 +90,8 @@ for example:
 
 ```powershell
 $vmr = Connect-Voicemeeter -Kind "potato"
+...
+Disconnect-Voicemeeter
 ```
 
 #### `Through the Shell`
@@ -213,6 +215,20 @@ $vmr.strip[5].AppGain("Spotify", 0.5)
 $vmr.strip[5].AppMute("Spotify", $true)
 ```
 
+#### levels
+
+The following strip.level commands are available:
+
+- PreFader()
+- PostFader()
+- PostMute()
+
+for example:
+
+```powershell
+$vmr.strip[2].levels.PreFader() -Join ', ' | Write-Host
+```
+
 ### Bus
 
 The following bus commands are available:
@@ -262,6 +278,18 @@ $vmr.bus[0].mode.centeronly = $true
 $vmr.bus[0].mode.Get()
 ```
 
+#### levels
+
+The following strip.level commands are available:
+
+- All()
+
+for example:
+
+```powershell
+$vmr.bus[2].levels.All() -Join ', ' | Write-Host
+```
+
 ### Strip|Bus
 
 #### device
@@ -292,6 +320,13 @@ The following strip.eq | bus.eq commands are available:
 - on: boolean
 - ab: boolean
 
+for example:
+
+```powershell
+$vmr.strip[0].eq.on = $true
+$vmr.bus[0].eq.ab = $false
+```
+
 #### FadeTo | FadeBy
 
 - `FadeTo(amount, time)` : float, int

lib/Voicemeeter.psm1

@@ -75,7 +75,7 @@ class RemoteBasic : Remote {
         $this.bus = Make_Buses($this)
         $this.button = Make_Buttons
         $this.vban = Make_Vban($this)
-        $this.command = Make_Command
+        $this.command = Make_Command($this)
     }
 }
 
@@ -92,7 +92,7 @@ class RemoteBanana : Remote {
         $this.bus = Make_Buses($this)
         $this.button = Make_Buttons
         $this.vban = Make_Vban($this)
-        $this.command = Make_Command
+        $this.command = Make_Command($this)
         $this.recorder = Make_Recorder($this)
     }
 }
@@ -110,7 +110,7 @@ class RemotePotato : Remote {
         $this.bus = Make_Buses($this)
         $this.button = Make_Buttons
         $this.vban = Make_Vban($this)
-        $this.command = Make_Command
+        $this.command = Make_Command($this)
         $this.recorder = Make_Recorder($this)
     }
 }

lib/base.ps1

@@ -203,3 +203,18 @@ function Set_By_Script {
         Write-Warning $_.Exception.ErrorMessage()
     }
 }
+
+function Get_Level {
+    param(
+        [int64]$MODE, [int64]$INDEX
+    )
+    New-Variable -Name ptr -Value 0.0
+    try {
+        $retval = [int][Voicemeeter.Remote]::VBVMR_GetLevel($MODE, $INDEX, [ref]$ptr)
+        if ($retval) { throw [CAPIError]::new($retval, $MyInvocation.MyCommand) }
+    }
+    catch [CAPIError] {
+        Write-Warning $_.Exception.ErrorMessage()
+    }
+    [float]$ptr
+}

lib/binding.ps1

@@ -1,6 +1,6 @@
 function Setup_DLL {
     try {
-        $vb_path = Get_VBPath
+        $vb_path = Get_VMPath
 
         if ([string]::IsNullOrWhiteSpace($vb_path)) {
             throw [VMRemoteError]::new("couldn't get Voicemeeter path")
@@ -47,6 +47,9 @@ function Setup_DLL {
 
     [DllImport(@"$dll")]
     public static extern int VBVMR_SetParameters(String param);
+
+    [DllImport(@"$dll")]
+    public static extern int VBVMR_GetLevel(Int64 mode, Int64 index, ref float ptr);
 "@
 
     Add-Type -MemberDefinition $Signature -Name Remote -Namespace Voicemeeter -PassThru | Out-Null

lib/bus.ps1

@@ -18,29 +18,31 @@ class IBus {
     }
 
     [single] Getter ($param) {
-        return Param_Get -PARAM "$($this.identifier()).$param" -IS_STRING $false
+        return $this.remote.Getter("$($this.identifier()).$param")
     }
 
     [string] Getter_String ($param) {
-        return Param_Get -PARAM "$($this.identifier()).$param" -IS_STRING $true
+        return $this.remote.Getter_String("$($this.identifier()).$param")
     }
 
-    [void] Setter ($param, $set) {
+    [void] Setter ($param, $val) {
-        Param_Set -PARAM "$($this.identifier()).$param" -Value $set
+        $this.remote.Setter("$($this.identifier()).$param", $val)
     }
 }
 
 class Bus : IBus {
     [Object]$mode
     [Object]$eq
+    [Object]$levels
 
     Bus ([int]$index, [Object]$remote) : base ($index, $remote) {
         AddBoolMembers -PARAMS @('mono', 'mute')
         AddStringMembers -PARAMS @('label')
         AddFloatMembers -PARAMS @('gain', 'returnreverb', 'returndelay', 'returnfx1', 'returnfx2')
 
-        $this.mode = [Mode]::new($index, $remote)
+        $this.mode = [BusMode]::new($index, $remote)
-        $this.eq = [Eq]::new($index, $remote)
+        $this.eq = [BusEq]::new($index, $remote)
+        $this.levels = [BusLevels]::new($index, $remote)
     }
 
     [void] FadeTo ([single]$target, [int]$time) {
@@ -52,10 +54,41 @@ class Bus : IBus {
     }
 }
 
-class Mode : IBus {
+class BusLevels : IBus {
+    [int]$init
+    [int]$offset
+
+    BusLevels ([int]$index, [Object]$remote) : base ($index, $remote) {
+        $this.init = $index * 8
+        $this.offset = 8            
+    }
+
+    [float] Convert([float]$val) {
+        if ($val -gt 0) { 
+            return [math]::Round(20 * [math]::Log10($val), 1) 
+        } 
+        else { 
+            return - 200.0 
+        }
+    }
+
+    [System.Collections.ArrayList] Getter([int]$mode) {
+        [System.Collections.ArrayList]$vals = @()
+        $this.init..$($this.init + $this.offset - 1) | ForEach-Object {
+            $vals.Add($this.Convert($(Get_Level -MODE $mode -INDEX $_)))
+        }
+        return $vals
+    }
+
+    [System.Collections.ArrayList] All() {
+        return $this.Getter(3)
+    }
+}
+
+class BusMode : IBus {
     [System.Collections.ArrayList]$modes
 
-    Mode ([int]$index, [Object]$remote) : base ($index, $remote) {
+    BusMode ([int]$index, [Object]$remote) : base ($index, $remote) {
         $this.modes = @(
             'normal', 'amix', 'bmix', 'repeat', 'composite', 'tvmix', 'upmix21', 'upmix41', 'upmix61', 
             'centeronly', 'lfeonly', 'rearonly'
@@ -78,8 +111,8 @@ class Mode : IBus {
     }
 }
 
-class Eq : IBus {
+class BusEq : IBus {
-    Eq ([int]$index, [Object]$remote) : base ($index, $remote) {
+    BusEq ([int]$index, [Object]$remote) : base ($index, $remote) {
         AddBoolMembers -PARAMS @('on', 'ab')
     }
 
@@ -92,12 +125,12 @@ class PhysicalBus : Bus {
     [Object]$device
 
     PhysicalBus ([int]$index, [Object]$remote) : base ($index, $remote) {
-        $this.device = [Device]::new($index, $remote)
+        $this.device = [BusDevice]::new($index, $remote)
     }
 }
 
-class Device : IBus {
+class BusDevice : IBus {
-    Device ([int]$index, [Object]$remote) : base ($index, $remote) {
+    BusDevice ([int]$index, [Object]$remote) : base ($index, $remote) {
     }
 
     [string] identifier () {

lib/command.ps1

@@ -1,8 +1,13 @@
 . $PSScriptRoot\meta.ps1
+. $PSScriptRoot\inst.ps1
 
 class Special {
-    Special () {
+    [Object]$remote
+
+    Special ([Object]$remote) {
         AddActionMembers -PARAMS @('restart', 'shutdown', 'show')
+    
+        $this.remote = $remote
     }
 
     [string] identifier () {
@@ -14,18 +19,26 @@ class Special {
     }
 
     [single] Getter ($param) {
-        return Param_Get -PARAM "$($this.identifier()).$param" -IS_STRING $false
+        return $this.remote.Getter("$($this.identifier()).$param")
     }
 
     [void] Setter ($param, $val) {
         if ($val -is [Boolean]) {
-            Param_Set -PARAM "$($this.identifier()).$param" -Value $(if ($val) { 1 } else { 0 })
+            $this.remote.Setter("$($this.identifier()).$param", $(if ($val) { 1 } else { 0 }))
         }
         else {
-            Param_Set -PARAM "$($this.identifier()).$param" -Value $val
+            $this.remote.Setter("$($this.identifier()).$param", $val)
         }
     }
 
+    [void] RunMacrobuttons() {
+        Start-Process -FilePath $(Join-Path -Path $(Get_VMPath) -ChildPath "VoicemeeterMacroButtons.exe")
+    }
+
+    [void] CloseMacrobuttons() {
+        Stop-Process -Name "VoicemeeterMacroButtons"
+    }
+
     hidden $_hide = $($this | Add-Member ScriptProperty 'hide' `
         {
             $this._hide = $this.Setter('show', $false)
@@ -58,6 +71,6 @@ class Special {
     }
 }
 
-function Make_Command {
+function Make_Command([Object]$remote) {
-    return [Special]::new()
+    return [Special]::new($remote)
 }

lib/inst.ps1

@@ -1,4 +1,4 @@
-function Get_VBPath {
+function Get_VMPath {
     $reg_path = "Registry::HKEY_LOCAL_MACHINE\Software" + `
     (& { if ([Environment]::Is64BitOperatingSystem) { "\WOW6432Node" } else { "" } }) + `
         "\Microsoft\Windows\CurrentVersion\Uninstall"

lib/recorder.ps1

@@ -1,10 +1,33 @@
 . $PSScriptRoot\meta.ps1
 
-class Recorder {
+class IRecorder {
     [Object]$remote
 
-    Recorder ([Object]$remote) {
+    IRecorder ([Object]$remote) {
         $this.remote = $remote
+    }
+
+    [single] Getter ($param) {
+        return $this.remote.Getter("$($this.identifier()).$param")
+    }
+
+    [void] Setter ($param, $val) {
+        if ($val -is [Boolean]) {
+            $this.remote.Setter("$($this.identifier()).$param", $(if ($val) { 1 } else { 0 }))
+        }
+        else {
+            $this.remote.Setter("$($this.identifier()).$param", $val)
+        }
+    }    
+}
+
+class Recorder : IRecorder {
+    [Object]$remote
+    [Object]$mode
+
+    Recorder ([Object]$remote) : base ($remote) {
+        $this.remote = $remote
+        $this.mode = [RecorderMode]::new($remote)
 
         AddActionMembers -PARAMS @('play', 'stop', 'pause', 'replay', 'record', 'ff', 'rew')
         AddChannelMembers
@@ -18,26 +41,13 @@ class Recorder {
         return $this.GetType().Name
     }
 
-    [single] Getter ($param) {
-        return Param_Get -PARAM "$($this.identifier()).$param" -IS_STRING $false
-    }
-
-    [void] Setter ($param, $val) {
-        if ($val -is [Boolean]) {
-            Param_Set -PARAM "$($this.identifier()).$param" -Value $(if ($val) { 1 } else { 0 })
-        }
-        else {
-            Param_Set -PARAM "$($this.identifier()).$param" -Value $val
-        }
-    }
-
     hidden $_loop = $($this | Add-Member ScriptProperty 'loop' `
         {
-            return Write-Warning ("ERROR: $($this.identifier()).mode.loop is write only")
+            [bool]$this.mode.loop
         } `
         {
-            param([bool]$arg)
+            param($arg)
-            $this._loop = $this.Setter('mode.loop', $arg)
+            $this.mode.loop = $arg
         }
     )
 
@@ -46,6 +56,16 @@ class Recorder {
     }
 }
 
+class RecorderMode : IRecorder {
+    RecorderMode ([Object]$remote) : base ($remote) {
+        AddBoolMembers -PARAMS @('loop')
+    }
+
+    [string] identifier () {
+        return "Recorder.Mode"
+    }
+}
+
 function Make_Recorder ([Object]$remote) {
     return [Recorder]::new($remote)
 }

lib/strip.ps1

@@ -14,19 +14,21 @@ class IStrip {
     }
 
     [single] Getter ($param) {
-        return Param_Get -PARAM "$($this.identifier()).$param" -IS_STRING $false
+        return $this.remote.Getter("$($this.identifier()).$param")
     }
 
     [string] Getter_String ($param) {
-        return Param_Get -PARAM "$($this.identifier()).$param" -IS_STRING $true
+        return $this.remote.Getter_String("$($this.identifier()).$param")
     }
 
     [void] Setter ($param, $val) {
-        Param_Set -PARAM "$($this.identifier()).$param" -Value $val
+        $this.remote.Setter("$($this.identifier()).$param", $val)
     }
 }
 
 class Strip : IStrip {
+    [Object]$levels
+
     Strip ([int]$index, [Object]$remote) : base ($index, $remote) {
         AddBoolMembers -PARAMS @('mono', 'solo', 'mute')
         AddIntMembers -PARAMS @('limit')
@@ -35,6 +37,8 @@ class Strip : IStrip {
 
         AddChannelMembers
         AddGainlayerMembers
+
+        $this.levels = [StripLevels]::new($index, $remote)
     }
 
     [string] ToString() {
@@ -50,6 +54,52 @@ class Strip : IStrip {
     }
 }
 
+class StripLevels : IStrip {
+    [int]$init
+    [int]$offset
+
+    StripLevels ([int]$index, [Object]$remote) : base ($index, $remote) {
+        $p_in = $remote.kind.p_in
+        if ($index -lt $p_in) {
+            $this.init = $index * 2
+            $this.offset = 2            
+        }
+        else {
+            $this.init = ($p_in * 2) + (($index - $p_in) * 8)
+            $this.offset = 8
+        }
+    }
+
+    [float] Convert([float]$val) {
+        if ($val -gt 0) { 
+            return [math]::Round(20 * [math]::Log10($val), 1) 
+        } 
+        else { 
+            return -200.0 
+        }
+    }
+
+    [System.Collections.ArrayList] Getter([int]$mode) {
+        [System.Collections.ArrayList]$vals = @()
+        $this.init..$($this.init + $this.offset - 1) | ForEach-Object {
+            $vals.Add($this.Convert($(Get_Level -MODE $mode -INDEX $_)))
+        }
+        return $vals
+    }
+
+    [System.Collections.ArrayList] PreFader() {
+        return $this.Getter(0)
+    }
+
+    [System.Collections.ArrayList] PostFader() {
+        return $this.Getter(1)
+    }
+
+    [System.Collections.ArrayList] PostMute() {
+        return $this.Getter(2)
+    }
+}
+
 class PhysicalStrip : Strip {
     [Object]$comp
     [Object]$gate
@@ -62,16 +112,16 @@ class PhysicalStrip : Strip {
         AddFloatMembers -PARAMS @('reverb', 'delay', 'fx1', 'fx2')
         AddBoolMembers -PARAMS @('postreverb', 'postdelay', 'postfx1', 'postfx2')
 
-        $this.comp = [Comp]::new($index, $remote)
+        $this.comp = [StripComp]::new($index, $remote)
-        $this.gate = [Gate]::new($index, $remote)
+        $this.gate = [StripGate]::new($index, $remote)
-        $this.denoiser = [Denoiser]::new($index, $remote)
+        $this.denoiser = [StripDenoiser]::new($index, $remote)
-        $this.eq = [Eq]::new($index, $remote)
+        $this.eq = [StripEq]::new($index, $remote)
-        $this.device = [Device]::new($index, $remote)
+        $this.device = [StripDevice]::new($index, $remote)
     }
 }
 
-class Comp : IStrip {
+class StripComp : IStrip {
-    Comp ([int]$index, [Object]$remote) : base ($index, $remote) {
+    StripComp ([int]$index, [Object]$remote) : base ($index, $remote) {
         AddFloatMembers -PARAMS @('gainin', 'ratio', 'threshold', 'attack', 'release', 'knee', 'gainout')
         AddBoolMembers -PARAMS @('makeup')
     }
@@ -91,8 +141,8 @@ class Comp : IStrip {
     )
 }
 
-class Gate : IStrip {
+class StripGate : IStrip {
-    Gate ([int]$index, [Object]$remote) : base ($index, $remote) {
+    StripGate ([int]$index, [Object]$remote) : base ($index, $remote) {
         AddFloatMembers -PARAMS @('threshold', 'damping', 'bpsidechain', 'attack', 'hold', 'release')
     }
 
@@ -111,8 +161,8 @@ class Gate : IStrip {
     )
 }
 
-class Denoiser : IStrip {
+class StripDenoiser : IStrip {
-    Denoiser ([int]$index, [Object]$remote) : base ($index, $remote) {
+    StripDenoiser ([int]$index, [Object]$remote) : base ($index, $remote) {
     }
 
     [string] identifier () {
@@ -130,8 +180,8 @@ class Denoiser : IStrip {
     )
 }
 
-class Eq : IStrip {
+class StripEq : IStrip {
-    Eq ([int]$index, [Object]$remote) : base ($index, $remote) {
+    StripEq ([int]$index, [Object]$remote) : base ($index, $remote) {
         AddBoolMembers -PARAMS @('on', 'ab')
     }
 
@@ -140,15 +190,15 @@ class Eq : IStrip {
     }
 }
 
-class Device : IStrip {
+class StripDevice : IStrip {
-    Device ([int]$index, [Object]$remote) : base ($index, $remote) {
+    StripDevice ([int]$index, [Object]$remote) : base ($index, $remote) {
     }
 
     [string] identifier () {
         return "Strip[" + $this.index + "].Device"
     }
 
-    hidden $_device = $($this | Add-Member ScriptProperty 'device' `
+    hidden $_name = $($this | Add-Member ScriptProperty 'name' `
         {
             $this.Getter_String('name')
         } `

lib/vban.ps1

@@ -1,9 +1,11 @@
 class IVban {
     [int32]$index
+    [Object]$remote
     [string]$direction
 
-    IVban ([int]$index, [string]$direction) {
+    IVban ([int]$index, [Object]$remote, [string]$direction) {
         $this.index = $index
+        $this.remote = $remote
         $this.direction = $direction
     }
 
@@ -16,20 +18,20 @@ class IVban {
     }
 
     [single] Getter ($param) {
-        return Param_Get -PARAM "$($this.identifier()).$param" -IS_STRING $false
+        return $this.remote.Getter("$($this.identifier()).$param")
     }
 
     [string] Getter_String ($param) {
-        return Param_Get -PARAM "$($this.identifier()).$param" -IS_STRING $true
+        return $this.remote.Getter_String("$($this.identifier()).$param")
     }
 
     [void] Setter ($param, $val) {
-        Param_Set -PARAM "$($this.identifier()).$param" -Value $val
+        $this.remote.Setter("$($this.identifier()).$param", $val)
     }
 }
 
 class Vban : IVban {
-    Vban ([int]$index, [string]$direction) : base ($index, $direction) {
+    Vban ([int]$index, [Object]$remote, [string]$direction) : base ($index, $remote, $direction) {
     }
 
     hidden $_on = $($this | Add-Member ScriptProperty 'on' `
@@ -173,13 +175,13 @@ class Vban : IVban {
 
 
 class VbanInstream : Vban {
-    VbanInstream ([int]$index, [string]$direction) : base ($index, $direction) {
+    VbanInstream ([int]$index, [Object]$remote, [string]$direction) : base ($index, $remote, $direction) {
     }
 }
 
 
 class VbanOutstream : Vban {
-    VbanOutstream ([int]$index, [string]$direction) : base ($index, $direction) {
+    VbanOutstream ([int]$index, [Object]$remote, [string]$direction) : base ($index, $remote, $direction) {
     }
 }
 
@@ -189,10 +191,10 @@ function Make_Vban ([Object]$remote) {
     [System.Collections.ArrayList]$outstream = @()
 
     0..$($remote.kind.vban_in - 1) | ForEach-Object {
-        [void]$instream.Add([VbanInstream]::new($_, "in"))
+        [void]$instream.Add([VbanInstream]::new($_, $remote, "in"))
     }
     0..$($remote.kind.vban_out - 1) | ForEach-Object {
-        [void]$outstream.Add([VbanOutstream]::new($_, "out"))
+        [void]$outstream.Add([VbanOutstream]::new($_, $remote, "out"))
     }
 
     $CustomObject = [pscustomobject]@{

tests/pre-commit.ps1

@@ -34,6 +34,7 @@ Function ParseLog {
 function main() {
     try {
         $vmr = Connect-Voicemeeter -Kind $kind
+        $vmr.command.RunMacrobuttons()  # ensure macrobuttons is running before we begin
         Write-Host "Running tests for $vmr"
 
         # test boundaries by kind