mirror of
https://github.com/onyx-and-iris/vban-cmd-python.git
synced 2025-01-19 02:50:47 +00:00
Update README.md
add login,logout example to readme
This commit is contained in:
parent
6c914dafbe
commit
80048d62bd
26
README.md
26
README.md
@ -32,7 +32,6 @@ pip install -e .['development']
|
|||||||
```
|
```
|
||||||
|
|
||||||
#### Use with a context manager:
|
#### 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.
|
Parameter coverage is not as extensive for the RT Packet Service as with the Remote API.
|
||||||
|
|
||||||
### Example 1
|
### Example 1
|
||||||
@ -66,6 +65,31 @@ if __name__ == '__main__':
|
|||||||
main()
|
main()
|
||||||
```
|
```
|
||||||
|
|
||||||
|
#### Or perform setup/teardown independently:
|
||||||
|
for example:
|
||||||
|
|
||||||
|
### Example 2
|
||||||
|
```python
|
||||||
|
import vbancmd
|
||||||
|
|
||||||
|
kind_id = 'potato'
|
||||||
|
ip = '<ip address>'
|
||||||
|
|
||||||
|
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
|
## API
|
||||||
### Kinds
|
### Kinds
|
||||||
A *kind* specifies a major Voicemeeter version. Currently this encompasses
|
A *kind* specifies a major Voicemeeter version. Currently this encompasses
|
||||||
|
Loading…
Reference in New Issue
Block a user