Structures
The following structures are available globally.
-
Arrival check status class.
See moreImportant
This is a Public Preview API. It may be changed or removed at any time.Declaration
Swift
public struct DestinationArrivalStatus -
See more
Important
This is a Public Preview API. It may be changed or removed at any time.Declaration
Swift
public struct WaypointArrivalStatus -
ActiveRouteDatastores the active route and an optional better route proposal.See moreWarning
This is an experimental API. It may be changed or removed at any time without notice. Use of this API is strongly discouraged.Declaration
Swift
public struct ActiveRouteData
-
Navigation snapshot containing information about the state of the trip at a certain moment
See moreImportant
This is a Public Preview API. It may be changed or removed at any time.Declaration
Swift
public struct NavigationSnapshot -
Keeps state of currently followed route’s waypoints, provide methods to change this state.
Important
This is a Public Preview API. It may be changed or removed at any time.Declaration
Swift
public struct RouteWaypointsState -
RoutePlanspecifies all required parameters for a single route navigation session.See moreImportant
This is a Public Preview API. It may be changed or removed at any time.Declaration
Swift
public struct RoutePlan
-
Fine-grained announcement points, each with its own unique id, message and type.
See moreImportant
This is a Public Preview API. It may be changed or removed at any time.Declaration
Swift
public struct GuidanceAnnouncement : Equatable
-
Class enclosing parameters passed to the AnnouncementGenerator
See moreImportant
This is a Public Preview API. It may be changed or removed at any time.Declaration
Swift
public struct AnnouncementGenerationParams
-
The Guidance class describes the properties of navigation guidance.
See moreImportant
This is a Public Preview API. It may be changed or removed at any time.Declaration
Swift
public struct Guidance -
Class enclosing parameters passed to the GuidanceEngineInstance
See moreImportant
This is a Public Preview API. It may be changed or removed at any time.Declaration
Swift
public struct GuidanceParams -
Instruction indicating arrival at the destination.
See moreImportant
This is a Public Preview API. It may be changed or removed at any time.Declaration
Swift
public struct ArrivalGuidanceInstruction : GuidanceInstruction -
Instruction indicating an upcoming border crossing.
See moreImportant
This is a Public Preview API. It may be changed or removed at any time.Declaration
Swift
public struct BorderCrossingGuidanceInstruction : GuidanceInstruction -
Instruction indicating departure from the origin.
See moreImportant
This is a Public Preview API. It may be changed or removed at any time.Declaration
Swift
public struct DepartureGuidanceInstruction : GuidanceInstruction -
Instruction indicating entering a vehicle transportation service through a terminal.
See moreImportant
This is a Public Preview API. It may be changed or removed at any time.Declaration
Swift
public struct EnterAutoTransportGuidanceInstruction : GuidanceInstruction -
Instruction indicating entering a carpool lane.
See moreImportant
This is a Public Preview API. It may be changed or removed at any time.Declaration
Swift
public struct EnterCarpoolLaneGuidanceInstruction : GuidanceInstruction -
Instruction indicating exiting a vehicle transportation service through a terminal.
See moreImportant
This is a Public Preview API. It may be changed or removed at any time.Declaration
Swift
public struct ExitAutoTransportGuidanceInstruction : GuidanceInstruction -
Instruction indicating exiting a carpool lane.
See moreImportant
This is a Public Preview API. It may be changed or removed at any time.Declaration
Swift
public struct ExitCarpoolLaneGuidanceInstruction : GuidanceInstruction -
Instruction indicating exiting on a carpool lane.
See moreImportant
This is a Public Preview API. It may be changed or removed at any time.Declaration
Swift
public struct ExitHighwayGuidanceInstruction : GuidanceInstruction -
Instruction indicating exit from a roundabout.
See moreImportant
This is a Public Preview API. It may be changed or removed at any time.Declaration
Swift
public struct ExitRoundaboutGuidanceInstruction : GuidanceInstruction -
Instruction indicating following a vehicle current route.
See moreImportant
This is a Public Preview API. It may be changed or removed at any time.Declaration
Swift
public struct FollowGuidanceInstruction : GuidanceInstruction -
Instruction indicating a fork.
See moreImportant
This is a Public Preview API. It may be changed or removed at any time.Declaration
Swift
public struct ForkGuidanceInstruction : GuidanceInstruction -
Instruction indicating when the driver is required to turn
See moreImportant
This is a Public Preview API. It may be changed or removed at any time.Declaration
Swift
public struct MandatoryTurnGuidanceInstruction : GuidanceInstruction -
Instruction indicating a merge to another road.
See moreImportant
This is a Public Preview API. It may be changed or removed at any time.Declaration
Swift
public struct MergeGuidanceInstruction : GuidanceInstruction -
Instruction indicating a roundabout maneuver.
See moreImportant
This is a Public Preview API. It may be changed or removed at any time.Declaration
Swift
public struct RoundaboutGuidanceInstruction : GuidanceInstruction -
Instruction indicating changing highways by following an exit ramp.
See moreImportant
This is a Public Preview API. It may be changed or removed at any time.Declaration
Swift
public struct SwitchHighwayGuidanceInstruction : GuidanceInstruction -
Instruction indicating the driver is approaching a tollgate or ETC terminal.
See moreImportant
This is a Public Preview API. It may be changed or removed at any time.Declaration
Swift
public struct TollgateGuidanceInstruction : GuidanceInstruction -
Instruction indicating that the driver should turn around when it is possible.
See moreImportant
This is a Public Preview API. It may be changed or removed at any time.Declaration
Swift
public struct TurnAroundWhenPossibleGuidanceInstruction : GuidanceInstruction -
Instruction indicating a turn maneuver.
See moreImportant
This is a Public Preview API. It may be changed or removed at any time.Declaration
Swift
public struct TurnGuidanceInstruction : GuidanceInstruction -
Instruction indicating arrival at a waypoint.
See moreImportant
This is a Public Preview API. It may be changed or removed at any time.Declaration
Swift
public struct WaypointGuidanceInstruction : GuidanceInstruction -
Represents guidance through all the lanes and separators on the road.
Important
This is a Public Preview API. It may be changed or removed at any time.Declaration
Swift
public struct LaneGuidance
-
Class enclosing the lane guidance event type and the current LaneGuidance instance.
Important
This is a Public Preview API. It may be changed or removed at any time.Declaration
Swift
public struct LaneGuidanceInfo -
Data needed for generation of announcement message.
Declaration
Swift
public struct AnnouncementData
-
NativeVerbalMessageGenerator conforms to VerbalMessageGenerator and generates the required verbal messages using the C++ functional enabler.
Important
This is a Public Preview API. It may be changed or removed at any time.Declaration
Swift
public struct NativeVerbalMessageGenerator : VerbalMessageGenerator -
Announcement audio message.
See moreDeclaration
Swift
public struct VerbalMessage
-
LocationContext provides information about the driver’s location, which has been matched against the road network.
See moreImportant
This is a Public Preview API. It may be changed or removed at any time.Declaration
Swift
public struct LocationContext : Equatable
-
See more
Important
This is a Public Preview API. It may be changed or removed at any time.Declaration
Swift
public struct SpeedLimit : Equatable
-
NavigationPlanspecifies all required parameters for a navigation session.See moreImportant
This is a Public Preview API. It may be changed or removed at any time.Declaration
Swift
public struct NavigationPlan -
Important
This is a Public Preview API. It may be changed or removed at any time.Declaration
Swift
public struct RoutePointProgress -
The RouteProgress class provides information about the driver’s progress along the route.
See moreDeclaration
Swift
public struct RouteProgress -
Important
This is a Public Preview API. It may be changed or removed at any time.Declaration
Swift
public struct RouteReplanParameters
-
The options used for
TomTomRouteReplanningEngineconfigurationSee moreImportant
This is a Public Preview API. It may be changed or removed at any time.Declaration
Swift
public struct RouteReplanningEngineOptions
-
Important
This is a Public Preview API. It may be changed or removed at any time.Declaration
Swift
public struct SimpleEngineCalcResult -
Has information about the city
See moreWarning
This is an experimental API. It may be changed or removed at any time without notice. Use of this API is strongly discouraged.Declaration
Swift
public struct CityElement : HorizonElement
-
Has information about the road itself
See moreWarning
This is an experimental API. It may be changed or removed at any time without notice. Use of this API is strongly discouraged.Declaration
Swift
public struct GeneralRoadElements : HorizonElement
-
Warning
This is an experimental API. It may be changed or removed at any time without notice. Use of this API is strongly discouraged.Declaration
Swift
public struct HorizonResult
-
Has information about what information is required for
HorizonEngineto deliver.See moreWarning
This is an experimental API. It may be changed or removed at any time without notice. Use of this API is strongly discouraged.Declaration
Swift
public struct HorizonOptions
-
Option parameters for searching on the main path.
Warning
This is an experimental API. It may be changed or removed at any time without notice. Use of this API is strongly discouraged.Declaration
Swift
public struct MainPathOptions
-
Option parameters for subpaths.
Warning
This is an experimental API. It may be changed or removed at any time without notice. Use of this API is strongly discouraged.Declaration
Swift
public struct SubPathOptions
-
See more
Warning
This is an experimental API. It may be changed or removed at any time without notice. Use of this API is strongly discouraged.Declaration
Swift
public struct HorizonSnapshot
-
See more
Warning
This is an experimental API. It may be changed or removed at any time without notice. Use of this API is strongly discouraged.Declaration
Swift
public struct Path : Equatable
-
See more
Warning
This is an experimental API. It may be changed or removed at any time without notice. Use of this API is strongly discouraged.Declaration
Swift
public struct HorizonPosition
-
Element with Speed limit information.
See moreWarning
This is an experimental API. It may be changed or removed at any time without notice. Use of this API is strongly discouraged.Declaration
Swift
public struct SpeedLimits : HorizonElement -
Has information about the street
See moreWarning
This is an experimental API. It may be changed or removed at any time without notice. Use of this API is strongly discouraged.Declaration
Swift
public struct StreetElement : HorizonElement
Structures Reference