Skip to main content

BroadcastControls Interface

Common controls for States objects.

Sealed

This type is "sealed," meaning that code outside of the library defining it should not implement or extend it. Future versions of this type may add members or make typing of readonly members more specific.

Signature​

/** @sealed */
export interface BroadcastControls

Properties​

PropertyTypeDescription
allowableUpdateLatencyMsnumber | undefinedMaximum 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.

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.