update docs

manual tests pass
- option.asiosr
- option.buffer.asio
This commit is contained in:
pblivingston 2025-11-26 11:37:51 -05:00
parent e887e15168
commit d81cd32392
2 changed files with 51 additions and 0 deletions

View File

@ -14,6 +14,7 @@ Before any major/minor/patch is released all test units will be run to verify th
- IRemote base class - IRemote base class
- ArrayMember classes for array-like properties - ArrayMember classes for array-like properties
- Patch class - Patch class
- Option class
## [3.3.0] - 2024-06-29 ## [3.3.0] - 2024-06-29

View File

@ -440,6 +440,56 @@ $vmr.patch.composite[5].set(0) # sets composite channel 6 (5) to default bus c
$vmr.patch.insert[4].get() $vmr.patch.insert[4].get()
``` ```
### Option
The following Option commands are available:
- sr: int, (32000, 44100, 48000, 88200, 96000, 176400, 192000)
- asiosr: bool
- monitorOnSel: bool
- sliderMode: bool
The following Option.delay[i] methods are available:
- Set($val): float, from 0.00 to 500.00
- Get()
for example:
```powershell
$vmr.Option.delay[2].set(30.26) # sets the delay for the third (2) bus
$vmr.Option.sliderMode = $false # sets slider mode to absolute
```
#### buffers
The following Option.buffer commands are available:
- mme: int, (441, 480, 512, 576, 640, 704, 768, 896, 1024, 1536, 2048)
- wdm: int, (128, 160, 192, 224, 256, 288, 320, 352, 384, 416, 441, 448, 480, 512, 576, 640, 704, 768, 896, 1024, 1536, 2048)
- ks: int, (128, 160, 192, 224, 256, 288, 320, 352, 384, 416, 441, 448, 480, 512, 576, 640, 704, 768, 896, 1024, 1536, 2048)
- asio: int, (0, 64, 96, 128, 160, 192, 224, 256, 288, 320, 352, 384, 416, 441, 448, 480, 512, 576, 640, 704, 768, 1024)
for example:
```powershell
$vmr.Option.buffer.wdm = 512
$vmr.Option.buffer.asio = 0 # to use default buffer size
```
#### modes
The following Option.mode commands are available:
- exclusif: bool
- swift: bool
for example:
```powershell
$vmr.Option.mode.exclusif = $true # sets WDM exclusive mode
```
### Recorder ### Recorder
The following commands are available: The following commands are available: