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

rename sendtext_only to outbound

Browse Source 
to more accurately describe its purpose.
This commit is contained in:
onyx-and-iris 2023-07-05 14:08:27 +01:00
parent fc3b31dfa7
commit 2c8e4cc87c
5 changed files with 9 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
CHANGELOG.md
View File

@ -11,15 +11,15 @@ Before any major/minor/patch bump all unit tests will be run to verify they pass
- [x] - [x]
## [2.1.0] - 2023-07-05 ## [2.1.1] - 2023-07-05
### Added ### 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 ## [2.0.0] - 2023-06-25

4
README.md
View File

@ -461,7 +461,7 @@ You may pass the following optional keyword arguments:
- `pdirty`: boolean=False, parameter updates - `pdirty`: boolean=False, parameter updates
- `ldirty`: boolean=False, level updates - `ldirty`: boolean=False, level updates
- `timeout`: int=5, amount of time (seconds) to wait for an incoming RT data packet (parameter states). - `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` #### `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") 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` #### `vban.public_packet`
Returns a `VbanRtPacket`. Designed to be used internally by the interface but available for parsing through this read only property object. Returns a `VbanRtPacket`. Designed to be used internally by the interface but available for parsing through this read only property object.

2
pyproject.toml
View File

@ -1,6 +1,6 @@
[tool.poetry] [tool.poetry]
name = "vban-cmd" name = "vban-cmd"
version = "2.1.0" version = "2.1.1"
description = "Python interface for the VBAN RT Packet Service (Sendtext)" description = "Python interface for the VBAN RT Packet Service (Sendtext)"
authors = ["onyx-and-iris <code@onyxandiris.online>"] authors = ["onyx-and-iris <code@onyxandiris.online>"]
license = "MIT" license = "MIT"

2
vban_cmd/factory.py
View File

@ -71,7 +71,7 @@ class FactoryBase(VbanCmd):
"channel": 0, "channel": 0,
"ratelimit": 0.01, "ratelimit": 0.01,
"timeout": 5, "timeout": 5,
"sendtext_only": False, "outbound": False,
"sync": False, "sync": False,
"pdirty": False, "pdirty": False,
"ldirty": False, "ldirty": False,

4
vban_cmd/vbancmd.py
View File

@ -85,8 +85,8 @@ class VbanCmd(metaclass=ABCMeta):
return self return self
def login(self): def login(self):
"""Starts the subscriber and updater threads (unless sendtext_only mode)""" """Starts the subscriber and updater threads (unless in outbound mode)"""
if not self.sendtext_only: if not self.outbound:
self.running = True self.running = True
self.event.info() self.event.info()