onyx_online/vban-cmd-python
1
0
Fork 0
mirror of https://github.com/onyx-and-iris/vban-cmd-python.git synced 2026-04-18 13:03:31 +00:00
Code Issues Packages Projects Releases Wiki Activity

remove public_packet setter. should be read only.

Browse Source 
version bump to match changelog

some rewording in readme.
This commit is contained in:
onyx-and-iris
2022-04-30 16:57:47 +01:00
parent 51833d68ff
commit 11da78e2e7
3 changed files with 13 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@@ -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)