aboutsummaryrefslogtreecommitdiff
path: root/readme.md
diff options
context:
space:
mode:
authormetamuffin <metamuffin@disroot.org>2022-09-09 14:43:23 +0200
committermetamuffin <metamuffin@disroot.org>2022-09-09 14:43:23 +0200
commitae9ed91b6d841c73ccc52acecc534053c73bfb43 (patch)
tree7db1115e9d3924ff8bb9e9bbee9a9c20bf836cd5 /readme.md
parent32373fd18a05663c3bb7d9b1d9fa0a21d909c784 (diff)
downloadkeks-meet-ae9ed91b6d841c73ccc52acecc534053c73bfb43.tar
keks-meet-ae9ed91b6d841c73ccc52acecc534053c73bfb43.tar.bz2
keks-meet-ae9ed91b6d841c73ccc52acecc534053c73bfb43.tar.zst
new prefs
Diffstat (limited to 'readme.md')
-rw-r--r--readme.md25
1 files changed, 12 insertions, 13 deletions
diff --git a/readme.md b/readme.md
index 10c11b3..941fd03 100644
--- a/readme.md
+++ b/readme.md
@@ -20,6 +20,7 @@ a web conferencing application
- Native client
- Prevent server from changing message sender
- Have a security professional look at the code
+- Test some options like `camera_facing_mode`
## Usage
@@ -36,22 +37,20 @@ cargo run --release
## Parameters
-For configuration options must be added either
-
-1. in options in the query parameters (e.g. `/myroom?username=alice`)
-2. in options in section of URL (e.g. `/myroom#rnnoise=no`).
-
+Configuration parameters are added like query params but **after** the section. (e.g `/room#mymeeting?username=alice`)
The page will not automatically reload if the section changes.
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 |
-| `#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 | Amplifies the microphone volume |
+| Option name | Default | Description |
+| -------------------------- | --------- | -------------------------------------------------------------- |
+| `rnnoise` | `true` | Use RNNoise for noise suppression |
+| `native_noise_suppression` | `false` | Suggest the browser to do noise suppression |
+| `username` | `guest-…` | "Username |
+| `microphone_gain` | `1` | Amplify microphone volume |
+| `microphone_enabled` | `false` | Add one microphone track on startup |
+| `camera_enabled` | `false` | Add one camera track on startup |
+| `screencast_enabled` | `false` | Add one screencast track on startup |
+| `camera_facing_mode` | undefined | Prefer user-facing or env-facing camera (`environment`/`user`) |
## Protocol