From 9d6c931f07a269f1c06896fb808bc5937271127a Mon Sep 17 00:00:00 2001 From: onyx-and-iris <75868496+onyx-and-iris@users.noreply.github.com> Date: Fri, 29 Apr 2022 22:30:21 +0100 Subject: [PATCH] update to public packet description in readme --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 8d88011..38ecda6 100644 --- a/README.md +++ b/README.md @@ -269,7 +269,7 @@ vban.bus[0].mode.tvmix = True #### `vban.pdirty` -True iff a parameter has been changed. +True iff a parameter has been changed. Typical this is checked periodically to update states. #### `vban.set_rt(id_, param, val)` @@ -281,7 +281,7 @@ f'{id_}.{param}={val}' #### `vban.public_packet` -Returns a data packet with current Voiceemeter states. Designed to be used internally by the interface but available for parsing through this read only property object. +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. ### `Errors`