diff options
| author | metamuffin <metamuffin@yandex.com> | 2022-01-25 20:58:57 +0100 |
|---|---|---|
| committer | metamuffin <metamuffin@yandex.com> | 2022-01-25 20:58:57 +0100 |
| commit | 8cc5a50b91a3d80b28b03191b246974d3aca9bf8 (patch) | |
| tree | c737af828efe2e1750b5fadc140237737026081d /README.md | |
| parent | a22bdc3821bd53d8e3b198423db3f8d7e8e579f6 (diff) | |
| download | keks-meet-8cc5a50b91a3d80b28b03191b246974d3aca9bf8.tar keks-meet-8cc5a50b91a3d80b28b03191b246974d3aca9bf8.tar.bz2 keks-meet-8cc5a50b91a3d80b28b03191b246974d3aca9bf8.tar.zst | |
polish + menu
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 20 |
1 files changed, 11 insertions, 9 deletions
@@ -1,20 +1,22 @@ # keks-meet -A simple webrtc powered conference application +a online 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`). +For configuration just add a set of the following options as query parameters to the URL (e.g. `/room/asdfg#username=bob`). +Note that the page wont automatically reload if the Booleans can be either `1`, `true`, `yes` or their opposites. -| Option name | Type | Default | Description | -| --------------- | ------- | ------- | -------------------------------------- | -| `username` | string | "guest" | Sets the username | -| `rnnoise` | boolean | true | Enables noise suppression with rnnoise | -| `audio_enabled` | boolean | false | Enables audio transmission by default | -| `camera_enabled` | boolean | false | Enables video transmission by default | -| `mic_gain` | number | 1 | Sets the microphone volume | +| Option name | Type | Default | Description | +| ---------------- | ------- | ------- | ---------------------------------------- | +| `username` | string | "guest" | Sets the username | +| `rnnoise` | boolean | true | Enables noise suppression with rnnoise | +| `mic_enabled` | boolean | false | Adds audio track on startup | +| `camera_enabled` | boolean | false | Adds camera track on startup | +| `screen_enabled` | boolean | false | Adds screen track on startup (wont work) | +| `mic_gain` | number | 1 | Sets the microphone volume | ## Licence |