onyx_online/vban-cmd-python
1
0
Fork 0
mirror of https://github.com/onyx-and-iris/vban-cmd-python.git synced 2025-01-18 10:30:48 +00:00
Code Issues Packages Projects Releases Wiki Activity

update readme

Browse Source
This commit is contained in:
onyx-and-iris 2022-06-18 14:07:50 +01:00
parent f2dfe7a474
commit e85013730d
1 changed files with 9 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@ -193,19 +193,23 @@ will load a config file at configs/banana/example.toml for Voicemeeter Banana.
#### `vban.pdirty` #### `vban.pdirty`
True iff a parameter has been changed. Typically this is checked periodically to update states. True iff a parameter has been changed.
#### `vban.set_rt(id_, param, val)` #### `vban.ldirty`
Sends a string request RT Packet where the command would take the form: True iff a level value has been changed.
#### `vban.sendtext(script)`
Sends a script block as a string request RT Packet, for example:
```python ```python
f'{id_}.{param}={val}' vban.sendtext("Strip[0].Mute=1;Bus[0].Mono=1")
``` ```
#### `vban.public_packet` #### `vban.public_packet`
Returns a Voicemeeter rt data packet. Designed to be used internally by the interface but available for parsing through this read only property object. States may or may not be current, use the polling parameter pdirty to be sure. Returns a Voicemeeter rt data packet object. Designed to be used internally by the interface but available for parsing through this read only property object. States not guaranteed to be current (requires use of dirty parameters to confirm).
### `Errors` ### `Errors`