Skip to main content

BroadcastControls Interface

Common controls for States objects.

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​

/** @sealed */
export interface BroadcastControls

Properties​

Property Alerts Type Description
allowableUpdateLatencyMs Alpha number | undefined 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​

allowableUpdateLatencyMs: number | undefined;

Type: number | undefined

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.