Class: GarminVoiceCalloutModule
Defined in: src/garminsdk/terrain/modules/voicecallout/GarminVoiceCalloutModule.ts:42
A Garmin terrain alerting system module that handles touchdown voice callouts.
Implements
Constructors
Constructor
new GarminVoiceCalloutModule(
options?):GarminVoiceCalloutModule
Defined in: src/garminsdk/terrain/modules/voicecallout/GarminVoiceCalloutModule.ts:59
Creates a new instance of GarminVoiceCalloutModule.
Parameters
| Parameter | Type | Description |
|---|---|---|
options? | Readonly<GarminVoiceCalloutModuleOptions> | Options with which to configure the module. |
Returns
GarminVoiceCalloutModule
Methods
onDestroy()
onDestroy():
void
Defined in: src/garminsdk/terrain/modules/voicecallout/GarminVoiceCalloutModule.ts:206
A method that is called when this module's parent system is destroyed.
Returns
void
Implementation of
onInit()
onInit():
void
Defined in: src/garminsdk/terrain/modules/voicecallout/GarminVoiceCalloutModule.ts:77
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
onUpdate()
onUpdate(
operatingMode,statuses,inhibits,data,alertController):void
Defined in: src/garminsdk/terrain/modules/voicecallout/GarminVoiceCalloutModule.ts:82
A method that is called every time this module's parent system is updated.
Parameters
| Parameter | 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