Canvas call administration
See also: Canvas call for what people see and do, Server configuration for the server setting, and Client network requirements.
The canvas call lets everyone who has the same canvas open talk to each other and see each other. It needs no extra service, port or installer. This page covers what an administrator decides: whether the call is available, what each installation may use, what it needs from the network, and what it means for privacy.
The canvas call needs Canvus 26.11.3 or later on the client and Canvus Server 26.11.2 or later. Only the Canvus desktop client takes part. The web client does not, and older desktop clients do not appear in the call.
What you can control
Two layers decide whether people on a canvas see the canvas call.
- The server switches the call on or off for every canvas it hosts. See the server setting.
- Each client installation decides whether its workspaces may use a camera and a microphone. See the installation switches.
There is no switch for a single canvas, and no switch for a single person.
The server setting
The server setting canvas-call-enabled is in the [system] section of mt-canvus-server.ini. It is on by default. When you set it to false, the server tells clients that the call is off and drops any call media it receives. Restart the server for the change to take effect.
[system]
; DEFAULT: true
; canvas-call-enabled=true
On a container deployment, set CANVUS_CANVAS_CALL_ENABLED to true or false. See Server configuration.
The installation switches
Two keys in the [canvas-call] section of mt-canvus.ini decide what an installation may use. Both default to true.
[canvas-call]
; Set to false to never use a camera on this installation, so no head shots
; are sent from it.
; DEFAULT: true
; allow-camera=true
; Set to false to never use a microphone on this installation, so nobody on
; it can be heard in the canvas call.
; DEFAULT: true
; allow-microphone=true
allow-camera |
allow-microphone |
What happens |
|---|---|---|
true |
true |
The call is on. People can use a camera and a microphone. |
false |
true |
People can speak and listen, but no head shot is sent from this installation. The Camera section is missing from the panel. |
true |
false |
People can listen and send a head shot, but nobody on this installation can be heard. The Microphone section is missing from the panel, and the mute toggle on the avatar does not appear. |
false |
false |
The call is not offered on this installation at all. There are no call indicators, the panel does not open, and the installation does not play the call. |
Whenever the call is offered, the installation plays what other people say. Use the [canvas-call] keys, not the server, when only some computers should not send a camera or a microphone, such as a lobby wall.
Canvus reads mt-canvus.ini when it starts, so restart Canvus after you change a key. The Settings page has no control for these keys. See the Settings index. Write true or false. Canvus also accepts 1, 0, yes, no, on and off. An empty or unreadable value counts as true, and Canvus logs a warning for an unreadable one.
Where Canvus keeps people's choices
Canvus keeps each person's camera, circle, microphone, gain, speaker, volume and guest name in canvas-call-settings.json, in the same folder as the person's mt-canvus.ini. See file locations. Canvus writes the file safely, so a crash does not damage it. If the file is damaged, Canvus starts with empty choices and keeps a copy as canvas-call-settings.json.corrupt.
Canvus remembers choices for each signed-in person, on each workspace and server. It remembers a guest's choices and guest name only on a single-user installation. On a multi-user installation many people share the guest account, so Canvus keeps a guest's choices in memory for the session and never writes them. See Single user or multi-user mode.
Network needs
The canvas call uses TCP only, through the connection that each client already has to Canvus Server. You open no new port, you run no new service, and you allow no UDP traffic. If shared canvases work through your firewall and proxy, the call works too. The server forwards each client's call audio and head shots to the other clients on the same canvas, unchanged. It does not mix or re-encode them, which keeps the server's load low.
- Voice. Each person who is unmuted sends about 28 kbit/s while they speak, and less while they are silent.
- Head shots. Each camera that is on sends a small picture, about 160 px square at 15 frames per second, which uses about 125 kbit/s.
- What a client receives. The traffic that reaches each client grows with the number of people who are unmuted and with the number of cameras that are on.
- Server load. In engineering tests, 25 clients that were all sending voice and head shots cost about a fifth of one processor core, counting the clients as well.
Because the call travels over TCP, quality depends on the link between each client and the server. The figures below come from engineering tests with simulated network conditions, with one person talking and one listening. Mouth-to-ear delay includes about 50 ms for capture, coding and playback that the tests estimated rather than measured.
| Link between a client and the server | Approximate mouth-to-ear delay | Dropouts per minute |
|---|---|---|
| Local network, 1 ms | 95 ms | 0 |
| 10 ms, 1% of packets lost | 135 ms | 0 |
| 10 ms, 3% lost | 225 ms | 4 |
| 50 ms, 1% lost | 305 ms | 1 |
| 100 ms with jitter | 370 ms | 0 |
| 100 ms with jitter, 3% lost | Not usable | Many |
The call is built for local networks and good wide-area links. On a long-distance link that loses packets, voice stalls and then catches up, and Canvus drops audio that arrives too late. Clients behind a proxy reach the server as they do for shared canvases. See Proxy servers.
Privacy
The Canvus server forwards the call without decoding it, but the call is not end-to-end encrypted, so the server can read it. Each client protects call audio and video only on its own connection to the server, with the same TLS as the rest of the canvas traffic. Canvus does not record the call, and the server does not store it.
Warning
If you set ssl-enabled=false on the server or protocol=tcp for a server in mt-canvus.ini, the call travels unencrypted on the network as well. See the security overview.
Everyone who has a canvas open is in its call, guests included. Anyone who can open the canvas can hear and see the people on it. A guest chooses their own guest name, and the name is a label, not proof of who the person is. To keep the call away from a computer, set both [canvas-call] keys to false. To keep it away from everyone, set canvas-call-enabled to false on the server.
A camera and a microphone are used only when a person turns them on. Canvus starts every canvas open muted, keeps the microphone closed while a person is muted, and never turns the camera on during a first run.