Mapbox Navigation SDK for iOS Docs Navigation SDK for iOS Reference (2.9.0)

View on GitHub

Install in Dash

Mapbox Navigation SDK for iOS Reference Camera Reference
  • Guides
    • Using Map Matching
    • Reduce Memory Usage
    • Styling the UI
  • Turn-by-turn UI
    • NavigationViewController
    • NavigationViewControllerDelegate
    • RouteVoiceController
    • SpeechSynthesizing
    • SpeechSynthesizingDelegate
    • MapboxSpeechSynthesizer
    • SystemSpeechSynthesizer
    • MultiplexedSpeechSynthesizer
    • SpeechError
    • SpeechFailureAction
    • NavigationOptions
    • NavigationView
  • Core Navigation Logic
    • NavigationService
    • NavigationServiceDelegate
    • MapboxNavigationService
    • – NotificationUserInfoKey
    • Router
    • RouterDataSource
    • RouteController
    • – NotificationUserInfoKey
    • RouterDelegate
    • RouteProgress
    • RouteLegProgress
    • RouteStep
    • RouteStepProgress
    • CongestionLevel
    • VisualInstruction
    • VisualInstructionDelegate
    • NavigationEventsManager
    • ActiveNavigationEventsManagerDataSource
    • PassiveNavigationEventsManagerDataSource
    • NavigationLocationManager
    • ReplayLocationManager
    • SimulatedLocationManager
    • NavigationRouteOptions
    • DirectionsOptions
    • NavigationMatchOptions
    • SimulationMode
    • SimulationIntent
    • SimulationState
    • PassiveLocationManager
    • – NotificationUserInfoKey
    • PassiveLocationManagerDelegate
  • Maps
    • NavigationMapView
    • NavigationMapViewDelegate
    • MapView
    • PassiveLocationProvider
    • NavigationLocationProvider
    • WaypointStyle
    • UserLocationStyle
  • Styling
    • Style
    • StyleManager
    • StyleManagerNotificationUserInfoKey
    • StyleManagerDelegate
    • DayStyle
    • NightStyle
  • Formatters
    • DistanceFormatter
  • UI Components
    • SpeedLimitView
    • UserPuckCourseView
    • UserHaloCourseView
    • UserCourseView
    • CourseUpdatable
    • NavigationComponent
    • FloatingButton
    • WayNameLabel
    • WayNameView
  • Guidance Instruction UI
    • TopBannerViewController
    • TopBannerViewControllerDelegate
    • InstructionsCardViewController
    • InstructionsCardContainerView
    • InstructionsCardContainerViewDelegate
    • InstructionsBannerView
    • InstructionsBannerViewDelegate
    • BaseInstructionsBannerView
    • ManeuverView
    • JunctionView
    • GenericRouteShield
    • StepsViewControllerDelegate
    • BottomBannerViewController
    • BottomBannerViewControllerDelegate
  • CarPlay
    • CarPlayManager
    • CarPlayManagerDelegate
    • CarPlayNavigationViewController
    • CarPlayNavigationViewControllerDelegate
    • CarPlayActivity
    • CarPlayCompassView
    • CarPlayMapViewController
    • CarPlayMapViewControllerDelegate
    • CarPlaySearchController
    • CarPlaySearchControllerDelegate
    • CarPlayConnectionObserver
    • RecentItem
    • NavigationGeocodedPlacemark
    • CarPlayUserInfo
  • Configuration
    • RouteControllerDeadReckoningTimeInterval
    • RouteControllerMediumAlertInterval
    • RouteControllerHighAlertInterval
    • RouteControllerManeuverZoneRadius
    • RouteSnappingMaxManipulatedCourseAngle
    • RouteControllerMaximumAllowedDegreeOffsetForTurnCompletion
    • RouteControllerMaximumDistanceBeforeRecalculating
    • RouteControllerUserLocationSnappingDistance
    • MapOrnamentPosition
    • CongestionAttribute
    • CurrentLegAttribute
    • RouteLineWidthByZoomLevel
    • NavigationMapViewMinimumDistanceForOverheadZooming
    • NavigationViewMinimumVolumeForWarning
    • GradientCongestionFadingDistance
    • RouteControllerIncorrectCourseMultiplier
    • RouteControllerLinkedInstructionBufferMultiplier
    • RouteControllerMaximumSpeedForUsingCurrentStep
    • RouteControllerMinNumberOfInCorrectCourses
    • RouteControllerMinimumBacktrackingDistanceForRerouting
    • RouteControllerMinimumDistanceForContinueInstruction
    • RouteControllerMinimumDurationRemainingForProactiveRerouting
    • RouteControllerMinimumNumberLocationUpdatesBackwards
    • RouteControllerNumberOfSecondsForRerouteFeedback
    • RouteControllerProactiveReroutingInterval
    • RouteSnappingMinimumHorizontalAccuracy
    • RouteSnappingMinimumSpeed
    • NavigationSettings
  • User Feedback
    • FeedbackViewController
    • FeedbackViewControllerDelegate
    • FeedbackItem
    • ActiveNavigationFeedbackType
    • PassiveNavigationFeedbackType
    • PassiveNavigationIncorrectVisualSubtype
    • ConfusingAudioSubtype
    • RouteQualitySubtype
    • IllegalRouteSubtype
    • RoadClosureSubtype
    • FeedbackSource
    • EndOfRouteFeedback
    • FeedbackEvent
    • FeedbackScreenshotOption
    • FeedbackType
    • PassiveNavigationRoadIssueSubtype
    • PassiveNavigationWrongTrafficSubtype
    • LooksIncorrectSubtype
  • Camera
    • NavigationCamera
    • NavigationCameraType
    • NavigationCameraState
    • CameraStateTransition
    • NavigationCameraStateTransition
    • ViewportDataSource
    • NavigationViewportDataSource
    • ViewportDataSourceType
    • ViewportDataSourceDelegate
    • FollowingCameraOptions
    • IntersectionDensity
    • BearingSmoothing
    • GeometryFramingAfterManeuver
    • PitchNearManeuver
    • OverviewCameraOptions
    • NavigationViewportDataSourceOptions
    • CameraOptions
  • Preview
    • PreviewOptions
    • PreviewViewController
    • PreviewViewControllerDelegate
    • Banner
    • BannerConfiguration
    • BannerDismissalViewController
    • BannerDismissalViewControllerDelegate
    • DestinationPreviewViewController
    • DestinationPreviewViewControllerDelegate
    • DestinationOptions
    • DestinationDataSource
    • RoutePreviewViewController
    • RoutePreviewViewControllerDelegate
    • RoutePreviewOptions
    • RoutePreviewDataSource
  • Electronic Horizon
    • ElectronicHorizonOptions
    • RoadGraph
    • – NotificationUserInfoKey
    • – Edge
    • – Path
    • – Position
    • – SubgraphEdge
    • OpenLRIdentifier
    • OpenLROrientation
    • RoadName
    • RoadObject
    • – EdgeLocation
    • – Kind
    • – Location
    • – Position
    • DistancedRoadObject
    • RoadObjectMatcher
    • RoadObjectStore
    • RoadObjectMatcherDelegate
    • RoadObjectStoreDelegate
    • RoadObjectMatcherError
    • OpenLRSideOfRoad
  • Reading History
    • HistoryReader
    • – ReadOptions
    • – Iterator
    • HistoryEvent
    • UnknownHistoryEvent
    • RouteAssignmentHistoryEvent
    • LocationUpdateHistoryEvent
    • History
    • HistoryRecording
  • Other Classes
    • DispatchTimer
    • – State
    • MapboxRoutingProvider
    • – Source
    • – Request
    • PredictiveCacheManager
    • StepInstructionsView
    • StepTableViewCell
  • Other Global Variables
    • CongestionRangeHeavy
    • CongestionRangeLow
    • CongestionRangeModerate
    • CongestionRangeSevere
    • RestrictedRoadClassAttribute
  • Other Enumerations
    • AlternativeRouteError
    • ReroutingError
    • RoutesPresentationStyle
  • Other Extensions
    • Array
    • Bundle
    • CGPoint
    • CGSize
    • CLLocation
    • CPInterfaceController
    • CongestionRange
    • Dictionary
    • Directions
    • Locale
    • MapboxNavigationNative.RoadObjectMatcherError
    • MapboxStreetsRoadClass
    • Measurement
    • NSAttributedString
    • – Key
    • Notification
    • – Name
    • ResourceOptionsManager
    • RouteLeg
    • String
    • StyleURI
    • TileStore
    • TilesetDescriptorFactory
    • UIApplication
    • – State
    • UIDevice
    • UIEdgeInsets
    • UIFont
    • UIWindow
    • URLSessionDataTask
  • Other Protocols
    • BimodalCache
    • BimodalDataCache
    • BimodalImageCache
    • NavigationMapInteractionObserver
    • NavigationProviderRequest
    • NavigationStatusPresenter
    • RouteVoiceControllerDelegate
    • RoutingProvider
    • UnimplementedLogging
  • Other Structures
    • AlternativeRoute
    • – RouteInfo
    • AlternativeRouteDetectionStrategy
    • – RefreshOnEmpty
    • BorderCrossing
    • IncidentsOptions
    • IndexedRouteResponse
    • MapMatchingResult
    • PredictiveCacheLocationOptions
    • PredictiveCacheMapsOptions
    • PredictiveCacheNavigationOptions
    • PredictiveCacheOptions
    • RouteAlert
    • StatusUpdatingSettings
    • TileStoreConfiguration
    • – Location
    • Tunnel
  • Other Type Aliases
    • AdvanceLegCompletionHandler
    • CongestionRange
    • ContainerViewController
    • RoutingProviderSource

Camera

  • NavigationCamera

    NavigationCamera class provides functionality, which allows to manage camera related states and transitions in a typical navigation scenarios. It’s fed with CameraOptions via the ViewportDataSource protocol and executes transitions using CameraStateTransition protocol.

    See more

    Declaration

    Swift

    public class NavigationCamera : NSObject, ViewportDataSourceDelegate
    View Source on GitHub
  • NavigationCameraType

    Possible types of NavigationCamera.

    See more

    Declaration

    Swift

    public enum NavigationCameraType
    View Source on GitHub
  • NavigationCameraState

    Possible states which NavigationCamera can have.

    See more

    Declaration

    Swift

    public enum NavigationCameraState
    View Source on GitHub
  • CameraStateTransition

    Protocol, which is used to execute camera related transitions, based on data provided via CameraOptions in ViewportDataSource.

    By default Navigation SDK for iOS provides default implementation of CameraStateTransition in NavigationCameraStateTransition.

    See more

    Declaration

    Swift

    public protocol CameraStateTransition : AnyObject
    View Source on GitHub
  • NavigationCameraStateTransition

    Class, which conforms to CameraStateTransition protocol and provides default implementation of camera related transitions by using CameraAnimator functionality provided by Mapbox Maps SDK.

    See more

    Declaration

    Swift

    public class NavigationCameraStateTransition : CameraStateTransition
    View Source on GitHub
  • ViewportDataSource

    Protocol, which is used to fill and store CameraOptions which will be used by NavigationCamera for execution of transitions and continuous updates.

    By default Navigation SDK for iOS provides default implementation of ViewportDataSource in NavigationViewportDataSource.

    See more

    Declaration

    Swift

    public protocol ViewportDataSource : AnyObject
    View Source on GitHub
  • NavigationViewportDataSource

    Class, which conforms to ViewportDataSource protocol and provides default implementation of it.

    See more

    Declaration

    Swift

    public class NavigationViewportDataSource : ViewportDataSource
    extension NavigationViewportDataSource: LocationConsumer
    View Source on GitHub
  • ViewportDataSourceType

    Possible types of location related updates NavigationViewportDataSource can track. ViewportDataSourceType can also be used in custom implementations of classes, which conform to ViewportDataSource.

    See more

    Declaration

    Swift

    public enum ViewportDataSourceType
    View Source on GitHub
  • ViewportDataSourceDelegate

    Delegate, which is used to notify NavigationCamera regarding upcoming CameraOptions related changes.

    See more

    Declaration

    Swift

    public protocol ViewportDataSourceDelegate : AnyObject
    View Source on GitHub
  • FollowingCameraOptions

    Options, which are used to control what CameraOptions parameters will be modified by NavigationViewportDataSource in NavigationCameraState.following state.

    See more

    Declaration

    Swift

    public struct FollowingCameraOptions : Equatable
    View Source on GitHub
  • IntersectionDensity

    Options, which allow to modify the framed route geometries based on the intersection density.

    By default the whole remainder of the step is framed, while IntersectionDensity options shrink that geometry to increase the zoom level.

    See more

    Declaration

    Swift

    public struct IntersectionDensity : Equatable
    View Source on GitHub
  • BearingSmoothing

    Options, which allow to modify CameraOptions.bearing property based on information about bearing of an upcoming maneuver.

    See more

    Declaration

    Swift

    public struct BearingSmoothing : Equatable
    View Source on GitHub
  • GeometryFramingAfterManeuver

    Options, which allow to modify framed route geometries by appending additional coordinates after maneuver to extend the view.

    See more

    Declaration

    Swift

    public struct GeometryFramingAfterManeuver : Equatable
    View Source on GitHub
  • PitchNearManeuver

    Options, which allow to modify the framed route geometries when approaching a maneuver.

    See more

    Declaration

    Swift

    public struct PitchNearManeuver : Equatable
    View Source on GitHub
  • OverviewCameraOptions

    Options, which are used to control what CameraOptions parameters will be modified by NavigationViewportDataSource in NavigationCameraState.overview state.

    See more

    Declaration

    Swift

    public struct OverviewCameraOptions : Equatable
    View Source on GitHub
  • NavigationViewportDataSourceOptions

    Options, which give the ability to control whether certain CameraOptions will be generated by NavigationViewportDataSource or can be provided by user directly.

    See more

    Declaration

    Swift

    public struct NavigationViewportDataSourceOptions : Equatable
    View Source on GitHub
  • CameraOptions
    See more

    Declaration

    Swift

    extension CameraOptions

© 2014–2022 Mapbox. See license for more details.

Generated by jazzy ♪♫ v0.14.2, a Realm project.