From 794b09bcfd191ca732b0587efb84991e5af73720 Mon Sep 17 00:00:00 2001 From: onyx-and-iris <75868496+onyx-and-iris@users.noreply.github.com> Date: Tue, 11 Jan 2022 17:19:51 +0000 Subject: [PATCH] Update README.md update readme to reflect recent changes --- README.md | 23 +++++++++++++++++++---- 1 file changed, 19 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 250ae92..41d5b58 100644 --- a/README.md +++ b/README.md @@ -124,6 +124,9 @@ $vmr.button[5].trigger = $true ``` ### VBAN +#### vmr.vban.enable + +Toggle VBAN on or off. Accepts a boolean value. For each vban in/out stream the following parameters are defined: - on: boolean - name: string @@ -140,18 +143,30 @@ to those parameters will throw an error. They are read and write for outstreams. example: ```powershell +$vmr.vban.enable = $true + $vmr.vban.instream[0].on = $true $vmr.vban.instream[2].port = 6990 $vmr.vban.outstream[3].bit = 16 ``` ### 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 $vmr.command.show -$vmr.command.restart -$vmr.command.showvbanchat -$vmr.command.shutdown + +$vmr.command.lock = $true ``` ### Run tests