Skip to main content

Type Alias: CasAuralAlertTransporterOptions

CasAuralAlertTransporterOptions = object

Defined in: src/sdk/utils/sound/CasAuralAlertTransporter.ts:10

Configuration options for CasAuralAlertTransporter.

Properties​

auralAction​

auralAction: "activate" | "trigger"

Defined in: src/sdk/utils/sound/CasAuralAlertTransporter.ts:23

The action to apply to the transporter's aural alert when the transporter's CAS alert state changes.

auralActivation()?​

optional auralActivation: () => AuralAlertActivation | undefined

Defined in: src/sdk/utils/sound/CasAuralAlertTransporter.ts:20

A function which generates activation data for the transporter's aural alert. If not defined, then the aural alert will be activated/triggered using its default registered parameters.

Returns​

AuralAlertActivation | undefined

Activation data to use for the transporter's aural alert, or undefined to use the default registered parameters of the transporter's aural alert.

auralUuid​

auralUuid: string

Defined in: src/sdk/utils/sound/CasAuralAlertTransporter.ts:12

The ID of the transporter's aural alert.

casPriority​

casPriority: AnnunciationType

Defined in: src/sdk/utils/sound/CasAuralAlertTransporter.ts:29

The priority level of the CAS alert to which to bind the transporter's aural alert.

casSuffix?​

optional casSuffix: string

Defined in: src/sdk/utils/sound/CasAuralAlertTransporter.ts:32

The suffix, if any, of the CAS alert to which to bind the transporter's aural alert.

casUuid​

casUuid: string

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

The ID of the CAS alert to which to bind the transporter's aural alert.

includeAcknowledged​

includeAcknowledged: boolean

Defined in: src/sdk/utils/sound/CasAuralAlertTransporter.ts:35

Whether to activate the transporter's aural alert when the bound CAS alert is acknowledged.