onyx_online/voicemeeter-api-python
1
0
Fork 0
mirror of https://github.com/onyx-and-iris/voicemeeter-api-python.git synced 2024-11-25 04:10:48 +00:00
Code Issues Packages Projects Releases Wiki Activity

fix polling parameters in readme.

Browse Source
This commit is contained in:
onyx-and-iris 2023-06-25 11:00:32 +01:00
parent 77003940f2
commit 58dba331a7
1 changed files with 15 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
README.md
View File

@ -755,12 +755,6 @@ Access to lower level Getters and Setters are provided with these functions:
- `vm.get(param, is_string=False)`: For getting the value of any parameter. Set string to True if getting a property value expected to return a string. - `vm.get(param, is_string=False)`: For getting the value of any parameter. Set string to True if getting a property value expected to return a string.
- `vm.set(param, value)`: For setting the value of any parameter. - `vm.set(param, value)`: For setting the value of any parameter.
Access to lower level polling functions are provided with these functions:
- `vm.pdirty()`: Returns True if a parameter has been updated.
- `vm.mdirty()`: Returns True if a macrobutton has been updated.
- `vm.ldirty()`: Returns True if a level has been updated.
example: example:
```python ```python
@ -769,6 +763,21 @@ vm.set('Strip[4].Label', 'stripname')
vm.set('Strip[0].Gain', -3.6) vm.set('Strip[0].Gain', -3.6)
``` ```
Access to lower level polling functions are provided with the following property objects:
#### `vm.pdirty`
True iff a parameter has been updated.
#### `vm.mdirty`
True iff a macrobutton has been updated.
#### `vm.ldirty`
True iff a level has been updated.
### Run tests ### Run tests
To run all tests: To run all tests: