diff --git a/README.md b/README.md index 92894da..7a439ad 100644 --- a/README.md +++ b/README.md @@ -6,12 +6,16 @@ # VBAN CMD -This package offers a Python interface for [Voicemeeter VBAN TEXT](https://vb-audio.com/Voicemeeter/VBANProtocol_Specifications.pdf#page=19) as well as the [Voicemeeter RT Packet Service](https://vb-audio.com/Voicemeeter/VBANProtocol_Specifications.pdf#page=27) which allows a client to send and receive parameter values over a local network. +This package offers a Python interface for the Voicemeeter RT Packet Service as well as Voicemeeter VBAN-TEXT. + +This allows a user to get (rt packets) and set (vban-text) parameters over a local network. Consider the Streamer View app over VBAN, for example. It may be used standalone or to extend the [Voicemeeter Remote Python API](https://github.com/onyx-and-iris/voicemeeter-api-python) For sending audio across a network with VBAN you will need to look elsewhere. +For an outline of past/future changes refer to: [CHANGELOG](CHANGELOG.md) + ## Tested against - Basic 1.0.8.1 @@ -20,7 +24,7 @@ For sending audio across a network with VBAN you will need to look elsewhere. ## Prerequisites -- Voicemeeter 1 (Basic), 2 (Banana) or 3 (Potato) +- [Voicemeeter](https://voicemeeter.com/) - Python 3.9+ ## Installation @@ -46,7 +50,7 @@ pip install -e .['development'] #### Use with a context manager: -Parameter coverage is not as extensive for the RT Packet Service as with the Remote API. +Parameter coverage is not as extensive for this interface as with the Remote API. ### Example 1 @@ -82,8 +86,6 @@ if __name__ == '__main__': #### Or perform setup/teardown independently: -for example: - ### Example 2 ```python @@ -297,4 +299,6 @@ Then from tests directory: ## Resources -- [Voicemeeter RT Packet Service](https://vb-audio.com/Voicemeeter/VBANProtocol_Specifications.pdf) +- [Voicemeeter VBAN TEXT](https://vb-audio.com/Voicemeeter/VBANProtocol_Specifications.pdf#page=19) + +- [Voicemeeter RT Packet Service](https://vb-audio.com/Voicemeeter/VBANProtocol_Specifications.pdf#page=27) diff --git a/setup.py b/setup.py index 2e2c63e..071842a 100644 --- a/setup.py +++ b/setup.py @@ -2,7 +2,7 @@ from setuptools import setup setup( name="vbancmd", - version="0.0.2", + version="0.3.0", description="VBAN CMD Python API", packages=["vbancmd"], install_requires=["toml"], diff --git a/vbancmd/vbancmd.py b/vbancmd/vbancmd.py index f6e8383..4fdeb73 100644 --- a/vbancmd/vbancmd.py +++ b/vbancmd/vbancmd.py @@ -155,10 +155,6 @@ class VbanCmd(abc.ABC): while self.pdirty: pass - @public_packet.setter - def public_packet(self, val): - self._public_packet = val - def _keepupdated(self) -> NoReturn: """ Continously update public packet in background. @@ -172,8 +168,8 @@ class VbanCmd(abc.ABC): while self.running: private_packet = self._get_rt() self._pdirty = private_packet.isdirty(self.public_packet) - if not private_packet.__eq__(self.public_packet): - self.public_packet = private_packet + if not private_packet == self.public_packet: + self._public_packet = private_packet def _get_rt(self) -> VBAN_VMRT_Packet_Data: """Attempt to fetch data packet until a valid one found"""