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 –
.ini
file–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
- AbstractGeometry object.
- AbstractGeometryImageRenderSettings Core
- Abstract geometry image render settings.
- AbstractGeometryImg Maps & 3D Scene
- Class used for customizable turn images
- AddressInfo Places
- Address info class
- AlarmListener
- Alarm listener interface.
- AlarmMonitoredArea
- Alarm monitored area consisting of a GeographicArea and an id.
- AlarmService
- Alarm service class
-
AlarmsList<
T> - Geographic coordinates-referenced list of item alarms.
- ApiErrorService
- ApiErrorService provides details about the error related to the last operation
- AutoUpdateSettings Core
- Configuration for auto update
- CircleGeographicArea Core
- CircleGeographicArea object.
- ClimbSection
- Climb section
- ContactInfo Places
- Contact info class
- Coordinates Core
- Coordinates class
- Debug Core
- Debug object
- EntranceLocations Places
- Stores locations & access types for entrances to landmarks.
- EVRoute
- Electric vehicle route class
- EVRouteInstruction
- Electric vehicle route instruction class
- EVRouteSegment
- Electric vehicle segment class
- ExternalInfo Places
- ExternalInfo object
- ExternalInfoService Places
- Service for creating ExternalInfo objects
- ExtraInfo Places
- Extra info
- GemCameraPlayer Sensor Data Source
- A widget that renders a camera feed from a GemCameraPlayerController.
- GemCameraPlayerController Sensor Data Source
- A controller that manages playback of a camera feed from a DataSource.
- GemCameraPlayerValue Sensor Data Source
- Immutable value representing the state of a GemCameraPlayerController.
- GemKit Core
- GEM SDK global functions.
- GemParameter Core
- A parameter is a tuple ( key, value, name ).
- GenericCategories Core
- Provides access to generic categories for landmarks and POIs.
- GeographicArea Core
- Represents a geographic area on the surface of a WGS 84 Ellipsoid.
- ImageHandler Core
- Image handler class
- Img Maps & 3D Scene
- Class used for basic images
- ImgBase Core
- Base class for images
- ISOCodeConversions Core
- ISO codes conversions class. Performs language & country conversions ISO2 to ISO3 / ISO3 to ISO2.
- Landmark Places
- Landmark class. This is the core class for location information.
- LandmarkAlarmsList
- Geographic coordinates referenced list of Landmark alarms.
- LandmarkCategory Core
- Landmark category class.
- LandmarkJson
- Landmark class ideally for setting large amount of landmarks data. eg. for List of Landmarks.
- LandmarkPosition Maps & 3D Scene
- Coordinate referenced Landmark object.
- LandmarkStore Places
- Provides access to a landmark store and its operations.
- LaneImageRenderSettings Core
- Lane image render settings.
- LaneImg Maps & 3D Scene
- Class used for customizable lane images
- Language Core
- Complete language specification.
- MapViewPathCollection Core
- Collection of paths for a map view.
- MapViewRoute
- Mapview route class
- MapViewRoutesCollection
- Mapview Routes collection class
- MountInfo Core
- Information about a storage mount point used by the application.
- NetworkProvider Core
- Network access customization.
- OffBoardListener Core
- OffBoard Listener
- OTRoute
- Over track route
- OverlayItemAlarmsList
- Geographic coordinates referenced list of OverlayItem alarms.
-
Pair<
T1, T2> Core - A pair consisting of 2 objects
- ParameterList Core
- Searchable parameters list.
- Path Core
- Represents a path object.
- PathMatch
- PersistentRoadblockListener Places
- Listener for events related to persistent roadblocks.
- Point3d Core
- A point in 3d space, consisting of x, y and z coordinates.
- Point4d Core
- A point in 4d space, consisting of x, y, z and w coordinates.
- PolygonGeographicArea Core
- PolygonGeographicArea object.
- PositionOrientation Core
- The position and orientation of an object in 3D space
- PredefinedExtraInfoKey Places
- Prefefined custom landmark extra info keys
- ProgressListener Core
- Interface for implementing progress of async operations (routing, search)
- PTAlert
- Public transport alert class
- PTBuyTicketInformation
- Public transport buy ticket information class.
- PTRoute
- Public transport route class
- PTRouteInstruction
- Public transport route instruction class.
- PTRouteSegment
- Public transport route segment
- PTTranslation
- Public transport translation class
- RectangleGeographicArea Core
- RectangleGeographicArea object.
-
RectType<
T extends num> Core - A generic type consisting of x, y, width and height coordinates.
- RenderableImg Maps & 3D Scene
- Renderable image
- RoadInfo
- Road information object.
- RoadInfoImg Maps & 3D Scene
- Class used for customizable road info images
- RoadTypeSection
- Road type sections
- Route
- Route class
- RouteInstruction
- Route instruction class
- RouteInstructionBase
- Road instruction interface
- RouteRenderSettings
- A class that extends RenderSettings to provide additional rendering settings specifically for routes.
- RouteSegment Core
- Route segment class
- RouteTerrainProfile
- Route terrain profile
- RouteTrafficEvent
- Route traffic events class
- SdkSettings Core
- SDK settings class
- SdkVersion Core
- SDK version representation as four ints and a text string.
- SearchableParameterList Core
- Searchable parameters list.
- SettingsService Places
- Used to store persistent settings in a key-value pair
- SignpostDetails Core
- Signpost details class.
- SignpostImageRenderSettings Core
- Signpost image render settings.
- SignpostImg Maps & 3D Scene
- Class used for customizable signposts images
- SignpostItem Core
- SignpostItem object.
- SizeAndFormat Core
- Represents the size and format of an image
- SoundPlayingListener Core
- Listener for events related to computer/human TTS events.
- SoundPlayingService Core
- Sound service class used to play text-to-speech.
- SteepSection
- Steep sections
- SurfaceSection
- Surface sections
- 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
- TilesCollectionGeographicArea object.
- TimeDistance Core
- Time distance representation based on meters and seconds.
- TimeDistanceCoordinate Core
- Timestamp & distance & coordinates structure
- TimezoneResult Core
- Result which contains all information about a timezone.
- TimezoneService Core
- Timezone Service class
- TrafficEvent
- Traffic events class
- TrafficPreferences
- Traffic Preferences
- TrafficService
- Traffic service. Adds support to update traffic information.
- TransferStatistics Core
- Provides data transfer statistics for a specific online service.
- TurnDetails
- Turn details class
- UserRoadblockPathPreviewCoordinate
- User roadblock path preview match info
- Version Core
- Define the content version with major and minor.
- Voice Core
- Voice object
-
XyType<
T extends num> Core - A generic type consisting of x and y coordinates.
Enums
- AddressField Places
- Address field enumeration
- AlertSeverity Core
- Alert severity type.
- AnchorType
- The anchor type.
- AppTheme Core
- The application theme
- ArrowDirection
- The arrow direction of the shape.
- ArrowType
- The arrow type of the shape.
- AudioOutput
- Audio output type.
- ContactInfoFieldType Places
- Contact info field type
- DriveSide
- The drive side of the abstract geometry.
- EngineMisc Core
- Miscellaneous engine icon identifiers.
- EntranceLocationType Places
- Type of an entrance location.
- GemCameraPlayerStatus Sensor Data Source
- Status enum describing the state of a GemCameraPlayerController.
- GemDumpSdkLevel Core
- The level for logs sent to Magic Lane in case of crashes.
- GemError Core
- Error codes.
- GemIcon Core
- SDK icon identifiers.
- GemLoggingLevel Core
- The log level for SDK features
- GeographicAreaType Core
- Types of geographic areas.
- GetWaypointsOptions
- Get route waypoints options.
- Grade
- Climb grade - UCI based, see https://bicycles.stackexchange.com/questions/1210/how-are-the-categories-for-climbs-decided
- ImageFileFormat Core
- Enumerates known image file formats.
- ImageType Maps & 3D Scene
- Type of an image
- ISOCodeType Core
- ISO code variants.
- LandmarkFileFormat
- Landmark import supported formats
- LandmarkStoreType Places
- Landmark store types
- MapLanguage Core
- Available options for map language selection.
- MapStatus Core
- Worldwide road map support status
- Navigation modifiers
- NetworkType Core
- Network types enumeration.
- OnlineRestrictions Core
- Represents online restrictions using bitwise flags.
- PathFileFormat Core
- Supported formats for path import.
- PositionQuality Sensor Data Source
- Values that represent position data quality.
- RealtimeStatus
- Status of real-time information.
- Reason Core
- Error reason type
- RestrictionType
- The restriction type of the shape.
- RoadType
- Get road type
- RouteStatus
- Status of routing service.
- RoutingAlgoModifiers
- ScriptVariant Core
- Script variants.
- SdkCapability Core
- Enumerates the possible capabilities for the SDK.
- ServiceGroupType Core
- Service group enum, including map tiles, traffic, terrain.
- ShapeForm
- The type of the shape. Use the type to render the shape in different width and color.
- ShapeType
- The type of the shape. Use the type to render the shape in different width and color. ShapeType.route should be rendered over ShapeType.street
- SoundPlayType Core
- Specifies the type of media the sound engine is currently playing.
- StepType
- Step unit type.
- SurfaceType
- Get surface type
- 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
- TrafficTransportMode
- Affected transport modes for traffic events
- TrafficUsage
- Traffic usage type
- TransitType
- Type of transit.
- TurnEvent
- Navigation turn events
- UnitSystem Core
- Unit system
- ValueType Core
- Types of values.
- ViewOnlineServiceType
- Online service type for which the view can generate data transfer statistics
- VoiceType Core
- Enumerates the voice types
Typedefs
Exceptions / Errors
- GemKitUninitializedException Core
- Exception thrown when GemKit is not initialized
- ObjectNotAliveException Core
- Exception thrown when an object is not alive