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
Name | Type | Description |
---|---|---|
options? | Readonly <GarminVoiceCalloutModuleOptions > | Options with which to configure the module. |
Returns
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
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
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
Name | Type | Description |
---|---|---|
operatingMode | TerrainSystemOperatingMode | The parent system's current operating mode. |
statuses | ReadonlySet <string > | - |
inhibits | ReadonlySet <string > | The parent system's currently active inhibits. |
data | Readonly <TerrainSystemData > | The data provided by the parent system. |
alertController | TerrainSystemAlertController | A controller for alerts issued by the parent system. |
Returns
void
Implementation of
Defined in
src/garminsdk/terrain/modules/voicecallout/GarminVoiceCalloutModule.ts:82