BroadcastControlSettings Interface
Value set to configure BroadcastControls.
This API is provided as an alpha preview and may change without notice.
To use, import via @fluidframework/presence/alpha.
For more information about our API support guarantees, see here.
Signature
export interface BroadcastControlSettings
Properties
| Property | Alerts | Modifiers | Default Value | Type | Description |
|---|---|---|---|---|---|
| allowableUpdateLatencyMs | Alpha |
optional, readonly |
60 [milliseconds] | number | Maximum time in milliseconds that a local value update is allowed to remain pending before it must be broadcast. |
Property Details
allowableUpdateLatencyMs
Maximum time in milliseconds that a local value update is allowed to remain pending before it must be broadcast.
This API is provided as an alpha preview and may change without notice.
For more information about our API support guarantees, see here.
Signature
readonly allowableUpdateLatencyMs?: number;
Type: number
Remarks
There is no guarantee of broadcast within time allowed as other conditions such as disconnect or service throttling may cause a delay.
Setting to undefined will restore to a system default.