buildRoutePlanningOptions
fun buildRoutePlanningOptions(itinerary: Itinerary, @IntRange(from = 0, to = 2) maxAlternatives: Int = 0, routeType: RouteType = RouteType.Fast, avoids: Set<AvoidType> = emptySet(), language: Locale = Locale.ENGLISH, instructionPhoneticsType: InstructionPhoneticsType = InstructionPhoneticsType.Ipa): RoutePlanningOptions
Creates options for planning routes which are passed to one of the various route planners.
Parameters
itinerary
The list of route locations.
maxAlternatives
Maximum number of desired alternative routes. Value must be in range: 0,2.
routeType
General strategy for selecting roads during route calculation.
avoids
What kind of roads should be be avoided while calculating a route.
language
The locale of guidance instruction and road name sections. Default value is Locale.ENGLISH.
instructionPhoneticsType
The phonetics type of the guidance instructions. Default value is InstructionPhoneticsType.Ipa.
Throws
when:
maxAlternatives is set to a value outside 0, 2.
VehicleProvider.vehicle is not set to Vehicle.Car.