Skip to main content

Class: GarminVoiceCalloutModule

A Garmin terrain alerting system module that handles touchdown voice callouts.

Implements

Constructors

constructor

new GarminVoiceCalloutModule(options?): GarminVoiceCalloutModule

Creates a new instance of GarminVoiceCalloutModule.

Parameters

NameTypeDescription
options?Readonly<GarminVoiceCalloutModuleOptions>Options with which to configure the module.

Returns

GarminVoiceCalloutModule

Defined in

src/garminsdk/terrain/modules/voicecallout/GarminVoiceCalloutModule.ts:59

Methods

onDestroy

onDestroy(): void

A method that is called when this module's parent system is destroyed.

Returns

void

Implementation of

TerrainSystemModule.onDestroy

Defined in

src/garminsdk/terrain/modules/voicecallout/GarminVoiceCalloutModule.ts:206


onInit

onInit(): void

A method that is called when this module is attached to an initialized system, or when this module's parent system is initialized.

Returns

void

Implementation of

TerrainSystemModule.onInit

Defined in

src/garminsdk/terrain/modules/voicecallout/GarminVoiceCalloutModule.ts:77


onUpdate

onUpdate(operatingMode, statuses, inhibits, data, alertController): void

A method that is called every time this module's parent system is updated.

Parameters

NameTypeDescription
operatingModeTerrainSystemOperatingModeThe parent system's current operating mode.
statusesReadonlySet<string>-
inhibitsReadonlySet<string>The parent system's currently active inhibits.
dataReadonly<TerrainSystemData>The data provided by the parent system.
alertControllerTerrainSystemAlertControllerA controller for alerts issued by the parent system.

Returns

void

Implementation of

TerrainSystemModule.onUpdate

Defined in

src/garminsdk/terrain/modules/voicecallout/GarminVoiceCalloutModule.ts:82