Skip to content

Commit

Permalink
update API for stereo
Browse files Browse the repository at this point in the history
  • Loading branch information
azlux committed Jun 4, 2020
1 parent 1827866 commit 8439d8c
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion API.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
API
===
## main Mumble object
> `class Mumble(host, user, port=64738, password='', certfile=None, keyfile=None, reconnect=False, tokens=[], debug=False)`
> `class Mumble(host, user, port=64738, password='', certfile=None, keyfile=None, reconnect=False, tokens=[], stereo=False,debug=False)`
It should be quite straightforward. `debug=True` will generate a LOT of stdout messages. Otherwise it should be silent in normal conditions.
Reconnect should allow the library to reconnect automatically if the server disconnect it.
Expand All @@ -14,6 +14,8 @@ The `certfile` parameter takes the path to a Mumble certificate in `.pem` format

```$ openssl pkcs12 -in PATH_TO_CERTFILE.p12 -out CERTFILE_NAME.pem -nocerts -nodes``` for the key file.

The `stereo` allow you to send stereo audio, only available with compatible mumble version (>1.3)

> `Mumble.start()`
Start the library thread and the connection process
Expand Down

0 comments on commit 8439d8c

Please sign in to comment.