From 80048d62bdfc63b569c80415e990812217764145 Mon Sep 17 00:00:00 2001 From: onyx-and-iris <75868496+onyx-and-iris@users.noreply.github.com> Date: Sun, 20 Mar 2022 12:26:01 +0000 Subject: [PATCH] Update README.md add login,logout example to readme --- README.md | 26 +++++++++++++++++++++++++- 1 file changed, 25 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 26b708e..23fd05b 100644 --- a/README.md +++ b/README.md @@ -32,7 +32,6 @@ pip install -e .['development'] ``` #### Use with a context manager: -It is advised to use this code with a context manager. Parameter coverage is not as extensive for the RT Packet Service as with the Remote API. ### Example 1 @@ -66,6 +65,31 @@ if __name__ == '__main__': main() ``` +#### Or perform setup/teardown independently: +for example: + +### Example 2 +```python +import vbancmd + +kind_id = 'potato' +ip = '' + +vban = vbancmd.connect(kind_id, ip=ip) + +# call login() at the start of your code +vban.login() + +# Toggle mute for leftmost input strip +vban.strip[0].mute = not vban.strip[0].mute + +# Toggle eq for leftmost output bus +vban.bus[0].eq = not vban.bus[0].eq + +# call logout() at the end of your code +vban.logout() +``` + ## API ### Kinds A *kind* specifies a major Voicemeeter version. Currently this encompasses