onyx_online/voicemeeter-api-powershell
1
0
Fork 0
mirror of https://github.com/onyx-and-iris/voicemeeter-api-powershell.git synced 2025-01-18 13:20:47 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update README.md

Browse Source 
update readme to reflect recent changes
This commit is contained in:
onyx-and-iris 2022-01-11 17:19:51 +00:00
parent 5395b8873f
commit 794b09bcfd
1 changed files with 19 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
README.md
View File

@ -124,6 +124,9 @@ $vmr.button[5].trigger = $true
``` ```
### VBAN ### VBAN
#### vmr.vban.enable
Toggle VBAN on or off. Accepts a boolean value.
For each vban in/out stream the following parameters are defined: For each vban in/out stream the following parameters are defined:
- on: boolean - on: boolean
- name: string - name: string
@ -140,18 +143,30 @@ to those parameters will throw an error. They are read and write for outstreams.
example: example:
```powershell ```powershell
$vmr.vban.enable = $true
$vmr.vban.instream[0].on = $true $vmr.vban.instream[0].on = $true
$vmr.vban.instream[2].port = 6990 $vmr.vban.instream[2].port = 6990
$vmr.vban.outstream[3].bit = 16 $vmr.vban.outstream[3].bit = 16
``` ```
### Special ### Special
Certain 'special' commands are defined by the API as performing actions rather than setting values. You may invoke them with the following commands: Certain 'special' commands are defined by the API as performing actions rather than setting values.
The following methods are available:
- show
- restart
- shutdown
The following properties are write only and accept boolean values:
- showvbanchat
- lock
example:
```powershell ```powershell
$vmr.command.show $vmr.command.show
$vmr.command.restart
$vmr.command.showvbanchat $vmr.command.lock = $true
$vmr.command.shutdown
``` ```
### Run tests ### Run tests