update docs

This commit is contained in:
pblivingston 2025-11-28 03:47:11 -05:00
parent 81764f0e43
commit 72185d14b3
2 changed files with 24 additions and 3 deletions

View File

@ -18,6 +18,25 @@ Before any major/minor/patch is released all test units will be run to verify th
- Device classes - Device classes
- EQ class - EQ class
- FX class - FX class
- Vban.port sets Vban.Instream[0].port
### Changed
- some vban.instream | vban.outstream commands now added with meta functions
- on
- name
- ip
- cast vban getters to types for consistency
### Fixed
- some vban commands incorrectly read-only/write-only
- enable
- instream|outstream.quality
- instream|outstream.route
- vban.stream.port: [string]$arg -> [int]$arg
- vban route range (API documentation is incorrect)
- vban.stream.sr: $this._port -> $this._sr
## [3.3.0] - 2024-06-29 ## [3.3.0] - 2024-06-29

View File

@ -382,14 +382,16 @@ $vmr.button[5].trigger = $true
### VBAN ### VBAN
- vmr.vban.enable: Toggle VBAN on or off. Accepts a bool value. The following vban commands are available:
- enable: bool
- port: int, from 1024 - 65535
For each vban in/out stream the following parameters are defined: For each vban in/out stream the following parameters are defined:
- on: bool - on: bool
- name: string - name: string
- ip: string - ip: string
- port: int, from 1024 - 65535
- sr: in, (11025, 16000, 22050, 24000, 32000, 44100, 48000, 64000, 88200, 96000) - sr: in, (11025, 16000, 22050, 24000, 32000, 44100, 48000, 64000, 88200, 96000)
- channel: int from 1 to 8 - channel: int from 1 to 8
- bit: int, 16 or 24 - bit: int, 16 or 24
@ -403,9 +405,9 @@ example:
```powershell ```powershell
$vmr.vban.enable = $true $vmr.vban.enable = $true
$vmr.vban.port = 6990
$vmr.vban.instream[0].on = $true $vmr.vban.instream[0].on = $true
$vmr.vban.instream[2].port = 6990
$vmr.vban.outstream[3].bit = 16 $vmr.vban.outstream[3].bit = 16
``` ```