voicemeeter-api-powershell/FROM_SOURCE.md
onyx-and-iris 7ba7b456eb update to .md files
Added CHANGELOG to document changes.

Added installation instructions to README and link to FROM_SOURCE for alternative script loading instructions.

Modified examples in README to reflect recent changes to module
2021-04-30 16:30:12 +01:00

35 lines
957 B
Markdown

#### Direct download:
All commands remain the same, the only difference when you download from source is how you load scripts.
You will need to dot source the Voicemeeter.ps1 since you won't have it installed as a module
Instead of `Import-Module Voicemeeter` use `. .\lib\voicemeeter.ps1` (from repository root)
and call remote class directly, so: `$vmr = [Remote]::new('banana')`
Where you pass it a Voicemeeter type argument. Type can be one of:
- basic
- banana
- potato
Simple example if using from source:
```powershell
. .\lib\voicemeeter.ps1
try {
# Pass a Voicemeeter type as argument
$vmr = [Remote]::new('banana')
# Set strip and bus params
$vmr.strip[0].mono = $true
$vmr.strip[0].mono '=> $true'
$vmr.bus[1].mute = $false
$vmr.bus[1].mute '=> $false'
# Set macrobutton with id 4, mode state to 1
$vmr.button[4].state = $true
$vmr.button[4].state '=> $true'
}
finally { $vmr.Logout() }
```