Core topic

Commonly used entities

Classes

AbstractGeometryImageRenderSettings Core
Rendering settings for turn instruction images in navigation instructions.
AutoUpdateSettings Core
Configuration for auto update
CircleGeographicArea Core
Circular geographic area defined by center coordinates and radius in meters.
ContentParameters Core
Base class for content parameters.
Coordinates Core
Represents a geographic position in the WGS‑84 coordinate system.
CountryData Core
Compact country metadata including display name, ISO code and flag.
Debug Core
Provides debugging utilities for memory monitoring, logging, and SDK configuration.
ExpiredContent Core
Expired Content
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.Image objects.
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.
LaneImageRenderSettings Core
Rendering settings for lane guidance images in 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.
LogUploader Core
Uploads a recorded log file to Magic Lane servers for bug reports.
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.
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.
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.
ProgressListener Core
Abstract interface for tracking progress of asynchronous operations.
ProxyDetails Core
Proxy information used for HTTPS/HTTP proxy callbacks and configuration.
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.
RoadMapParameters Core
Road map ContentStoreItem details. This class provides detailed information specific to road map content.
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.
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.
StyleParameters Core
Style ContentStoreItem details. This class provides detailed information specific to style content.
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.
TransferStatistics Core
Provides data transfer statistics for a specific online service.
TtsLocalizationService Core
Localization service to retrieve localized strings.
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

AlertSeverity Core
Alert severity levels used for sound-related settings.
AppTheme Core
Application theme selection used for images and text rendering.
AudioCategory Core
Audio category type used when requesting an audio session.
AudioOutput Core
Audio output type.
AudioStreamType Core
Audio stream type used for playback.
ContentStoreStatus Core
The status for ContentStore data.
EngineMisc Core
Miscellaneous engine icon identifiers.
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.
GenericCategoriesId Core
Predefined generic category identifiers used to classify landmarks
GeographicAreaType Core
Enumeration of supported geographic area types for spatial representation.
ImageFileFormat Core
Enumerates known image file formats.
ISOCodeType Core
Represents ISO code variants used by the SDK.
LogUploaderState Core
State of a log upload operation.
MapLanguage Core
Map language selection options.
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.
ProxyType Core
Proxy type enumeration.
Reason Core
Error reason type
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.
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.
TimeZoneStatus Core
Enumerates the type of response from the timezone plugin.
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