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
- AddressInfo, ContactInfo – Structures for address and contact details of Landmarks.
- AlarmService, AlarmListener, AlarmsList – Alarm and event management for routes and navigation.
- AutoUpdateSettings – Configuration for automatic content updates.
- Coordinates – Represents geographic coordinates and related calculations.
- Debug – Debugging utilities for development and troubleshooting.
- GemError – Errors returned from SDK operations.
- ExternalInfo – Wikipedia references and metadata for landmarks.
- GemCameraPlayer – Interface for controlling GEM camera playback.
- GemKit – Main SDK initialization and core API access point.
- GenericCategories – Predefined categories for landmarks and POIs.
- GeographicArea – Represents defined geographic regions or areas.
- ImageHandler,
GemImage– Image loading, management, and identification utilities. - ISOCodeConversions – Utilities for ISO country and language code conversions.
- Landmark, LandmarkCategory – Landmark entity and associated categories. The Landmark is the main entity representing a point of interest. Can be used in search, routing and navigation. Map POIs are provided as landmarks. The user can also create custom landmarks and manage them through LandmarkStores
- Language – Language and localization utilities.
- MapViewRoutesCollection – Collection of routes for map display.
- OffBoardListener – Listener for offboard service events.
- Parameter – Key-value pairs for extra data associated with landmarks.
- Path – Representation of a path or polyline geometry.
- PersistentRoadblockListener – Listener for roadblock events affecting navigation.
- PositionQuality – Describes the quality of positional data (e.g., GPS accuracy).
- Route – Represents a route and its properties.
- SdkSettings – SDK configuration.
- SettingsService –
.inifile–style settings storage and retrieval. - SignpostDetails – Information about road signs on a route.
- SoundPlayingListener, SoundPlayingService – Audio playback control and event handling.
- TaskHandler – Manages asynchronous operations.
- RouteTerrainProfile – Elevation and terrain data along a route.
- TimeDistanceCoordinate – Coordinates with associated time and distance data.
- TimezoneService – Time zone information and conversion utilities.
- TrafficEvent, RouteTrafficEvent – Traffic data and events.
- TransferStatistics – Data transfer and usage statistics for various services.
- TurnDetails – Information about individual navigation turns.
- LandmarkStore – Persistent storage and retrieval of landmark data. Used for multiple usecases, such as within alarms or search on custom landmarks.
More details
- See the Magic Lane SDK for Flutter Documentation for more information.
Classes
- AbstractGeometry
- Structured representation of a junction or turn geometry.
- AbstractGeometryImageRenderSettings Core
- Rendering settings for turn instruction images in navigation instructions.
- AbstractGeometryImg Maps & 3D Scenes
- Vector turn arrow image for navigation instructions.
- AbstractGeometryItem
- Geometry element used by AbstractGeometry.
- AddressInfo Places
- Contains structured address information for a Landmark.
- AlarmListener
- Receives notifications for navigation-related alarm events and environmental changes.
- AlarmMonitoredArea
- Represents a monitored geographic area with its identifier.
- AlarmService
- Provides monitoring and notification for navigation-related alarm events.
-
AlarmsList<
T> - List of alarms referenced to geographic coordinates.
- ApiErrorService
- ApiErrorService provides details about the error related to the last operation
- AutoUpdateSettings Core
- Configuration for auto update
- CircleGeographicArea Core
- Circular geographic area defined by center coordinates and radius in meters.
- ClimbSection
- Climb section describing an ascending segment of the route.
- ContactInfo Places
- Stores contact information associated with a Landmark.
- ContentParameters Core
- Base class for content parameters.
- Coordinates Core
- Represents a geographic position in the WGS‑84 coordinate system.
- Debug Core
- Provides debugging utilities for memory monitoring, logging, and SDK configuration.
- EntranceLocations Places
- Represents the entrance points for a Landmark.
- ExpiredContent Core
- Expired Content
- ExternalInfo Places
- Wikipedia information for a Landmark.
- ExternalInfoService Places
- Service helpers to request Wikipedia (External) information for landmarks.
- ExtraInfo Places
- 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 Core
- Magic Lane SDK global functions.
- GemParameter Core
- A single typed parameter used across the SDK.
- GenericCategories Core
- Utilities for working with generic categories used to group landmarks and points of interest (POIs).
- GeographicArea Core
- Abstract base class for representing geographic areas on the WGS 84 ellipsoid.
- ImageHandler Core
-
Utilities for decoding raw image bytes into Flutter
ui.Imageobjects. - Img Maps & 3D Scenes
- Plain raster image with recommended size and aspect ratio.
- ImgBase Core
- Base class for all SDK image representations with rendering capabilities.
- ISOCodeConversions Core
- Utility methods for converting and inspecting ISO country and language codes.
- Landmark Places
- Represents a predefined, permanent location with rich metadata.
- LandmarkAlarmsList
- Alarms list referencing landmarks by geographic coordinates.
- LandmarkCategory Places
- Represents a landmark category used to classify landmarks and POIs.
- LandmarkJson Places
- 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 Core
- Rendering settings for lane guidance images in navigation instructions.
- LaneImg Maps & 3D Scenes
- Vector lane guidance image for navigation instructions.
- Language Core
- Complete language specification used throughout the SDK.
- LocalizationService Core
- Localization service to retrieve localized strings.
- LocalizationStringIds Core
- Provides string IDs for localization in the SDK.
- MapViewRoute Maps & 3D Scenes
- Wrapper representing the Route, RenderSettings and label as displayed on the map view.
- MapViewRoutesCollection Maps & 3D Scenes
- Collection managing routes displayed on a map view.
- MountInfo Core
- Information about a storage mount point used by the application.
- NetworkProvider Core
- Network access customization and notification hooks.
- OffBoardListener Core
- Listener receiving offboard/content-related events from the SDK.
- OTRoute
- Over-track (OT) route representation.
- OverlayItemAlarmsList
- Alarms list referencing overlay items by geographic coordinates.
- OverlayItemParameters Core
- Base parameters for an overlay item.
- ParameterList Core
- Searchable parameters list.
- Path Core
- Represents a path object containing an ordered list of geographic coordinates.
- PathMatch Core
-
Represents a match result when performing a hit test on a
MapViewPathCollection. - PersistentRoadblockListener
- Listener for user-defined persistent roadblock events.
- Point3d Core
- 3D point value object.
- Point4d Core
- 4D point / quaternion-like value object.
- PolygonGeographicArea Core
- Polygonal geographic area defined by a sequence of coordinate vertices.
- PositionOrientation Core
- Position and orientation pair used by spatial APIs.
- PredefinedExtraInfoKey Landmark Store
- Predefined keys used in the landmark ExtraInfo map.
- ProgressListener Core
- Abstract interface for tracking progress of asynchronous operations.
- ProxyDetails Core
- Proxy information used for HTTPS/HTTP proxy callbacks and configuration.
- PTAlert
- Public transport alert.
- PTBuyTicketInformation
- Buy-ticket information for a public transport route.
- PTRoute
- Public transport route.
- PTRouteInstruction
- Public transport route instruction.
- PTRouteSegment
- Public transport route segment.
- PTTranslation
- Public transport translation.
- PublicTransportParameters Core
- Parameters for public-transport overlay items.
- RectangleGeographicArea Core
- Rectangular geographic area aligned with latitude and longitude lines.
- RenderableImg Core
- Container for rendered image data with bytes and dimensions.
- RoadInfo
- Road information value object.
- RoadInfoImg Maps & 3D Scenes
- Vector road shield image for highway and route markers.
- RoadMapParameters Core
- Road map ContentStoreItem details. This class provides detailed information specific to road map content.
- RoadTypeSection
- Road type section describing the classification of the road for a segment.
- Route
- A computed navigable route.
- RouteBase
- 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
- A single route step inside a route segment.
- RouteInstructionBase
- A single route instruction used for route guidance.
- RouteRenderSettings Maps & 3D Scenes
- Additional rendering settings used to customize how routes are displayed on the map.
- RouteSegment
- A single portion of a computed route between two consecutive waypoints.
- RouteSegmentBase
- A contiguous portion of a computed route between two waypoints.
- RouteTerrainProfile
- Terrain information for a calculated route.
- RouteTrafficEvent
- Represents a traffic event affecting a computed Route.
- SafetyParameters Core
- Parameters for safety-related overlay items.
- SdkSettings Core
- SDK-level configuration and utility methods.
- SdkVersion Core
- SDK version container.
- SearchableParameterList Core
- Searchable parameters list.
- SettingsService Core
- Service for storing persistent key/value application settings.
- SignpostDetails Core
- Signpost rendering and semantic details.
- SignpostImageRenderSettings Core
- Rendering settings for signpost images in navigation instructions.
- SignpostImg Maps & 3D Scenes
- Vector signpost image for directional navigation signs.
- SignpostItem Core
- Element of a rendered signpost.
- SizeAndFormat Core
- Represents the size and file format for an image.
- SocialReportParameters Core
- Parameters for a social-report overlay item.
- SoundPlayingListener Core
- Listener for events related to sound playback and text-to-speech.
- SoundPlayingPreferences Core
- Preferences controlling how the SDK plays sounds and TTS.
- SoundPlayingService Core
- High-level static API for playing sounds and TTS through the SDK.
- SoundSessionRequestPreferences Core
- Preferences used when requesting an audio session from the platform.
- SteepSection
- Steep section indicating an abrupt elevation change category.
- StyleParameters Core
- Style ContentStoreItem details. This class provides detailed information specific to style content.
- SurfaceSection
- Surface section describing surface type changes along the route.
- TaskHandler Core
- 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 Core
- Geographic area represented as a collection of map tiles.
- TimeDistance Core
- Time and distance value object used for routing results.
- TimeDistanceCoordinate Core
- Timestamped geographic coordinate with associated relative distance.
- TimezoneResult Core
- Result container for timezone lookup operations.
- TimezoneService Core
- Timezone service helpers.
- TrafficEvent
- Represents a traffic event such as congestion, roadworks or closures.
- TrafficParameters
- 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 preferences for the SDK.
- TrafficService
- Provides access to traffic-related services and user roadblock management.
- TransferStatistics Core
- Provides data transfer statistics for a specific online service.
- TtsLocalizationService Core
- Localization service to retrieve localized strings.
- TurnDetails
- Provides navigation turn details.
- UserRoadblockPathPreviewCoordinate
- User roadblock path preview match information.
- Version Core
- Compact major/minor version for content (usually roadmaps).
- Voice Core
- Voice information object.
- VoiceParameters Core
- Voice ContentStoreItem details. This class provides detailed information specific to voice content.
Enums
- AddressField Places
- Address fields available on an AddressInfo.
- AlertSeverity Core
- Alert severity levels used for sound-related settings.
- AnchorType
- Anchor type for an abstract geometry.
- AppTheme Core
- Application theme selection used for images and text rendering.
- ArrowDirection
- Direction of the arrow drawn for a shape.
- ArrowType
- Indicates whether an arrow is present and on which side of the anchor it is attached.
- AudioCategory Core
- Audio category type used when requesting an audio session.
- AudioOutput Core
- Audio output type.
- AudioStreamType Core
- Audio stream type used for playback.
- ContactInfoFieldType Places
- Types of contact fields that can be stored in ContactInfo.
- ContentStoreStatus Core
- The status for ContentStore data.
- DriveSide
- Drive side used to render side-dependent geometry.
- EngineMisc Core
- Miscellaneous engine icon identifiers.
- EntranceLocationType Places
- Type of an entrance location.
- ExternalImageQuality Places
- Represents the quality of an external image.
- GemCameraPlayerStatus Sensor Data Source
- Playback status for a camera player controller.
- GemDumpSdkLevel Core
- Defines verbosity levels for crash report logs sent to Magic Lane servers.
- GemError Core
- Error codes.
- GemIcon Core
- SDK icon identifiers.
- GemLoggingLevel Core
- Defines logging levels for SDK debug output to console.
- GeographicAreaType Core
- Enumeration of supported geographic area types for spatial representation.
- GetWaypointsOptions
- Options selecting which set of waypoints to return from RouteBase.getWaypoints.
- Grade
- Climb difficulty categories (UCI-based).
- ImageFileFormat Core
- Enumerates known image file formats.
- ImageType Maps & 3D Scenes
- Image category used by SDK subsystems for classification.
- ISOCodeType Core
- Represents ISO code variants used by the SDK.
- LandmarkFileFormat
- Supported file formats for importing landmarks.
- LandmarkStoreType Landmark Store
- Types of landmark stores available in the SDK.
- MapLanguage Core
- Map language selection options.
- Modifies navigation behavior for debugging and testing purposes.
- NetworkType Core
- Network types used when categorizing transfer statistics.
- OnlineRestrictions Core
- Represents online restrictions using bitwise flags.
- PathFileFormat Core
- Supported file formats for importing and exporting Path data.
- PositionQuality Sensor Data Source
- Values that represent position data quality.
- ProxyType Core
- Proxy type enumeration.
- RealtimeStatus
- Status of real-time information.
- Reason Core
- Error reason type
- RestrictionType
- Restriction type for a geometry item.
- RoadShieldType
- Road shield classification used for route-number items.
- RoadType
- Road classification for a route section.
- RouteStatus
- Routing service status values describing route computation state.
- RoutingAlgoModifiers
- Modifies routing algorithm behavior for debugging and testing purposes.
- ScriptVariant Core
- Script variant types.
- SdkCapability Core
- Enumerates the possible capabilities included in this SDK build.
- SdkEvent Core
- Event which can be triggered at SDK initializaiton
- ServiceGroupType Core
- Service group enum, including map tiles, traffic, terrain.
- ShapeForm
- Shape form for an abstract geometry item.
- ShapeType
- Shape type describing the semantic layer of a geometry item.
- SignpostConnectionInfo
- Signpost connection information.
- SignpostItemType
- Signpost item type.
- SignpostPictogramType
- Signpost pictogram type.
- SoundPlayType Core
- 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
- Unit used for sampling steps in time-distance coordinate generation.
- SurfaceType
- Surface material/type for a route segment.
- TimeZoneStatus Core
- Enumerates the type of response from the timezone plugin.
- TrafficEventClass
- Traffic events classes
- TrafficEventImpactZone
- Traffic event shape
- TrafficEventSeverity
- Traffic event severity enum.
- TrafficOnlineRestrictions
- Restrictions which prevent online service functionality
- TrafficUsage
- Traffic usage type.
- TransitType
- Type of transit.
- TurnEvent
- Navigation turn events.
- UnitSystem Core
- Unit system used for textual and spoken measurements.
- ValueType Core
- Types of parameter values supported by the SDK.
- ViewOnlineServiceType Core
- Online service types for which a view can expose transfer statistics.
- VoiceType Core
- Enumerates available voice types for TTS and voice playback.
Exceptions / Errors
- GemKitUninitializedException Core
- Exception thrown when GemKit is not initialized
- InvalidParameterFormat Core
- Exception thrown when a parameter with a given key value does not have the expected format.
- MapDisposedException Core
- Exception thrown when a call is made on an object that depends on a disposed map.
- ObjectNotAliveException Core
- Exception thrown when an object is not alive