Name | Description | Format | Default value |
---|---|---|---|
loginEnabled | If the login is enabled. | "boolean" |
false |
developmentPort | The development server listening port. | "port" |
3443 |
productionPort | The production server listening port. | "port" |
443 |
serverHostname | If the server component runs on a different host than the app you can specify the host name. | "string" |
"" |
supportedBrowsers | Supported browsers version in bowser satisfy format. | "object" |
{ "windows": { "internet explorer": ">12", "microsoft edge": ">18" }, "microsoft edge": ">18", "safari": ">12", "firefox": ">=60", "chrome": ">=74", "chromium": ">=74", "opera": ">=62", "samsung internet for android": ">=11.1.1.52"} |
networkPriorities | Network priorities. | "object" |
{ "audio": "high", "mainVideo": "high", "additionalVideos": "medium", "screenShare": "medium"} |
aspectRatio | The aspect ratio of the videos as shown on the screen. This value must match exactly one of the values defined in aspectRatios. | "float" |
1.777 |
aspectRatios | The selectable aspect ratios in the user settings. | "array" |
[ { "value": 1.333, "label": "4 : 3" }, { "value": 1.777, "label": "16 : 9" }] |
resolution | The default video camera capture resolution. | [ "low", "medium", "high", "veryhigh", "ultra"] |
"medium" |
frameRate | The default video camera capture framerate. | "nat" |
15 |
screenResolution | The default screen sharing resolution. | [ "low", "medium", "high", "veryhigh", "ultra"] |
"veryhigh" |
screenSharingFrameRate | The default screen sharing framerate. | "nat" |
5 |
simulcast | Enable or disable simulcast for webcam video. | "boolean" |
true |
simulcastSharing | Enable or disable simulcast for screen sharing video. | "boolean" |
false |
simulcastProfiles | Define different encodings for various resolutions of the video. | "object" |
{ "320": [ { "scaleResolutionDownBy": 1, "maxBitRate": 150000 } ], "640": [ { "scaleResolutionDownBy": 2, "maxBitRate": 150000 }, { "scaleResolutionDownBy": 1, "maxBitRate": 500000 } ], "1280": [ { "scaleResolutionDownBy": 4, "maxBitRate": 150000 }, { "scaleResolutionDownBy": 2, "maxBitRate": 500000 }, { "scaleResolutionDownBy": 1, "maxBitRate": 1200000 } ], "1920": [ { "scaleResolutionDownBy": 6, "maxBitRate": 150000 }, { "scaleResolutionDownBy": 3, "maxBitRate": 500000 }, { "scaleResolutionDownBy": 1, "maxBitRate": 3500000 } ], "3840": [ { "scaleResolutionDownBy": 12, "maxBitRate": 150000 }, { "scaleResolutionDownBy": 6, "maxBitRate": 500000 }, { "scaleResolutionDownBy": 1, "maxBitRate": 10000000 } ]} |
adaptiveScalingFactor | The adaptive spatial layer selection scaling factor in the range [0.5, 1.0]. | 0.75 |
|
localRecordingEnabled | If set to true Local Recording feature will be enabled. | "boolean" |
false |
audioOutputSupportedBrowsers | White listing browsers that support audio output device selection. | "array" |
[ "chrome", "opera"] |
requestTimeout | The Socket.io request timeout. | "nat" |
20000 |
requestRetries | The Socket.io request maximum retries. | "nat" |
3 |
transportOptions | The Mediasoup transport options. | "object" |
{ "tcp": true} |
autoGainControl | Auto gain control enabled. | "boolean" |
true |
echoCancellation | Echo cancellation enabled. | "boolean" |
true |
noiseSuppression | Noise suppression enabled. | "boolean" |
true |
voiceActivatedUnmute | Automatically unmute speaking above noiseThreshold. | "boolean" |
false |
noiseThreshold | This is only for voiceActivatedUnmute and audio-indicator. | "int" |
-60 |
sampleRate | The audio sample rate. | [ 8000, 16000, 24000, 44100, 48000] |
48000 |
channelCount | The audio channels count. | [ 1, 2] |
1 |
sampleSize | The audio sample size count. | [ 8, 16, 24, 32] |
16 |
opusStereo | If OPUS FEC stereo be enabled. | "boolean" |
false |
opusDtx | If OPUS DTX should be enabled. | "boolean" |
true |
opusFec | If OPUS FEC should be enabled. | "boolean" |
true |
opusPtime | The OPUS packet time. | [ 3, 5, 10, 20, 30, 40, 50, 60] |
20 |
opusMaxPlaybackRate | The OPUS playback rate. | [ 8000, 16000, 24000, 44100, 48000] |
48000 |
audioPreset | The audio preset | "string" |
"conference" |
audioPresets | The audio presets. | "object" |
{ "conference": { "name": "Conference audio", "autoGainControl": true, "echoCancellation": true, "noiseSuppression": true, "voiceActivatedUnmute": false, "noiseThreshold": -60, "sampleRate": 48000, "channelCount": 1, "sampleSize": 16, "opusStereo": false, "opusDtx": true, "opusFec": true, "opusPtime": 20, "opusMaxPlaybackRate": 48000 }, "hifi": { "name": "HiFi streaming", "autoGainControl": false, "echoCancellation": false, "noiseSuppression": false, "voiceActivatedUnmute": false, "noiseThreshold": -60, "sampleRate": 48000, "channelCount": 2, "sampleSize": 16, "opusStereo": true, "opusDtx": false, "opusFec": true, "opusPtime": 60, "opusMaxPlaybackRate": 48000 }} |
autoMuteThreshold | It sets the maximum number of participants in one room that can join unmuted. The next participant will join automatically muted. Set it to 0 to auto mute all. Set it to negative (-1) to never automatically auto mute but use it with caution, full mesh audio strongly decrease room capacity! | "nat" |
4 |
background | The page background image URL | "string" |
"images/background.jpg" |
defaultLayout | The default layout. | [ "democratic", "filmstrip"] |
"democratic" |
buttonControlBar | If true, the media control buttons will be shown in separate control bar, not in the ME container. | "boolean" |
false |
drawerOverlayed | If false, will push videos away to make room for side drawer. If true, will overlay side drawer over videos. | "boolean" |
true |
notificationPosition | The position of the notifications. | [ "left", "right"] |
"right" |
notificationSounds | It sets the notifications sounds. Valid keys are: 'parkedPeer', 'parkedPeers', 'raisedHand', 'chatMessage', 'sendFile', 'newPeer' and 'default'. Not defining a key is equivalent to using the default notification sound. Setting 'play' to null disables the sound notification. | "object" |
{ "chatMessage": { "play": "/sounds/notify-chat.mp3" }, "raisedHand": { "play": "/sounds/notify-hand.mp3" }, "default": { "delay": 5000, "play": "/sounds/notify.mp3" }} |
hideTimeout | Timeout for auto hiding the topbar and the buttons control bar. | "int" |
3000 |
lastN | The maximum number of participants that will be visible in as speaker. | "nat" |
4 |
mobileLastN | The maximum number of participants that will be visible in as speaker for mobile users. | "nat" |
1 |
maxLastN | The highest number of lastN the user can select manually in the user interface. | "nat" |
5 |
lockLastN | If true, the users can not change the number of visible speakers. | "boolean" |
false |
logo | If not null, it shows the logo loaded from the specified URL, otherwise it shows the title. | "url" |
"images/logo.edumeet.svg" |
title | The title to show if the logo is not specified. | "string" |
"edumeet" |
infoTooltipText | Informative text on the join page. If empty hidden. | "string" |
"" |
infoTooltipLink | Informative text link site on the join page. If empty hidden. | "string" |
"" |
infoTooltipDesc | Informative text description on the join page. If empty hidden. | "string" |
"" |
supportUrl | The service & Support URL; if null , it will be not displayed on the about dialogs. |
"url" |
"https://support.example.com" |
privacyUrl | The privacy and data protection external URL or local HTML path. | "string" |
"privacy/privacy.html" |
theme | UI theme elements colors. | "object" |
{ "palette": { "primary": { "main": "#313131" } }, "overrides": { "MuiAppBar": { "colorPrimary": { "backgroundColor": "#313131" } }, "MuiButton": { "containedPrimary": { "backgroundColor": "#5F9B2D", "&:hover": { "backgroundColor": "#5F9B2D" } }, "containedSecondary": { "backgroundColor": "#f50057", "&:hover": { "backgroundColor": "#f50057" } } }, "MuiFab": { "primary": { "backgroundColor": "#518029", "&:hover": { "backgroundColor": "#518029" }, "&:disabled": { "color": "#999898", "backgroundColor": "#323131" } }, "secondary": { "backgroundColor": "#f50057", "&:hover": { "backgroundColor": "#f50057" }, "&:disabled": { "color": "#999898", "backgroundColor": "#323131" } } }, "MuiBadge": { "colorPrimary": { "backgroundColor": "#5F9B2D", "&:hover": { "backgroundColor": "#518029" } } } }, "typography": { "useNextVariants": true }} |
Document generated with: yarn gen-config-docs
from: config.ts.