GoogleNavigation Framework Reference

AI-generated Key Takeaways

• This documentation lists globally available enumerations for the Google Maps SDK for iOS Navigation.

• These enumerations control aspects like navigation behavior, camera settings, route preferences, and UI elements.

• Each enumeration is defined in both Swift and Objective-C with a brief description of its purpose.

• Developers can use these enumerations to customize the functionality and appearance of their navigation experience.

Enumerations

The following enumerations are available globally.

• GMSNavigationDelayCategory

  A GMSNavigationDelayCategory is a category that represents the delay category of a route or a a path.

  Declaration

  Swift

  enum GMSNavigationDelayCategory : Int, @unchecked Sendable

  Objective-C

  enum GMSNavigationDelayCategory : NSInteger {}

• GMSNavigationManeuverImageSize

  The image size which GMSNavigationStepInfo images will be generated.

  Declaration

  Swift

  enum GMSNavigationManeuverImageSize : Int, @unchecked Sendable

  Objective-C

  enum GMSNavigationManeuverImageSize : NSInteger {}

• GMSNavigationCameraMode

  The camera mode which determines the camera following behavior.

  Declaration

  Swift

  enum GMSNavigationCameraMode : Int, @unchecked Sendable

  Objective-C

  enum GMSNavigationCameraMode : NSInteger {}

• GMSNavigationCameraPerspective

  The different camera perspectives that can be set when following the user location.

  Declaration

  Swift

  enum GMSNavigationCameraPerspective : Int, @unchecked Sendable

  Objective-C

  enum GMSNavigationCameraPerspective : NSInteger {}

• GMSNavigationTravelMode

  The different travel modes that can be used for navigation.

  Declaration

  Swift

  enum GMSNavigationTravelMode : Int, @unchecked Sendable

  Objective-C

  enum GMSNavigationTravelMode : NSInteger {}

• GMSNavigationVoiceGuidance

  Determines whether voice guidance is played under certain circumstances.

  Declaration

  Swift

  enum GMSNavigationVoiceGuidance : Int, @unchecked Sendable

  Objective-C

  enum GMSNavigationVoiceGuidance : NSInteger {}

• GMSVoiceGuidanceAudioDeviceType

  Determines what type of audio devices voice guidance may be played through.

  Declaration

  Swift

  enum GMSVoiceGuidanceAudioDeviceType : Int, @unchecked Sendable

  Objective-C

  enum GMSVoiceGuidanceAudioDeviceType : NSInteger {}

• GMSRouteStatus

  A GMSRouteStatus is a status code that represents the result of a route request.

  Declaration

  Swift

  enum GMSRouteStatus : Int, @unchecked Sendable

  Objective-C

  enum GMSRouteStatus : NSInteger {}

• GMSNavigationLightingMode

  Lighting mode is used to specify different color schemes based on available light.

  Declaration

  Swift

  enum GMSNavigationLightingMode : Int, @unchecked Sendable

  Objective-C

  enum GMSNavigationLightingMode : NSInteger {}

• GMSNavigationRoutingStrategy

  The routing strategy specifies how routes are ranked, which affects the route when it is chosen and during re-routing. The default value is GMSNavigationRoutingStrategyDefaultBest.

  Declaration

  Swift

  enum GMSNavigationRoutingStrategy : Int, @unchecked Sendable

  Objective-C

  enum GMSNavigationRoutingStrategy : NSInteger {}

• GMSNavigationRouteCalloutFormat

  The format specifies whether to show distance or ETA information in route callouts.

  Declaration

  Swift

  enum GMSNavigationRouteCalloutFormat : Int, @unchecked Sendable

  Objective-C

  enum GMSNavigationRouteCalloutFormat : NSInteger {}

• GMSNavigationAlternateRoutesStrategy

  Indicates the maximum number of alternate routes that can be requested.

  Declaration

  Swift

  enum GMSNavigationAlternateRoutesStrategy : Int, @unchecked Sendable

  Objective-C

  enum GMSNavigationAlternateRoutesStrategy : NSInteger {}

• GMSNavigationSpeedAlertSeverity

  Declaration

  Swift

  enum GMSNavigationSpeedAlertSeverity : Int, @unchecked Sendable

  Objective-C

  NS_ENUM(NSInteger, GMSNavigationSpeedAlertSeverity) {
    /** Either speed or speed limit could not be determined. */
    GMSNavigationSpeedAlertSeverityUnknown = -2,
  
    /** No speeding is occurring. */
    GMSNavigationSpeedAlertSeverityNotSpeeding = -1,
  
    /** Minor speed alert. */
    GMSNavigationSpeedAlertSeverityMinor = 0,
  
    /** Major speed alert. */
    GMSNavigationSpeedAlertSeverityMajor,
  }

• GMSNavigationNavState

  The state of navigation.

  Declaration

  Swift

  enum GMSNavigationNavState : Int, @unchecked Sendable

  Objective-C

  enum GMSNavigationNavState : NSInteger {}

• GMSNavigationDrivingSide

  Whether this step is on a drive-on-right or drive-on-left route. May be unspecified.

  Declaration

  Swift

  enum GMSNavigationDrivingSide : UInt, @unchecked Sendable

  Objective-C

  enum GMSNavigationDrivingSide : NSUInteger {}

• GMSNavigationManeuver

  A set of values that specify the navigation action to take.

  Declaration

  Swift

  enum GMSNavigationManeuver : UInt, @unchecked Sendable

  Objective-C

  enum GMSNavigationManeuver : NSUInteger {}

• GMSNavigationLaneShape

  A set of values describing the shape of a lane.

  Declaration

  Swift

  enum GMSNavigationLaneShape : Int, @unchecked Sendable

  Objective-C

  enum GMSNavigationLaneShape : NSInteger {}

• GMSCollisionBehavior

  How markers interact with other markers and regular labels. Defaults to GMSCollisionBehaviorRequired.

  Marker collisions occur when coordinates intersect.

  Priority is defined as: 1) Required > Optional 2) zIndex: higher zIndex > lower zIndex

  Beyond this, it is undefined which marker will show if both are optional and have the same zIndex. Regular map labels are the lowest priority.

  Declaration

  Swift

  enum GMSCollisionBehavior : Int, @unchecked Sendable

  Objective-C

  enum GMSCollisionBehavior : NSInteger {}

• GMSGeocoderErrorCode

  GMSGeocoder error codes, embedded in NSError.

  Declaration

  Swift

  enum GMSGeocoderErrorCode : Int, @unchecked Sendable

  Objective-C

  enum GMSGeocoderErrorCode : NSInteger {}

• GMSMapCapabilityFlags

  Flags that represent conditionally-available map capabilities (ones that require a mapID or some other map setting) that can be used to indicate availability.

  Declaration

  Swift

  struct GMSMapCapabilityFlags : OptionSet, @unchecked Sendable

  Objective-C

  enum GMSMapCapabilityFlags : NSUInteger {}

• GMSMapViewType

  Display types for GMSMapView.

  Declaration

  Swift

  enum GMSMapViewType : UInt, @unchecked Sendable

  Objective-C

  enum GMSMapViewType : NSUInteger {}

• GMSFrameRate

  Rendering frame rates for GMSMapView.

  Declaration

  Swift

  enum GMSFrameRate : UInt, @unchecked Sendable

  Objective-C

  enum GMSFrameRate : NSUInteger {}

• GMSMapViewPaddingAdjustmentBehavior

  Constants indicating how safe area insets are added to padding.

  Declaration

  Swift

  enum GMSMapViewPaddingAdjustmentBehavior : UInt, @unchecked Sendable

  Objective-C

  enum GMSMapViewPaddingAdjustmentBehavior : NSUInteger {}

• GMSMarkerAnimation

  Animation types for GMSMarker.

  Declaration

  Swift

  enum GMSMarkerAnimation : UInt, @unchecked Sendable

  Objective-C

  enum GMSMarkerAnimation : NSUInteger {}

• GMSPanoramaSource

  Source types for Panoramas. Used to specify the source of a StreetView Panorama.

  This API is experimental. Results may not always match expectations.

  Declaration

  Swift

  enum GMSPanoramaSource : UInt, @unchecked Sendable

  Objective-C

  enum GMSPanoramaSource : NSUInteger {}

• GMSLengthKind

  GMSLengthKind indicates the type of a length value, which can be geodesic (in meters), rhumb length (in meters) and projected length (in GMSMapPoint units).

  Declaration

  Swift

  enum GMSLengthKind : UInt, @unchecked Sendable

  Objective-C

  enum GMSLengthKind : NSUInteger {}