Skip to main content

BroadcastControlSettings Interface

Value set to configure BroadcastControls.

Signature​

export interface BroadcastControlSettings

Properties​

PropertyModifiersDefault ValueTypeDescription
allowableUpdateLatencyMsoptional, readonly60 [milliseconds]numberMaximum 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​

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.