From 2c8e4cc87cf94be8042adb7be225fee2732850bb Mon Sep 17 00:00:00 2001 From: onyx-and-iris Date: Wed, 5 Jul 2023 14:08:27 +0100 Subject: [PATCH] rename sendtext_only to outbound to more accurately describe its purpose. --- CHANGELOG.md | 8 ++++---- README.md | 4 +--- pyproject.toml | 2 +- vban_cmd/factory.py | 2 +- vban_cmd/vbancmd.py | 4 ++-- 5 files changed, 9 insertions(+), 11 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 619c1ab..ddfac77 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -11,15 +11,15 @@ Before any major/minor/patch bump all unit tests will be run to verify they pass - [x] -## [2.1.0] - 2023-07-05 +## [2.1.1] - 2023-07-05 ### Added -- `sendtext_only` kwarg let's you disable incoming rt packets. Essentially the interface will work only in one direction (out). +- `outbound` kwarg let's you disable incoming rt packets. Essentially the interface will work only in one direction. -This is useful if you are only interested in sending script commands out to voicemeeter but don't need to receive parameter states. +This is useful if you are only interested in sending commands out to voicemeeter but don't need to receive parameter states. -By default sendtext_only is False. +By default outbound is False. ## [2.0.0] - 2023-06-25 diff --git a/README.md b/README.md index 145bf15..a804984 100644 --- a/README.md +++ b/README.md @@ -461,7 +461,7 @@ You may pass the following optional keyword arguments: - `pdirty`: boolean=False, parameter updates - `ldirty`: boolean=False, level updates - `timeout`: int=5, amount of time (seconds) to wait for an incoming RT data packet (parameter states). -- `sendtext_only`: boolean=False, set `True` if you are only interested in sending script commands (no rt packets will be received) +- `outbound`: boolean=False, set `True` if you are only interested in sending commands. (no rt packets will be received) #### `vban.pdirty` @@ -479,8 +479,6 @@ Sends a script block as a string request, for example: vban.sendtext("Strip[0].Mute=1;Bus[0].Mono=1") ``` -note. if you are ONLY interested in sending script commands you may set sendtext_only kwarg to True - #### `vban.public_packet` Returns a `VbanRtPacket`. Designed to be used internally by the interface but available for parsing through this read only property object. diff --git a/pyproject.toml b/pyproject.toml index 1278719..c30c8a5 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,6 +1,6 @@ [tool.poetry] name = "vban-cmd" -version = "2.1.0" +version = "2.1.1" description = "Python interface for the VBAN RT Packet Service (Sendtext)" authors = ["onyx-and-iris "] license = "MIT" diff --git a/vban_cmd/factory.py b/vban_cmd/factory.py index 832aac7..471c73d 100644 --- a/vban_cmd/factory.py +++ b/vban_cmd/factory.py @@ -71,7 +71,7 @@ class FactoryBase(VbanCmd): "channel": 0, "ratelimit": 0.01, "timeout": 5, - "sendtext_only": False, + "outbound": False, "sync": False, "pdirty": False, "ldirty": False, diff --git a/vban_cmd/vbancmd.py b/vban_cmd/vbancmd.py index 6945a8a..75fb68e 100644 --- a/vban_cmd/vbancmd.py +++ b/vban_cmd/vbancmd.py @@ -85,8 +85,8 @@ class VbanCmd(metaclass=ABCMeta): return self def login(self): - """Starts the subscriber and updater threads (unless sendtext_only mode)""" - if not self.sendtext_only: + """Starts the subscriber and updater threads (unless in outbound mode)""" + if not self.outbound: self.running = True self.event.info()