Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update configuration.md and iframe-commands.md #483

Merged
merged 1 commit into from
Dec 19, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 28 additions & 0 deletions docs/dev-guide/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -1356,6 +1356,34 @@ securityUi: {
}
```

## Testing
### testing

type: `Object`

Experimental features.

Default: **unset**

Properties:
* `assumeBandwidth` - Allows the setting of a custom bandwidth value from the UI.
* `disableE2EE` - Disables the End to End Encryption feature. Useful for debugging issues related to insertable streams.
* `mobileXmppWsThreshold` - Enables XMPP WebSocket (as opposed to BOSH) for the given amount of users.
* `p2pTestMode` - P2P test mode disables automatic switching to P2P when there are 2 participants in the conference.
* `testMode` - Enables the test specific features consumed by jitsi-meet-torture.
* `noAutoPlayVideo` - Disables the auto-play behavior of *all* newly created video element. This is useful when the client runs on a host with limited resources.

```javascript
testing: {
assumeBandwidth: true,
disableE2EE: false,
mobileXmppWsThreshold: 10, // enable XMPP WebSockets on mobile for 10% of the users
p2pTestMode: false,
testMode: false,
noAutoPlayVideo: false
}
```

## Video

### constraints
Expand Down
10 changes: 10 additions & 0 deletions docs/dev-guide/iframe-commands.md
Original file line number Diff line number Diff line change
Expand Up @@ -699,3 +699,13 @@ Toggles the whiteboard to open, repeated toggling hidden the whiteboard
```javascript
api.executeCommand('toggleWhiteboard');
```

### setAssumedBandwidthBps

Sets the assumed bandwidth bps.

```javascript
api.executeCommand('setAssumedBandwidthBps',
assumedBandwidthBps: number // Required. The value to set as assumed bandwidth expressed in bps.
);
```