Skip to main content

Class: AuralAlertSystemWarningAdapter

Defined in: src/sdk/utils/sound/AuralAlertSystemWarningAdapter.ts:14

Adapts Warning to AuralAlertSystem. Given a list of warnings, the adapter will register one aural alert for each warning that defines a soundId. Alerts are set to repeat while active unless the warning is defined to play only once. The adapter also manages activation/deactivation of the alerts using the condition logic of their associated warnings. All alerts are assigned to the same queue.

Constructors

Constructor

new AuralAlertSystemWarningAdapter(bus, logicHost, warnings, queue): AuralAlertSystemWarningAdapter

Defined in: src/sdk/utils/sound/AuralAlertSystemWarningAdapter.ts:26

Creates a new instance of AuralAlertSystemWarningAdapter.

Parameters

ParameterTypeDescription
busEventBusThe event bus.
logicHostCompositeLogicXMLHostThe XML logic host used to run this adapter's warning condition logic.
warningsreadonly Warning[]This adapter's warnings, in order of decreasing priority.
queuestringThe aural alert queue to assign this adapter's alerts.

Returns

AuralAlertSystemWarningAdapter

Methods

start()

start(): void

Defined in: src/sdk/utils/sound/AuralAlertSystemWarningAdapter.ts:38

Registers this adapter's alerts with AuralAlertSystem and starts automatically managing alert states.

Returns

void