Inherits from NSObject
Declared in SKTNavigationConfiguration.h

Overview

Provides customization options for navigation and free drive.

Tasks

  •   destination

    Target navigation coordinate. Default is (0, 0).

    property
  •   routeInfo

    Pre calculated route to be used for navigation. If this property is not nil, the navigation will be made on this route.

    property
  •   routeType

    Desired route type. Default is SKRouteCarEfficient.

    property
  •   numberOfRoutes

    Number of routes to calculate. Not all routes will not be shown if they are too similar. Default is 3.

    property
  •   distanceFormat

    Desired distance format.

    property
  •   speedLimitWarningThresholdInCity

    Desired speed difference at which to play audio warning for speed limit while inside a city. The measurement unit is given by the distanceFormat. For SKDistanceFormatMetric this is considered km/h, for SKDistanceFormatMilesFeet and SKDistanceFormatMilesYards is mph. Default is 20.

    property
  •   speedWarningThresholdOutsideCity

    Desired speed difference at which to play audio warning for speed limit while outside a city. The measurement unit is given by the distanceFormat. For SKDistanceFormatMetric this is considered km/h, for SKDistanceFormatMilesFeet and SKDistanceFormatMilesYards is mph. Default is 20.

    property
  •   allowBackgroundNavigation

    Allow or forbid audio playback and location updates while the app is in background. Default is YES.

    property
  •   showStreetNamesAsPopUps

    Enables rendering of street names as pop-ups instead of flat strings on the ground. Default is YES.

    property
  •   automaticDayNight

    Enables automatic style switching according to time of day. Default is YES.

    property
  •   dayStyle

    Desired style to use during the day. Only used when automaticDayNight is enabled. Default is daystyle.json.

    property
  •   nightStyle

    Desired style to use during the night. Only used when automaticDayNight is enabled. Default is nightstyle.json.

    property
  •   advisorLanguage

    Desired language of audio advices. Default is en_us.

    property
  •   playAudioDuringCall

    Enables audio playback during calls. Default is YES.

    property
  •   preventStandBy

    Prevents the device to go into standby after a long period of user inactivity. Default is YES.

    property
  •   avoidTollRoads

    Avoid routes containing toll roads. Default is NO.

    property
  •   avoidHighways

    Avoid routes containing highways. Default is NO.

    property
  •   avoidFerries

    Avoid routes containing ferries. Default is NO.

    property
  •   continueFreeDriveAfterNavigationEnd

    If this property is YES, free drive will be automatically started after reaching the destination. Default is YES.

    property
  •   navigationType

    Desired navigation type. Useful for debugging. Default is SKTNavigationTypeReal.

    property
  •   simulationLogPath

    Replays the path stored in the given log when navigationType is SKTNavigationTypeSimulationFromLogFile.

    property
  •   startCoordinate

    Desired start coordinate. Used when navigationType is SKTNavigationTypeSimulation. Default is current location.

    property
  • + defaultConfiguration

    Returns an instance of SKTNavigationConfiguration with default values.

  • – duplicate

    Returns a copy of the configuration.

Properties

advisorLanguage

Desired language of audio advices. Default is en_us.

@property (nonatomic, strong) NSString *advisorLanguage

Discussion

Desired language of audio advices. Default is en_us.

Declared In

SKTNavigationConfiguration.h

allowBackgroundNavigation

Allow or forbid audio playback and location updates while the app is in background. Default is YES.

@property (nonatomic, assign) BOOL allowBackgroundNavigation

Discussion

Allow or forbid audio playback and location updates while the app is in background. Default is YES.

Declared In

SKTNavigationConfiguration.h

automaticDayNight

Enables automatic style switching according to time of day. Default is YES.

@property (nonatomic, assign) BOOL automaticDayNight

Discussion

Enables automatic style switching according to time of day. Default is YES.

Declared In

SKTNavigationConfiguration.h

avoidFerries

Avoid routes containing ferries. Default is NO.

@property (nonatomic, assign) BOOL avoidFerries

Discussion

Avoid routes containing ferries. Default is NO.

Declared In

SKTNavigationConfiguration.h

avoidHighways

Avoid routes containing highways. Default is NO.

@property (nonatomic, assign) BOOL avoidHighways

Discussion

Avoid routes containing highways. Default is NO.

Declared In

SKTNavigationConfiguration.h

avoidTollRoads

Avoid routes containing toll roads. Default is NO.

@property (nonatomic, assign) BOOL avoidTollRoads

Discussion

Avoid routes containing toll roads. Default is NO.

Declared In

SKTNavigationConfiguration.h

continueFreeDriveAfterNavigationEnd

If this property is YES, free drive will be automatically started after reaching the destination. Default is YES.

@property (nonatomic, assign) BOOL continueFreeDriveAfterNavigationEnd

Discussion

If this property is YES, free drive will be automatically started after reaching the destination. Default is YES.

Declared In

SKTNavigationConfiguration.h

dayStyle

Desired style to use during the day. Only used when automaticDayNight is enabled. Default is daystyle.json.

@property (nonatomic, strong) SKMapViewStyle *dayStyle

Discussion

Desired style to use during the day. Only used when automaticDayNight is enabled. Default is daystyle.json.

Declared In

SKTNavigationConfiguration.h

destination

Target navigation coordinate. Default is (0, 0).

@property (nonatomic, assign) CLLocationCoordinate2D destination

Discussion

Target navigation coordinate. Default is (0, 0).

Declared In

SKTNavigationConfiguration.h

distanceFormat

Desired distance format.

@property (nonatomic, assign) SKDistanceFormat distanceFormat

Discussion

Desired distance format.

Declared In

SKTNavigationConfiguration.h

navigationType

Desired navigation type. Useful for debugging. Default is SKTNavigationTypeReal.

@property (nonatomic, assign) SKNavigationType navigationType

Discussion

Desired navigation type. Useful for debugging. Default is SKTNavigationTypeReal.

Declared In

SKTNavigationConfiguration.h

nightStyle

Desired style to use during the night. Only used when automaticDayNight is enabled. Default is nightstyle.json.

@property (nonatomic, strong) SKMapViewStyle *nightStyle

Discussion

Desired style to use during the night. Only used when automaticDayNight is enabled. Default is nightstyle.json.

Declared In

SKTNavigationConfiguration.h

numberOfRoutes

Number of routes to calculate. Not all routes will not be shown if they are too similar. Default is 3.

@property (nonatomic, assign) NSUInteger numberOfRoutes

Discussion

Number of routes to calculate. Not all routes will not be shown if they are too similar. Default is 3.

Declared In

SKTNavigationConfiguration.h

playAudioDuringCall

Enables audio playback during calls. Default is YES.

@property (nonatomic, assign) BOOL playAudioDuringCall

Discussion

Enables audio playback during calls. Default is YES.

Declared In

SKTNavigationConfiguration.h

preventStandBy

Prevents the device to go into standby after a long period of user inactivity. Default is YES.

@property (nonatomic, assign) BOOL preventStandBy

Discussion

Prevents the device to go into standby after a long period of user inactivity. Default is YES.

Declared In

SKTNavigationConfiguration.h

routeInfo

Pre calculated route to be used for navigation. If this property is not nil, the navigation will be made on this route.

@property (nonatomic, strong) SKRouteInformation *routeInfo

Discussion

Pre calculated route to be used for navigation. If this property is not nil, the navigation will be made on this route.

Declared In

SKTNavigationConfiguration.h

routeType

Desired route type. Default is SKRouteCarEfficient.

@property (nonatomic, assign) SKRouteMode routeType

Discussion

Desired route type. Default is SKRouteCarEfficient.

Declared In

SKTNavigationConfiguration.h

showStreetNamesAsPopUps

Enables rendering of street names as pop-ups instead of flat strings on the ground. Default is YES.

@property (nonatomic, assign) BOOL showStreetNamesAsPopUps

Discussion

Enables rendering of street names as pop-ups instead of flat strings on the ground. Default is YES.

Declared In

SKTNavigationConfiguration.h

simulationLogPath

Replays the path stored in the given log when navigationType is SKTNavigationTypeSimulationFromLogFile.

@property (nonatomic, strong) NSString *simulationLogPath

Discussion

Replays the path stored in the given log when navigationType is SKTNavigationTypeSimulationFromLogFile.

Declared In

SKTNavigationConfiguration.h

speedLimitWarningThresholdInCity

Desired speed difference at which to play audio warning for speed limit while inside a city. The measurement unit is given by the distanceFormat. For SKDistanceFormatMetric this is considered km/h, for SKDistanceFormatMilesFeet and SKDistanceFormatMilesYards is mph. Default is 20.

@property (nonatomic, assign) double speedLimitWarningThresholdInCity

Discussion

Desired speed difference at which to play audio warning for speed limit while inside a city. The measurement unit is given by the distanceFormat. For SKDistanceFormatMetric this is considered km/h, for SKDistanceFormatMilesFeet and SKDistanceFormatMilesYards is mph. Default is 20.

Declared In

SKTNavigationConfiguration.h

speedWarningThresholdOutsideCity

Desired speed difference at which to play audio warning for speed limit while outside a city. The measurement unit is given by the distanceFormat. For SKDistanceFormatMetric this is considered km/h, for SKDistanceFormatMilesFeet and SKDistanceFormatMilesYards is mph. Default is 20.

@property (nonatomic, assign) double speedWarningThresholdOutsideCity

Discussion

Desired speed difference at which to play audio warning for speed limit while outside a city. The measurement unit is given by the distanceFormat. For SKDistanceFormatMetric this is considered km/h, for SKDistanceFormatMilesFeet and SKDistanceFormatMilesYards is mph. Default is 20.

Declared In

SKTNavigationConfiguration.h

startCoordinate

Desired start coordinate. Used when navigationType is SKTNavigationTypeSimulation. Default is current location.

@property (nonatomic, assign) CLLocationCoordinate2D startCoordinate

Discussion

Desired start coordinate. Used when navigationType is SKTNavigationTypeSimulation. Default is current location.

Declared In

SKTNavigationConfiguration.h

Class Methods

defaultConfiguration

Returns an instance of SKTNavigationConfiguration with default values.

+ (instancetype)defaultConfiguration

Discussion

Returns an instance of SKTNavigationConfiguration with default values.

Declared In

SKTNavigationConfiguration.h

Instance Methods

duplicate

Returns a copy of the configuration.

- (instancetype)duplicate

Discussion

Returns a copy of the configuration.

Declared In

SKTNavigationConfiguration.h