HERE iOS SDK Developer's Guide

NMA Navigation

Group Summary

group NMA Navigation

The Navigation group includes classes, protocols, and enumerations related to guidance and turn-by-turn navigation.

[For complete information, see the section Group Details]

Nested Classes

Public Typedef Summary

Table 2. Public Typedefs
Public Typedefs

(unsigned long long) NMAUint64

Unsigned integer, 64 bit wide

Public Enumeration Summary

Table 3. Public Enumerations
Public Enumerations

NMALaneInformationCrossingRestriction

Crossing restriction to enter or exit a HOV lane.

NMALaneInformationDirection

All possible directions the lane leads.

NMALaneInformationMarkingType

Marking types for the divider and center marking.

NMALaneInformationRecommendationState

Recommendation for taking the lane according to the lane connectivity.

NMAMapTrackingOrientation

The orientation that is used when map tracking is enabled.

NMAMapTrackingTilt

The tilt that is used when map tracking is enabled.

NMAMeasurementSystem

Distance measurement unit systems

NMANaturalGuidanceOption

Options for the NMANavigationManager natural guidance feature, set using the NMANavigationManager::setNaturalGuidanceMode: method.

NMANavigationAudioEvent

Configures the audio events that will be played during Navigation.

NMANavigationError

Navigation Errors

NMANavigationMode

The possible modes of NMANavigationManager.

NMANavigationState

The possible states of NMANavigationManager.

NMARealisticViewAspectRatio

Realistic view aspect ratio

NMARealisticViewMode

Realistic view modes

NMATTSOutputFormat

TTS output format in which the text should be generated.

NMATrafficAvoidanceMode

Options for the NMANavigationManager traffic avoidance feature, set using the NMANavigationManager::setTrafficAvoidanceMode:(NSUInteger) method.

NMATrafficEnabledRoutingState

NMAVoiceCatalogError

VoiceCatalog Errors.

NMAVoiceGender

Public Variable Summary

Table 4. Public Variables
Public Variables

FOUNDATION_EXPORT NSString *const _Nonnull  NMANavigationManagerErrorDomain

The error domain for Navigation Manager

FOUNDATION_EXPORT NMAUint64 const  NMANavigationManagerInvalidValue

Indicates failure of a computation for a 64-bit value

FOUNDATION_EXPORT NSString *const _Nonnull  NMANavigationManagerJunctionViewKey

FOUNDATION_EXPORT NSString *const _Nonnull  NMANavigationManagerSignpostKey

FOUNDATION_EXPORT NSString *const _Nonnull  NMANavigationManagerStateChangedNotification

This notification is sent whenever the NMANavigationManager navigationState property changes

FOUNDATION_EXPORT const id _Nonnull  NMARealisticView16x9Key

FOUNDATION_EXPORT const id _Nonnull  NMARealisticView3x5Key

FOUNDATION_EXPORT const id _Nonnull  NMARealisticView4x3Key

FOUNDATION_EXPORT const id _Nonnull  NMARealisticView5x3Key

FOUNDATION_EXPORT NSString *const _Nonnull  NMAVoiceCatalogErrorDomain

Group Details

The Navigation group includes classes, protocols, and enumerations related to guidance and turn-by-turn navigation. The key class to this group is NMANavigationManager.

Public Typedef Details

(unsigned long long) NMAUint64

Include: NMAKit.framework/headers/NMANavigationManager.h

Unsigned integer, 64 bit wide

Public Enumeration Details

NMALaneInformationCrossingRestriction

Include: NMAKit.framework/headers/NMALaneInformation.h

Crossing restriction to enter or exit a HOV lane.

See also:

NMALaneInformation

Enumeration Members:

  • NMALaneInformationCrossingRestrictionNoRestriction

    No restriction.

  • NMALaneInformationCrossingRestrictionLeft

    Left restriction.

  • NMALaneInformationCrossingRestrictionRight

    Right restriction.

  • NMALaneInformationCrossingRestrictionBoth

    Both directions restricted.

NMALaneInformationDirection

Include: NMAKit.framework/headers/NMALaneInformation.h

All possible directions the lane leads.

A combination of the NMALaneInformationDirection forms a direction bitmask.

See also:

NMALaneInformation

Enumeration Members:

  • NMALaneInformationDirectionMaskUndefined

    Indicates there are no markings on this lane and the direction is unknown.

  • NMALaneInformationDirectionMaskStraight

    Indicates that the direction of travel is straight ahead.

  • NMALaneInformationDirectionMaskSlightlyRight

    Indicates a slight right turn.

  • NMALaneInformationDirectionMaskRight

    Indicates a right turn.

  • NMALaneInformationDirectionMaskSharpRight

    Indicates a sharp right turn.

  • NMALaneInformationDirectionMaskUTurnLeft

    Indicates a left u-turn.

  • NMALaneInformationDirectionMaskSharpLeft

    Indicates a sharp left turn.

  • NMALaneInformationDirectionMaskLeft

    Indicates a left turn.

  • NMALaneInformationDirectionMaskSlightlyLeft

    Indicates a slight left turn.

  • NMALaneInformationDirectionMaskMergeRight

    Indicates a right merge.

  • NMALaneInformationDirectionMaskMergeLeft

    Indicates a left merge.

  • NMALaneInformationDirectionMaskMergeLanes

    Indicates a merge of lanes.

  • NMALaneInformationDirectionMaskUTurnRight

    Indicates a right u-turn.

  • NMALaneInformationDirectionMaskSecondRight

    Indicates a second right.

  • NMALaneInformationDirectionMaskSecondLeft

    Indicates a second left.

NMALaneInformationMarkingType

Include: NMAKit.framework/headers/NMALaneInformation.h

Marking types for the divider and center marking.

See also:

NMALaneInformation

Enumeration Members:

  • NMALaneInformationMarkingTypeNotAvailable

    Not Available.

  • NMALaneInformationMarkingTypeLongDashed

    Long dashed.

  • NMALaneInformationMarkingTypeDoubleSolidLine

    Double solid line.

  • NMALaneInformationMarkingTypeSingleSolidLine

    Single solid line.

  • NMALaneInformationMarkingTypeDoubleInnerSingleOuterDashed

    Double inner single outer dashed.

  • NMALaneInformationMarkingTypeDoubleInnerDashedOuterSingle

    Double inner dashed outer single.

  • NMALaneInformationMarkingTypeShortDashed

    Short dashed.

  • NMALaneInformationMarkingTypeSharedArea

    Shared area.

  • NMALaneInformationMarkingTypeDashedBlocks

    Dashed blocks.

  • NMALaneInformationMarkingTypePhysicalDivider

    Physical divider.

  • NMALaneInformationMarkingTypeDoubleDashed

    Double dashed.

  • NMALaneInformationMarkingTypeNoDivider

    No divider.

  • NMALaneInformationMarkingTypeCrossingAlert

    Crossing alert.

NMALaneInformationRecommendationState

Include: NMAKit.framework/headers/NMALaneInformation.h

Recommendation for taking the lane according to the lane connectivity.

See also:

NMALaneInformation

Enumeration Members:

  • NMALaneInformationRecommendationStateNotRecommended

    The lane is not on the current route.

  • NMALaneInformationRecommendationStateRecommended

    The lane is on the route at least up to the next decision point, but not for the whole part of the route for which connectivity information is available.

  • NMALaneInformationRecommendationStateHighlyRecommended

    The lane is on the current route for the whole part of the route for which connectivity information is available.

  • NMALaneInformationRecommendationStateNotAvailable

    Recommendation information is not available.

NMAMapTrackingOrientation

Include: NMAKit.framework/headers/NMANavigationManager.h

The orientation that is used when map tracking is enabled.

Enumeration Members:

  • NMAMapTrackingOrientationDynamic

    The map will be oriented with the current heading toward the top of the screen.

  • NMAMapTrackingOrientationNorthUp

    The map will be oriented with north toward the top of the screen.

NMAMapTrackingTilt

Include: NMAKit.framework/headers/NMANavigationManager.h

The tilt that is used when map tracking is enabled.

Enumeration Members:

  • NMAMapTrackingTilt2D

    The map will be automatically tilted to a 2D perspective.

  • NMAMapTrackingTilt3D

    The map will be automatically tilted to a 3D perspective.

  • NMAMapTrackingTiltCustom

    The map tilt will not be changed.

NMAMeasurementSystem

Include: NMAKit.framework/headers/NMANavigationManager.h

Distance measurement unit systems

Enumeration Members:

  • NMAMeasurementSystemMetric

    Meter and kilometer.

  • NMAMeasurementSystemImperial

    Miles and yards.

  • NMAMeasurementSystemImperialUS

    Miles and feet.

NMANaturalGuidanceOption

Include: NMAKit.framework/headers/NMANavigationManager.h

Options for the NMANavigationManager natural guidance feature, set using the NMANavigationManager::setNaturalGuidanceMode: method.

Enumeration Members:

  • NMANaturalGuidanceNone  
  • NMANaturalGuidanceTrafficLight

    Natural guidance for traffic lights.

  • NMANaturalGuidanceLandmark

    Natural guidance for landmarks

NMANavigationAudioEvent

Include: NMAKit.framework/headers/NMANavigationManager.h

Configures the audio events that will be played during Navigation.

Enumeration Members:

  • NMANavigationAudioEventSafetySpot

    Safety spot audio event (played when approaching a safety spot).

    /note Not played if access to this operation is denied. Contact your HERE representative for more information.

NMANavigationError

Include: NMAKit.framework/headers/NMANavigationManager.h

Navigation Errors

Enumeration Members:

  • NMANavigationErrorNone  
  • NMANavigationErrorGuidanceNotReady

    Guidance is not ready for use.

  • NMANavigationErrorNotReady

    Guidance Polling must be continued.

  • NMANavigationErrorPositioningFailed

    Failed to start Positioning Manager.

  • NMANavigationErrorOutOfMemory

    Out of Memory.

  • NMANavigationErrorInvalidParameters

    Invalid Parameters.

  • NMANavigationErrorInvalidOperation

    Operation not allowed at the time of the call.

  • NMANavigationErrorNotFound

    When something was not found (e.g. voice skins)

  • NMANavigationErrorAborted

    Operation aborted.

  • NMANavigationErrorOperationNotAllowed

    The current SDK does not allow the operation.

  • NMANavigationErrorInvalidCredentials

    HERE Developer credentials are invalid or were not provided.

  • NMANavigationErrorPedestrianNavigationNotAvailable

    The current position data source does not support pedestrian navigation.

  • NMANavigationErrorUnknown

    Generic error.

NMANavigationMode

Include: NMAKit.framework/headers/NMANavigationManager.h

The possible modes of NMANavigationManager.

Enumeration Members:

  • NMANavigationModeNone

    Navigation is not running.

  • NMANavigationModeTurnByTurn

    Navigation is running in turn-by-turn mode (following a route using GPS data, recalculation will occur if position deviates from route)

  • NMANavigationModeTracking

    Navigation is running in tracking mode (Not following a route, GPS data drives map movement)

NMANavigationState

Include: NMAKit.framework/headers/NMANavigationManager.h

The possible states of NMANavigationManager.

Enumeration Members:

  • NMANavigationStateIdle

    No navigation is in progress.

  • NMANavigationStateRunning

    Navigation (guidance or tracking) is in progress and active.

  • NMANavigationStatePaused

    Navigation is in progress but not currently active.

NMARealisticViewAspectRatio

Include: NMAKit.framework/headers/NMANavigationManager.h

Realistic view aspect ratio

Enumeration Members:

  • NMARealisticView16x9  
  • NMARealisticView3x5  
  • NMARealisticView5x3  
  • NMARealisticView4x3  

NMARealisticViewMode

Include: NMAKit.framework/headers/NMANavigationManager.h

Realistic view modes

Enumeration Members:

  • NMARealisticViewOff  
  • NMARealisticViewDay  
  • NMARealisticViewNight  

NMATTSOutputFormat

Include: NMAKit.framework/headers/NMANavigationManager.h

TTS output format in which the text should be generated.

See also:

NMANavigationManagerDelegateshouldPlayVoiceFeedbackWithText:::navigationManager:shouldPlayVoiceFeedbackWithText:

Enumeration Members:

  • NMATTSOutputFormatRaw

    The text won't include any phonemes and escape sequences.

  • NMATTSOutputFormatNuance

    The text will include phonemes in a format supported by Nuance TTS.

NMATrafficAvoidanceMode

Include: NMAKit.framework/headers/NMANavigationManager.h

Options for the NMANavigationManager traffic avoidance feature, set using the NMANavigationManager::setTrafficAvoidanceMode:(NSUInteger) method.

Enumeration Members:

  • NMATrafficAvoidanceDynamic
  • NMATrafficAvoidanceManual

    Traffic on route avoidance must be confirmed by the user.

  • NMATrafficAvoidanceDisabled

    Disable use of traffic for rerouting purpose.

NMATrafficEnabledRoutingState

Include: NMAKit.framework/headers/NMANavigationManager.h

See also:

NMANavigationManager::setTrafficAvoidanceMode:

NMATrafficAvoidanceMode

Enumeration Members:

  • NMATrafficEnabledRoutingStateOff

    Route re-calculation due to traffic is disabled, when traffic avoidance mode is set to NMATrafficAvoidanceDisabled.

  • NMATrafficEnabledRoutingStateOn

    Route re-calculation due to traffic is enabled and not currently in use.

  • NMATrafficEnabledRoutingStateOngoingRequest

    Deprecated: As of SDK 3.4. Will not occur.

    Route re-calculation is enabled and it currently handling the on-going re-routing.

  • NMATrafficEnabledRoutingStateNotAvailable

    Route re-calculation is enabled but re-routing cannot be processed. For example, the application is currently offline.

NMAVoiceCatalogError

Include: NMAKit.framework/headers/NMAVoiceCatalog.h

VoiceCatalog Errors.

Enumeration Members:

  • NMAVoiceCatalogErrorNone  
  • NMAVoiceCatalogErrorUnknown

    General error

    Note:

    This is also returned for network related errors such as no connectivity.

  • NMAVoiceCatalogErrorNotFound  
  • NMAVoiceCatalogErrorInvalidOperation  
  • NMAVoiceCatalogErrorInvalidParameters  
  • NMAVoiceCatalogErrorFileOpen  
  • NMAVoiceCatalogErrorDownloadNotReady  
  • NMAVoiceCatalogErrorVoiceLoadingFailed  
  • NMAVoiceCatalogErrorMissingMandatoryFields  
  • NMAVoiceCatalogErrorOutOfMemory  
  • NMAVoiceCatalogErrorCancelled  

NMAVoiceGender

Include: NMAKit.framework/headers/NMAVoicePackage.h

Enumeration Members:

  • NMAVoiceGenderFemale

    Female voice.

  • NMAVoiceGenderMale

    Male voice.

  • NMAVoiceGenderBoth

    Female or Male voice.

  • NMAVoiceGenderUnknown

    Unknown gender for the voice.

Public Variable Details

FOUNDATION_EXPORT NSString *const _Nonnull NMANavigationManagerErrorDomain

Include: NMAKit.framework/headers/NMANavigationManager.h

The error domain for Navigation Manager.

FOUNDATION_EXPORT NMAUint64 const NMANavigationManagerInvalidValue

Include: NMAKit.framework/headers/NMANavigationManager.h

Indicates failure of a computation for a 64-bit value.

FOUNDATION_EXPORT NSString *const _Nonnull NMANavigationManagerJunctionViewKey

Include: NMAKit.framework/headers/NMANavigationManager.h

This is the key for extracting junction view from realistic view

FOUNDATION_EXPORT NSString *const _Nonnull NMANavigationManagerSignpostKey

Include: NMAKit.framework/headers/NMANavigationManager.h

This is the key for extracting signpost from realistic view

FOUNDATION_EXPORT NSString *const _Nonnull NMANavigationManagerStateChangedNotification

Include: NMAKit.framework/headers/NMANavigationManager.h

This notification is sent whenever the NMANavigationManager navigationState property changes.

FOUNDATION_EXPORT const id _Nonnull NMARealisticView16x9Key

Include: NMAKit.framework/headers/NMANavigationManager.h

This is the key for extracting 16x9 realistic view

FOUNDATION_EXPORT const id _Nonnull NMARealisticView3x5Key

Include: NMAKit.framework/headers/NMANavigationManager.h

This is the key for extracting 3x5 realistic view

FOUNDATION_EXPORT const id _Nonnull NMARealisticView4x3Key

Include: NMAKit.framework/headers/NMANavigationManager.h

This is the key for extracting 4x3 realistic view

FOUNDATION_EXPORT const id _Nonnull NMARealisticView5x3Key

Include: NMAKit.framework/headers/NMANavigationManager.h

This is the key for extracting 5x3 realistic view

FOUNDATION_EXPORT NSString *const _Nonnull NMAVoiceCatalogErrorDomain

Include: NMAKit.framework/headers/NMAVoiceCatalog.h

You cannot use this account to purchase a commercial plan on Developer Portal, as it is already associated to plans with different payment methods.

To purchase a commercial plan on Developer Portal, please register for or sign in with a different HERE Account.

Something took longer than expected.

The project should be available soon under your projects page.

Sorry, our services are not available in this region.

Something seems to have gone wrong. Please try again later.

We've detected that your account is set to Australian Dollars (AUD).
Unfortunately, we do not offer checkouts in AUD anymore.
You can continue using your current plan as normal, but to subscribe to one of our new plans,
please register for a new HERE account or contact us for billing questions on selfservesupport@here.com.