diff options
| author | MetaMuffin <metamuffin@yandex.com> | 2021-08-06 14:08:51 +0200 |
|---|---|---|
| committer | MetaMuffin <metamuffin@yandex.com> | 2021-08-06 14:08:51 +0200 |
| commit | 20c1b014fe502370edc733a6d8a756c9c1602f85 (patch) | |
| tree | 0660f3ed287c1149fb93a0dac68c8f7b7c550a68 /README.md | |
| parent | 208f4f17fe3189ded2110baf166dc2e1ac60e619 (diff) | |
| download | keks-meet-20c1b014fe502370edc733a6d8a756c9c1602f85.tar keks-meet-20c1b014fe502370edc733a6d8a756c9c1602f85.tar.bz2 keks-meet-20c1b014fe502370edc733a6d8a756c9c1602f85.tar.zst | |
updated readme, implemented rnnoise, added parameters
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 17 |
1 files changed, 17 insertions, 0 deletions
@@ -1,3 +1,20 @@ # keks-meet A simple webrtc powered conference application + +## Parameters + +For configuration just add a set of the following options as query parameters to the URL (e.g. `/room/asdfg?username=bob`). + +Booleans can be either `1`, `true` or `yes` or their opposites. + +| Option name | Type | Description | +| --------------- | ------- | -------------------------------------- | +| `username` | string | Sets the username | +| `rnnoise` | boolean | Enables noise suppression with rnnoise | +| `audio_enabled` | boolean | Enables audio transmission by default | +| `video_enabled` | boolean | Enables video transmission by default | + +## Licence + +See `LICENCE` file. |