HERE iOS SDK Developer's Guide

NMANavigationManager(NMANavigationManagerVoicePromptOptions)

Category Summary

category NMANavigationManager(NMANavigationManagerVoicePromptOptions)

Specifies at what times voice guidance prompts are triggered during car navigation.

Include: NMAKit.framework/headers/NMANavigationManager+VoicePromptOptions.h

[For complete information, see the section Category Details]

Instance Method Summary

Table 1. Instance Methods
Instance Method Summary

-(NSInteger) maximumDistanceFromPreviousManeuverForVoicePromptType:( NMANavigationVoicePromptType ) voicePromptType roadType:( NMANavigationRoadType ) roadType

Returns maximum distance after previous maneuver to announce next maneuver

-(NSInteger) maximumDistanceToUpcomingManeuverForVoicePromptType:( NMANavigationVoicePromptType ) voicePromptType roadType:( NMANavigationRoadType ) roadType

Returns maximum distance before upcoming maneuver to announce it

-(NSTimeInterval) maximumTimeFromPreviousManeuverForVoicePromptType:( NMANavigationVoicePromptType ) voicePromptType roadType:( NMANavigationRoadType ) roadType

Returns maximum time from previous maneuver to announce next maneuver

-(NSTimeInterval) maximumTimeToUpcomingManeuverForVoicePromptType:( NMANavigationVoicePromptType ) voicePromptType roadType:( NMANavigationRoadType ) roadType

Returns maximum time to upcoming maneuver to announce it

-(NSInteger) minimumDistanceFromPreviousManeuverForVoicePromptType:( NMANavigationVoicePromptType ) voicePromptType roadType:( NMANavigationRoadType ) roadType

Returns minimal distance from last maneuver to announce next maneuver

-(NSInteger) minimumDistanceToUpcomingManeuverForVoicePromptType:( NMANavigationVoicePromptType ) voicePromptType roadType:( NMANavigationRoadType ) roadType

Returns minimal distance before upcoming maneuver to announce it

-(NSTimeInterval) minimumTimeFromPreviousManeuverForVoicePromptType:( NMANavigationVoicePromptType ) voicePromptType roadType:( NMANavigationRoadType ) roadType

Returns minimal time from previous maneuver to announce next maneuver

-(NSTimeInterval) minimumTimeToUpcomingManeuverForVoicePromptType:( NMANavigationVoicePromptType ) voicePromptType roadType:( NMANavigationRoadType ) roadType

Returns minimal time to upcoming maneuver to announce it

-(void) resetAnnouncementRules

-(void) setMaximumDistance:(NSInteger) maximumDistance fromPreviousManeuverForVoicePromptType:( NMANavigationVoicePromptType ) voicePromptType roadType:( NMANavigationRoadType ) roadType

Configures voice guidance rules

-(void) setMaximumDistance:(NSInteger) maximumDistance toUpcomingManeuverForVoicePromptType:( NMANavigationVoicePromptType ) voicePromptType roadType:( NMANavigationRoadType ) roadType

Configures voice guidance rules

-(void) setMaximumTimeInterval:(NSTimeInterval) maximumTime fromPreviousManeuverForVoicePromptType:( NMANavigationVoicePromptType ) voicePromptType roadType:( NMANavigationRoadType ) roadType

Configures voice guidance rules

-(void) setMaximumTimeInterval:(NSTimeInterval) maximumTime toUpcomingManeuverForVoicePromptType:( NMANavigationVoicePromptType ) voicePromptType roadType:( NMANavigationRoadType ) roadType

Configures voice guidance rules

-(void) setMinimumDistance:(NSInteger) minimumDistance fromPreviousManeuverForVoicePromptType:( NMANavigationVoicePromptType ) voicePromptType roadType:( NMANavigationRoadType ) roadType

Configures voice guidance rules

-(void) setMinimumDistance:(NSInteger) minimumDistance toUpcomingManeuverForVoicePromptType:( NMANavigationVoicePromptType ) voicePromptType roadType:( NMANavigationRoadType ) roadType

Configures voice guidance rules

-(void) setMinimumTimeInterval:(NSTimeInterval) minimumTime fromPreviousManeuverForVoicePromptType:( NMANavigationVoicePromptType ) voicePromptType roadType:( NMANavigationRoadType ) roadType

Configures voice guidance rules

-(void) setMinimumTimeInterval:(NSTimeInterval) minimumTime toUpcomingManeuverForVoicePromptType:( NMANavigationVoicePromptType ) voicePromptType roadType:( NMANavigationRoadType ) roadType

Configures voice guidance rules

-(void) setTimeBasedDistance:(NSInteger) distance toUpcomingManeuverForVoicePromptType:( NMANavigationVoicePromptType ) voicePromptType roadType:( NMANavigationRoadType ) roadType

Configures voice guidance rules

-(NSInteger) timeBasedDistanceToUpcomingManeuverForVoicePromptType:( NMANavigationVoicePromptType ) voicePromptType roadType:( NMANavigationRoadType ) roadType

Returns time based distance before next maneuver to announce

Category Details

Specifies at what times voice guidance prompts are triggered during car navigation. For each upcoming maneuver, an instruction prompt to perform the maneuver is always triggered. In addition, up to three other prompts for performing the maneuver may be triggered, making a total of four possible prompt triggers per maneuver:

• ANNOUNCEMENT – announcement of an upcoming maneuver ahead of time • REMINDER 2 – distant reminder, given from quite a distance away from the maneuver • REMINDER 1 – nearby reminder, given when the maneuver is getting close • COMMAND – call for immediate action just before the maneuver

A distinction is made according to whether the driver is currently on a non-highway or a highway, as more time is typically needed to allow the driver to react appropriately when driving on a highway.

The conditions are evaluated as follows: First the conditions for the trigger COMMAND are tested, then REMINDER 1, REMINDER 2, and finally ANNOUNCEMENT. For each trigger, the distance-based conditions are evaluated first. If these are not met, then the time-based conditions are evaluated. As soon as a condition is met, the corresponding prompt is triggered. Each type of prompt can be triggered automatically at most once per maneuver.

Note:

just first ANNOUNCEMENT is issued immediately no matter what. Even if all parameters of ANNOUNCEMENT have been installed to -1 or any other values.

Note:

If ANNOUNCEMENT has been disabled then neither REMINDER 2 nor REMINDER 1 would be issued, only COMMAND.

Note:

If REMINDER 1 and REMINDER 2 met the same conditions then REMINDER 1 is issued, REMINDER 2 won't be issued.

Note:

The distance-based conditions are evaluated first. The time-based second. The time-based condition can be extended to take into consideration either time or distance conditions. See setTimeBasedDistance:toUpcomingManeuverForVoicePromptType:roadType:

Instance Method Details

-(NSInteger) maximumDistanceFromPreviousManeuverForVoicePromptType:( NMANavigationVoicePromptType ) voicePromptType roadType:( NMANavigationRoadType ) roadType

Returns maximum distance after previous maneuver to announce next maneuver.

Parameters:

  • voicePromptType

    type of announcement NMANavigationVoicePromptType.

  • roadType

    type of road NMANavigationRoadType.

Returns:

maximum distance in meters.

-(NSInteger) maximumDistanceToUpcomingManeuverForVoicePromptType:( NMANavigationVoicePromptType ) voicePromptType roadType:( NMANavigationRoadType ) roadType

Returns maximum distance before upcoming maneuver to announce it.

Parameters:

  • voicePromptType

    type of announcement NMANavigationVoicePromptType.

  • roadType

    type of road NMANavigationRoadType.

Returns:

maximum distance in meters.

-(NSTimeInterval) maximumTimeFromPreviousManeuverForVoicePromptType:( NMANavigationVoicePromptType ) voicePromptType roadType:( NMANavigationRoadType ) roadType

Returns maximum time from previous maneuver to announce next maneuver.

Parameters:

  • voicePromptType

    type of announcement NMANavigationVoicePromptType.

  • roadType

    type of road NMANavigationRoadType.

Returns:

maximum time in seconds.

-(NSTimeInterval) maximumTimeToUpcomingManeuverForVoicePromptType:( NMANavigationVoicePromptType ) voicePromptType roadType:( NMANavigationRoadType ) roadType

Returns maximum time to upcoming maneuver to announce it.

Parameters:

  • voicePromptType

    type of announcement NMANavigationVoicePromptType.

  • roadType

    type of road NMANavigationRoadType.

Returns:

maximum time in seconds.

-(NSInteger) minimumDistanceFromPreviousManeuverForVoicePromptType:( NMANavigationVoicePromptType ) voicePromptType roadType:( NMANavigationRoadType ) roadType

Returns minimal distance from last maneuver to announce next maneuver.

Parameters:

  • voicePromptType

    type of announcement NMANavigationVoicePromptType.

  • roadType

    type of road NMANavigationRoadType.

Returns:

minimal distance in meters.

-(NSInteger) minimumDistanceToUpcomingManeuverForVoicePromptType:( NMANavigationVoicePromptType ) voicePromptType roadType:( NMANavigationRoadType ) roadType

Returns minimal distance before upcoming maneuver to announce it.

Parameters:

  • voicePromptType

    type of announcement NMANavigationVoicePromptType.

  • roadType

    type of road NMANavigationRoadType.

Returns:

minimal distance in meters.

-(NSTimeInterval) minimumTimeFromPreviousManeuverForVoicePromptType:( NMANavigationVoicePromptType ) voicePromptType roadType:( NMANavigationRoadType ) roadType

Returns minimal time from previous maneuver to announce next maneuver.

Parameters:

  • voicePromptType

    type of announcement NMANavigationVoicePromptType.

  • roadType

    type of road NMANavigationRoadType.

Returns:

minimal time in seconds.

-(NSTimeInterval) minimumTimeToUpcomingManeuverForVoicePromptType:( NMANavigationVoicePromptType ) voicePromptType roadType:( NMANavigationRoadType ) roadType

Returns minimal time to upcoming maneuver to announce it.

Parameters:

  • voicePromptType

    type of announcement NMANavigationVoicePromptType.

  • roadType

    type of road NMANavigationRoadType.

Returns:

minimal time in seconds.

-(void) resetAnnouncementRules

Resets all announcment rules back to default values

-(void) setMaximumDistance:(NSInteger) maximumDistance fromPreviousManeuverForVoicePromptType:( NMANavigationVoicePromptType ) voicePromptType roadType:( NMANavigationRoadType ) roadType

Configures voice guidance rules. Sets maximum distance (in meters) from previous maneuver to announce next maneuver.

Parameters:

  • maximumDistance

    in meters. maximumDistance should be 0 or grater. Negative values, anything < 0 will avoid this rule.

  • voicePromptType

    type of announcement NMANavigationVoicePromptType.

  • roadType

    type of road NMANavigationRoadType.

-(void) setMaximumDistance:(NSInteger) maximumDistance toUpcomingManeuverForVoicePromptType:( NMANavigationVoicePromptType ) voicePromptType roadType:( NMANavigationRoadType ) roadType

Configures voice guidance rules. Sets maximum distance (in meters) to upcoming maneuver to announce it.

Parameters:

  • maximumDistance

    in meters. Value should be 0 or grater. Negative values, anything < 0 will avoid this rule.

  • voicePromptType

    type of announcement NMANavigationVoicePromptType.

  • roadType

    type of road NMANavigationRoadType.

-(void) setMaximumTimeInterval:(NSTimeInterval) maximumTime fromPreviousManeuverForVoicePromptType:( NMANavigationVoicePromptType ) voicePromptType roadType:( NMANavigationRoadType ) roadType

Configures voice guidance rules. Sets maximum time (in seconds) from previous maneuver to announce next maneuver.

Parameters:

  • maximumTime

    in seconds. maximumTime should be 0 or grater. Negative values, anything < 0 will avoid this rule.

  • voicePromptType

    type of announcement NMANavigationVoicePromptType.

  • roadType

    type of road NMANavigationRoadType.

-(void) setMaximumTimeInterval:(NSTimeInterval) maximumTime toUpcomingManeuverForVoicePromptType:( NMANavigationVoicePromptType ) voicePromptType roadType:( NMANavigationRoadType ) roadType

Configures voice guidance rules. Sets maximum time (in seconds) to upcoming maneuver to announce it.

Parameters:

  • maximumTime

    in seconds. Value should be 0 or grater. Negative values, anything < 0 will avoid this rule.

  • voicePromptType

    type of announcement NMANavigationVoicePromptType.

  • roadType

    type of road NMANavigationRoadType.

-(void) setMinimumDistance:(NSInteger) minimumDistance fromPreviousManeuverForVoicePromptType:( NMANavigationVoicePromptType ) voicePromptType roadType:( NMANavigationRoadType ) roadType

Configures voice guidance rules. Sets minimal distance (in meters) from previous maneuver to announce next maneuver.

Parameters:

  • minimumDistance

    in meters. minimumDistance should be 0 or grater. Negative values, anything < 0 will avoid this rule.

  • voicePromptType

    type of announcement NMANavigationVoicePromptType.

  • roadType

    type of road NMANavigationRoadType.

-(void) setMinimumDistance:(NSInteger) minimumDistance toUpcomingManeuverForVoicePromptType:( NMANavigationVoicePromptType ) voicePromptType roadType:( NMANavigationRoadType ) roadType

Configures voice guidance rules. Sets minimal distance (in meters) to upcoming maneuver to announce it.

Parameters:

  • minimumDistance

    in meters. minimumDistance should be 0 or grater. Negative values, anything < 0 will avoid this rule.

  • voicePromptType

    type of announcement NMANavigationVoicePromptType.

  • roadType

    type of road NMANavigationRoadType.

-(void) setMinimumTimeInterval:(NSTimeInterval) minimumTime fromPreviousManeuverForVoicePromptType:( NMANavigationVoicePromptType ) voicePromptType roadType:( NMANavigationRoadType ) roadType

Configures voice guidance rules. Sets minimal time (in seconds) from previous maneuver to announce next maneuver.

Parameters:

  • minimumTime

    in seconds. minimumTime should be 0 or grater. Negative values, anything < 0 will avoid this rule.

  • voicePromptType

    type of announcement

  • roadType

    type of road

-(void) setMinimumTimeInterval:(NSTimeInterval) minimumTime toUpcomingManeuverForVoicePromptType:( NMANavigationVoicePromptType ) voicePromptType roadType:( NMANavigationRoadType ) roadType

Configures voice guidance rules. Sets minimal time (in seconds) to upcoming maneuver to announce it.

Parameters:

  • minimumTime

    in seconds. Value should be 0 or grater. Negative values, anything < 0 will avoid this rule.

  • voicePromptType

    type of announcement

  • roadType

    type of road

-(void) setTimeBasedDistance:(NSInteger) distance toUpcomingManeuverForVoicePromptType:( NMANavigationVoicePromptType ) voicePromptType roadType:( NMANavigationRoadType ) roadType

Configures voice guidance rules. Sets the time based distance (in meters) before upcoming maneuver.

Note:

The distance-based conditions are evaluated first. The time-based second. The time-based condition can be extended to take into consideration either time or distance conditions. That is exactlly what the time based distance option for.

Parameters:

  • distance

    to upcoming menauver. Values should be 0 or grater. Negative values, anything < 0 will avoid this rule.

  • voicePromptType

    type of announcement NMANavigationVoicePromptType.

  • roadType

    type of road NMANavigationRoadType.

-(NSInteger) timeBasedDistanceToUpcomingManeuverForVoicePromptType:( NMANavigationVoicePromptType ) voicePromptType roadType:( NMANavigationRoadType ) roadType

Returns time based distance before next maneuver to announce.

Parameters:

  • voicePromptType

    type of announcement NMANavigationVoicePromptType.

  • roadType

    type of road NMANavigationRoadType.

Returns:

time based distance in meters