core library

Core Library

Provides foundational types, utilities, and interfaces for the GEM SDK, including coordinates, error handling, settings, and core data structures.

This library covers the essential building blocks for working with the SDK, such as coordinates, addresses, alarms, categories, images, language, and error management.

Main features

More details

Classes

AbstractGeometry Images
Structured representation of a junction or turn geometry.
AbstractGeometryImageRenderSettings Images
Rendering settings for turn instruction images in navigation instructions.
AbstractGeometryImg Images
Vector turn arrow image for navigation instructions.
AbstractGeometryItem Images
Geometry element used by AbstractGeometry.
ActivationInfo Activation
Represents details about a product activation stored on the device.
ActivationService Activation
Service for activating and managing product licenses for the Magic Lane SDK.
AddressInfo Landmarks
Contains structured address information for a Landmark.
AlarmListener Alarms
Receives notifications for navigation-related alarm events and environmental changes.
AlarmMonitoredArea Alarms
Represents a monitored geographic area with its identifier.
AlarmService Alarms
Provides monitoring and notification for navigation-related alarm events.
AlarmsList<T> Alarms
List of alarms referenced to geographic coordinates.
ApiErrorService Common
ApiErrorService provides details about the error related to the last operation
AutoUpdateSettings Common
Configuration for auto update
CircleGeographicArea Geographic
Circular geographic area defined by center coordinates and radius in meters.
ClimbSection Route
Climb section describing an ascending segment of the route.
ContactInfo Landmarks
Stores contact information associated with a Landmark.
ContentParameters Content
Base class for content parameters.
Coordinates Geographic
Represents a geographic position in the WGS‑84 coordinate system.
Debug Settings
Provides debugging utilities for memory monitoring, logging, and SDK configuration.
DurationID Activation
Predefined duration identifier constants (ISO 8601 period format).
EntranceLocations Landmarks
Represents the entrance points for a Landmark.
ExpiredContent Settings
Expired Content
ExternalInfo Landmarks
Wikipedia information for a Landmark.
ExternalInfoService Landmarks
Service helpers to request Wikipedia (External) information for landmarks.
ExtraInfo Landmarks
Flexible key/value storage used for landmark auxiliary metadata.
GemCameraPlayer Sensor Data Source
Widget for rendering camera feed frames from a controller.
GemCameraPlayerController Sensor Data Source
Controller for managing camera feed playback from a data source.
GemCameraPlayerValue Sensor Data Source
Immutable state container for a camera player controller.
GemKit Common
Magic Lane SDK global functions.
GemParameter Common
A single typed parameter used across the SDK.
GenericCategories Landmarks
Utilities for working with generic categories used to group landmarks and points of interest (POIs).
GeographicArea Geographic
Abstract base class for representing geographic areas on the WGS 84 ellipsoid.
ImageHandler Images
Utilities for decoding raw image bytes into Flutter ui.Image objects.
Img Images
Plain raster image with recommended size and aspect ratio.
ImgBase Images
Base class for all SDK image representations with rendering capabilities.
ISOCodeConversions Iso Code Conversions
Utility methods for converting and inspecting ISO country and language codes.
Landmark Landmarks
Represents a predefined, permanent location with rich metadata.
LandmarkAlarmsList Alarms
Alarms list referencing landmarks by geographic coordinates.
LandmarkCategory Landmarks
Represents a landmark category used to classify landmarks and POIs.
LandmarkJson Landmarks
Lightweight structure for serializing landmark information.
LandmarkPosition Landmark Store
A landmark together with its distance from a reference coordinates.
LandmarkStore Landmark Store
Provides access to a persistent collection of landmarks and categories.
LaneImageRenderSettings Images
Rendering settings for lane guidance images in navigation instructions.
LaneImg Images
Vector lane guidance image for navigation instructions.
Language Locale
Complete language specification used throughout the SDK.
LocalizationService Localization Service
Localization service to retrieve localized strings.
LocalizationStringIds Localization Service
Provides string IDs for localization in the SDK.
MountInfo Settings
Information about a storage mount point used by the application.
NetworkProvider Settings
Network access customization and notification hooks.
OffBoardListener Settings
Listener receiving offboard/content-related events from the SDK.
OTRoute Route
Over-track (OT) route representation.
OverlayItemAlarmsList Alarms
Alarms list referencing overlay items by geographic coordinates.
OverlayItemPosition Maps & 3D Scenes
A coordinate-referenced wrapper for an OverlayItem.
ParameterList Common
Searchable parameters list.
Path Geographic
Represents a path object containing an ordered list of geographic coordinates.
PathMatch Geographic
Represents a match result when performing a hit test on a MapViewPathCollection.
PersistentRoadblockListener Traffic & Roadblocks
Listener for user-defined persistent roadblock events.
PolygonGeographicArea Geographic
Polygonal geographic area defined by a sequence of coordinate vertices.
PredefinedExtraInfoKey Landmarks
Predefined keys used in the landmark ExtraInfo map.
ProductID Activation
Well-known product identifier constants used by the activation API.
ProgressListener Common
Abstract interface for tracking progress of asynchronous operations.
ProxyDetails Settings
Proxy information used for HTTPS/HTTP proxy callbacks and configuration.
PTAlert Route
Public transport alert.
PTBuyTicketInformation Route
Buy-ticket information for a public transport route.
PTRoute Route
Public transport route.
PTRouteInstruction Route
Public transport route instruction.
PTRouteSegment Route
Public transport route segment.
PTTranslation Route
Public transport translation.
RectangleGeographicArea Geographic
Rectangular geographic area aligned with latitude and longitude lines.
RenderableImg Images
Container for rendered image data with bytes and dimensions.
RoadInfo Common
Road information value object.
RoadInfoImg Images
Vector road shield image for highway and route markers.
RoadMapParameters Content
Road map ContentStoreItem details. This class provides detailed information specific to road map content.
RoadTypeSection Route
Road type section describing the classification of the road for a segment.
Route Route
A computed navigable route.
RouteBase Route
RouteBase defines the common API surface for computed routes. It exposes geometry, time/distance metrics, terrain profiles, segments, instructions, traffic and toll information, and helpers to export or sample route data.
RouteInstruction Route
A single route step inside a route segment.
RouteInstructionBase Route
A single route instruction used for route guidance.
RouteSegment Route
A single portion of a computed route between two consecutive waypoints.
RouteSegmentBase Route
A contiguous portion of a computed route between two waypoints.
RouteTerrainProfile Route
Terrain information for a calculated route.
RouteTrafficEvent Traffic & Roadblocks
Represents a traffic event affecting a computed Route.
SdkSettings Settings
SDK-level configuration and utility methods.
SdkVersion Common
SDK version container.
SearchableParameterList Common
Searchable parameters list.
SettingsService Settings
Service for storing persistent key/value application settings.
SignpostDetails Route
Signpost rendering and semantic details.
SignpostImageRenderSettings Images
Rendering settings for signpost images in navigation instructions.
SignpostImg Images
Vector signpost image for directional navigation signs.
SignpostItem Route
Element of a rendered signpost.
SizeAndFormat Images
Represents the size and file format for an image.
SoundPlayingListener Sound
Listener for events related to sound playback and text-to-speech.
SoundPlayingPreferences Sound
Preferences controlling how the SDK plays sounds and TTS.
SoundPlayingService Sound
High-level static API for playing sounds and TTS through the SDK.
SoundSessionRequestPreferences Sound
Preferences used when requesting an audio session from the platform.
SteepSection Route
Steep section indicating an abrupt elevation change category.
StyleParameters Content
Style ContentStoreItem details. This class provides detailed information specific to style content.
SurfaceSection Route
Surface section describing surface type changes along the route.
TaskHandler Common
A task handler is a reference to a task that is currently running or has been scheduled to run. It can be used to cancel the task.
TilesCollectionGeographicArea Geographic
Geographic area represented as a collection of map tiles.
TimeDistance Common
Time and distance value object used for routing results.
TimeDistanceCoordinate Route
Timestamped geographic coordinate with associated relative distance.
TimezoneResult Timezone
Result container for timezone lookup operations.
TimezoneService Timezone
Timezone service helpers.
TrafficEvent Traffic & Roadblocks
Represents a traffic event such as congestion, roadworks or closures.
TrafficParameters Traffic & Roadblocks
Provides additional, read-only parameters that describe a traffic event. Typical information includes estimated speed impact, expected delay, severity level, and a short descriptive label or reason for the event.
TrafficPreferences Traffic & Roadblocks
Traffic preferences for the SDK.
TrafficService Traffic & Roadblocks
Provides access to traffic-related services and user roadblock management.
TransferStatistics Common
Provides data transfer statistics for a specific online service.
TtsLocalizationService Localization Service
Localization service to retrieve localized strings.
TurnDetails Common
Provides navigation turn details.
UserRoadblockPathPreviewCoordinate Traffic & Roadblocks
User roadblock path preview match information.
Version Common
Compact major/minor version for content (usually roadmaps).
Voice Locale
Voice information object.
VoiceParameters Content
Voice ContentStoreItem details. This class provides detailed information specific to voice content.

Enums

ActivationStatus Activation
The various states an activation can be in on the device.
AddressField Landmarks
Address fields available on an AddressInfo.
AlertSeverity Sound
Alert severity levels used for sound-related settings.
AnchorType Images
Anchor type for an abstract geometry.
AppTheme Settings
Application theme selection used for images and text rendering.
ArrowDirection Images
Direction of the arrow drawn for a shape.
ArrowType Images
Indicates whether an arrow is present and on which side of the anchor it is attached.
AudioCategory Sound
Audio category type used when requesting an audio session.
AudioOutput Sound
Audio output type.
AudioStreamType Sound
Audio stream type used for playback.
ContactInfoFieldType Landmarks
Types of contact fields that can be stored in ContactInfo.
ContentStoreStatus Settings
The status for ContentStore data.
DriveSide Images
Drive side used to render side-dependent geometry.
EngineMisc Images
Miscellaneous engine icon identifiers.
EntranceLocationType Landmarks
Type of an entrance location.
ExternalImageQuality Landmarks
Represents the quality of an external image.
GemCameraPlayerStatus Sensor Data Source
Playback status for a camera player controller.
GemDumpSdkLevel Settings
Defines verbosity levels for crash report logs sent to Magic Lane servers.
GemError Common
Error codes.
GemIcon Images
SDK icon identifiers.
GemLoggingLevel Settings
Defines logging levels for SDK debug output to console.
GeographicAreaType Geographic
Enumeration of supported geographic area types for spatial representation.
GetWaypointsOptions Route
Options selecting which set of waypoints to return from RouteBase.getWaypoints.
Grade Route
Climb difficulty categories (UCI-based).
ImageFileFormat Images
Enumerates known image file formats.
ImageType Images
Image category used by SDK subsystems for classification.
ISOCodeType Iso Code Conversions
Represents ISO code variants used by the SDK.
MapLanguage Settings
Map language selection options.
Modifies navigation behavior for debugging and testing purposes.
NetworkType Common
Network types used when categorizing transfer statistics.
OnlineRestrictions Settings
Represents online restrictions using bitwise flags.
PathFileFormat Geographic
Supported file formats for importing and exporting Path data.
PositionQuality Sensor Data Source
Values that represent position data quality.
ProxyType Settings
Proxy type enumeration.
RealtimeStatus Route
Status of real-time information.
Reason Settings
Error reason type
RestrictionType Images
Restriction type for a geometry item.
RoadShieldType Route
Road shield classification used for route-number items.
RoadType Route
Road classification for a route section.
RouteStatus Route
Routing service status values describing route computation state.
RoutingAlgoModifiers Settings
Modifies routing algorithm behavior for debugging and testing purposes.
ScriptVariant Locale
Script variant types.
SdkCapability Settings
Enumerates the possible capabilities included in this SDK build.
SdkEvent Common
Event which can be triggered at SDK initializaiton
ServiceGroupType Settings
Service group enum, including map tiles, traffic, terrain.
ShapeForm Images
Shape form for an abstract geometry item.
ShapeType Images
Shape type describing the semantic layer of a geometry item.
SignpostConnectionInfo Route
Signpost connection information.
SignpostItemType Route
Signpost item type.
SignpostPictogramType Route
Signpost pictogram type.
SoundPlayType Sound
Specifies the type of media the sound engine is currently playing. Provides the currently active media type used by the SDK sound engine. Use SoundPlayingListener.soundPlayType to read the current value.
StepType Route
Unit used for sampling steps in time-distance coordinate generation.
SurfaceType Route
Surface material/type for a route segment.
TimeZoneStatus Timezone
Enumerates the type of response from the timezone plugin.
TrafficEventClass Traffic & Roadblocks
Traffic events classes
TrafficEventImpactZone Traffic & Roadblocks
Traffic event shape
TrafficEventSeverity Traffic & Roadblocks
Traffic event severity enum.
TrafficOnlineRestrictions Traffic & Roadblocks
Restrictions which prevent online service functionality
TrafficUsage Traffic & Roadblocks
Traffic usage type.
TransitType Route
Type of transit.
TurnEvent Common
Navigation turn events.
UnitSystem Settings
Unit system used for textual and spoken measurements.
ValueType Common
Types of parameter values supported by the SDK.
ViewOnlineServiceType Common
Online service types for which a view can expose transfer statistics.
VoiceType Locale
Enumerates available voice types for TTS and voice playback.

Exceptions / Errors

GemKitUninitializedException Common
Exception thrown when GemKit is not initialized
InvalidParameterFormat Common
Exception thrown when a parameter with a given key value does not have the expected format.
MapDisposedException Common
Exception thrown when a call is made on an object that depends on a disposed map.
ObjectNotAliveException Common
Exception thrown when an object is not alive