From db39e605f03e78e6aebca10285e3e0b3167aba51 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jo=C3=A3o=20Pedro=20Monteiro=20Morgado=20Dias?= Date: Wed, 4 Sep 2024 17:02:37 +0100 Subject: [PATCH] Change the description of outboundBatchInterval to reflect last Spaces SDK changes --- content/spaces/cursors.textile | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/spaces/cursors.textile b/content/spaces/cursors.textile index a21fc53850..75786209cd 100644 --- a/content/spaces/cursors.textile +++ b/content/spaces/cursors.textile @@ -113,7 +113,7 @@ The following cursor options can be set: h3(#batch). outboundBatchInterval -The @outboundBatchInterval@ is the interval at which a batch of cursor positions are published, in milliseconds, for each client. This is multiplied by the number of members in a space. +The @outboundBatchInterval@ is the interval at which a batch of cursor positions are published, in milliseconds, for each client. This interval increases as the number of members in a space grows, adjusting based on groups of 100 members. The default value is 25ms which is optimal for the majority of use cases. If you wish to optimize the interval further, then decreasing the value will improve performance by further 'smoothing' the movement of cursors at the cost of increasing the number of events sent. Be aware that at a certain point the rate at which a browser is able to render the changes will impact optimizations.