AbstractGeometry

AbstractGeometryImageRenderSettings

Rendering settings for turn instruction images in navigation instructions.

Configures the visual appearance of turn arrow images representing turn maneuvers in navigation. Allows customization of inner and outer colors for both active (recommended) and inactive (alternative) turns. Active colors highlight the recommended turn direction, while inactive colors show non-recommended alternatives. All color properties default to optimal values if not specified.

AbstractGeometryImg

Class used for customizable turn images

AbstractGeometryItem

Acceleration

Acceleration sensor data in three-dimensional space.

Measures linear movement of the device along the X, Y, and Z axes. Useful for detecting motion, steps, or sudden changes in speed.

Sensor Data Source

ActivationInfo

Represents details about a product activation stored on the device.

Contains status, expiry and identifying information for an activation entry. Instances are typically returned by ActivationService.getActivationsForProduct.

Activation

ActivityRecord

Represents metadata for a recorded activity.

Contains short and long descriptions, the sport type, perceived effort level, an optional bicycle profile for cycling or e-bike activities, and visibility settings that control who can view the activity. Attach an ActivityRecord to a recording (for example via Recorder.activityRecord) to store user-provided metadata about the session.

The ActivityRecord is not detected automatically; it must be explicitly set by the user.

AddressInfo

Address info class Places

AlarmListener

Alarm listener interface.

Routes & Navigation

AlarmMonitoredArea

Alarm monitored area consisting of a GeographicArea and an id.

Routes & Navigation

AlarmService

Provides monitoring and notification for navigation-related alarm events.

The AlarmService manages a variety of alarm types including speed limit violations, landmark proximity alerts, overlay item notifications (such as safety cameras and social reports), geographic boundary crossings, tunnel entry/exit events, and day/night mode transitions. Configure the service with an AlarmListener to receive callbacks for these events.

Multiple AlarmService and AlarmListener instances can operate simultaneously, enabling concurrent monitoring of different events or areas.

Make sure to keep a reference to both the AlarmService and AlarmListener instances for as long as you want to receive alarm notifications. If either instance is garbage collected, alarm callbacks will stop being triggered.

Routes & Navigation

Attitude

Device orientation attitude data in 3D space.

Describes the device's orientation expressed as Euler angles (roll, pitch, yaw) along with optional noise variance measurements.

Sensor Data Source

AutoUpdateSettings

Configuration for auto update

Core

Battery

Battery status information sensor data.

Provides comprehensive battery information including charge level, state, health, voltage, temperature, and power connection status.

Sensor Data Source

BikeProfileElectricBikeProfile

Bike and electric bike routing profile.

Container used to select a standard bike profile or an electric-bike profile for routing. The field selects the general cycling behaviour (city, road, etc.) while holds optional electric-specific parameters.

Routing

BNGProjection

BNGProjection class

Projections

BuildTerrainProfile

Preferences regarding building terrain profile.

These preferences influence whether terrain profile data is calculated. Terrain profile data includes elevation changes along the route, which can be useful for activities like biking or hiking.

These settings are required for the to be populated in the route response.

Routing

Camera

Camera frame sensor data.

Provides camera frame data, including configuration metadata and raw/processed image buffers. Typically used for computer vision or video recording features.

Sensor Data Source

CarProfile

Car routing profile.

Profile used for car routing. Extends MotorVehicleProfile and exposes parameters relevant when computing car routes.

Routing

CircleGeographicArea

CircleGeographicArea object.

ClimbSection

Climb section

Color

Color representation in RGBA format

ColorExtension

Compass

Compass sensor data providing directional heading.

Gives the device's heading relative to magnetic or true north using magnetometer data.

Sensor Data Source

Conditions

Weather conditions for a specific timestamp.

Contains weather information including type, description, parameters, and visual representation for a particular moment in time.

Get a list of Conditions via LocationForecast.forecast.

Weather

ContactInfo

Contact info class

A ContactInfo can have multiple values of the same ContactInfoFieldType.

Changes made to this object will not be automatically reflected in associated Landmark. Use the Landmark.contactInfo setter to set the contact info for a landmark.

ContentStoreItem

A single downloadable content product managed by the ContentStore.

This class models one content product (for example: a map/region, style, or voice pack). Do not construct instances directly; obtain items from the public ContentStore API.

The object exposes identification and localized display text, content type and language, size and downloaded-size metrics, availability/status and progress indicators, preview imagery, additional content-specific parameters and update metadata (version and update size).

Use this object to start/pause/cancel downloads, query state, access previews and delete local content.

Content

ContentStoreItemList

ContentUpdater

Provides functionality to update content in the GEM SDK content store.

This class should not be instantiated directly. Instead, use ContentStore.createContentUpdater() to obtain an instance.

An object used for applying updates to downloaded content packages. It represents a single update session (created by the ContentStore) and is used to start or resume an update, report progress and status changes, and complete the update flow.

Content

Coordinates

Coordinates class

CountryData

Compact country metadata including display name, ISO code and flag.

This value object is returned by several MapDetails helpers (for example, MapDetails.getCountryData and MapDetails.allCountriesData) and can be used by clients to display country information or retrieve flag images.

DataSource

SensorDataSource Through this interface data can be obtained from sensors, log files or any other means

DataSourceListener

A listener that receives data from a data source. Sensor Data Source

DepartureHeading

Departure heading

Contains information about the direction the user is facing.

Routing

DriverBehaviour

The driver behaviour class.

Provides methods for starting, stopping, managing and getting driver behaviour analysis.

Driver Behaviour

DriverBehaviourAnalysis

A driver behaviour analysis.

Provides methods for getting driver behaviour analysis data.

This class should not be instantiated directly. Instead, use the methods provided by the DriverBehaviour class.

Driver Behaviour

DrivingScores

Driving scores.

Provides information about driving scores.

This class should not be instantiated directly. Instead, use the DriverBehaviourAnalysis.drivingScores getter to obtain a list of instances.

Driver Behaviour

ElectricBikeProfile

Electric bike profile containing e-bike configuration and rider/vehicle parameters.

Holds electric bike specific routing parameters used by the routing engine to estimate energy consumption, apply legal constraints, and tune route generation for e-bike capabilities.

Routing

EntranceLocations

Stores locations & access types for entrances to landmarks.

This class should not be instantiated directly. Instead, use the Landmark.entrances getter to obtain an instance.

EVCarModel

An electric vehicle car model used for EV route calculations.

Contains vehicle specifications relevant to EV routing such as battery capacity, charging ports, range, efficiency, and fast charge capability.

Routes & Navigation

EVCarModelList

A list of EVCarModel objects.

Routes & Navigation

EventDrivenProgressListener

Event-driven implementation of ProgressListener for async operations.

EVProfile

EVRouteInstruction

EVRouteSegment

ExpiredContent

Expired Content

Core

ExternalInfo

ExternalInfo object

Provides wikipedia information for a landmark.

Places

ExternalPositionData

External position data

ExternalRendererMarkers

ExtraInfo

Extra info class for landmark metadata.

ExtraInfo is a flexible key/value store used by the SDK to attach auxiliary information to landmarks. It can contain fields used internally for contour boxes, geographic area metadata, or Wikipedia information.

FollowPositionPreferences

Follow position preferences class

GateStatus

Gives more details about the status of a gate, such as the decision, the time until which the decision is valid, and a reason for the decision.

Use GateKeeperService.getStatus to obtain the GateStatus for a specific gate.

Activation

GemAnimation

Animation helper class.

GemCameraPlayer

Controller for managing camera feed playback from a data source.

Manages playback of camera frames from a DataSource by tracking the GemCameraPlayerStatus state. Automatically registers a DataSourceListener to receive new camera frames and update the playback status. Use with camera rendering components to display camera feed frames.

The controller validates that the data source supports camera data and sets an error status if unavailable. It handles automatic state transitions between loading, playing, paused, and ended states based on incoming data and playback events. The controller must be disposed when no longer needed to clean up listeners and resources.

Sensor Data Source

GemImage

GemImage class representing an image with format and metadata

GemKit

GemKitPlatform

GemList

GemMap

GemParameter

Core A parameter is a tuple ( key, value, name ).

key is the string parameter identifier

value is the parameter variant value.

name is the string parameter name. When parameters are returned from SDK the name is translated in the SDK language

value is the parameter value. It is dependent on the type

GemPositionListener

Gem Position Listener Sensor Data Source

GenericCategoriesIdExtension

Helper functions for GenericCategoriesId

Core

GKProjection

GKProjection class

Projections

GuidedAddressSearchPreferences

Preferences for guided address search. Places

GuidedAddressSearchService

Class representing a guided address search service session. Places

HeartRate

Heart rate biometric sensor data.

Represents heart rate readings in beats per minute, typically from a fitness or health sensor.

Sensor Data Source

HighlightRenderSettings

Img

Class used for basic images

Represents the image in an abstract way, providing metadata and access to the RenderableImg.

ISOCodeTypeExtension

Helper functions for ISOCodeType

Core

LAMProjection

LAMProjection class

Projections

Landmark

Landmark class - core class for location information

LandmarkAlarmsList

Geographic coordinates referenced list of Landmark alarms.

Routes & Navigation

LandmarkBrowseSession

Represents a session for browsing landmarks in a store.

This class should not be instantiated directly. Instead, use the LandmarkStore.createLandmarkBrowseSession method to obtain an instance.

Places

LandmarkBrowseSessionSettings

Used in specifying the settings of a LandmarkBrowseSession

Core

LandmarkCategory

Landmark category class

LandmarkJson

Landmark JSON class for serialization Landmark class ideally for setting large amount of landmarks data. eg. for List of Landmarks.

LandmarkList

Landmark List class

LandmarkPosition

Coordinate referenced Landmark object

LandmarkStore

Provides access to a landmark store and its operations.

This class should not be instantiated directly. Instead, use the related methods from LandmarkStoreService to obtain an instance.

It represents a single persistence store instance and is the primary entry point for reading, adding, updating and removing landmark data and categories, plus creating scoped browse sessions for iterative access.

Typical tasks include enumerating and filtering landmarks (by category or geographic area), creating and modifying categories, importing external landmark datasets. Main members expose store identity and metadata, collections of category and landmark objects.

Can be presented on the map using the LandmarkStoreCollection associated with a GemMapController, in for custom search operations and for alerts.

Places

LandmarkStoreCollection

Landmark store collection class

This class should not be instantiated directly. Instead, use the [MapViewPreferences.lmks] getter to obtain an instance.

Places

LandmarkStoreListener

Landmark store listener for receiving events about landmark store lifecycle changes.

Places

LaneImageRenderSettings

Rendering settings for lane guidance images in navigation instructions.

Configures the visual appearance of lane guidance images that show which lanes the driver should use for upcoming maneuvers. Controls the background color, active lane color (recommended lanes), and inactive lane color (lanes to avoid). All color properties default to optimal values: transparent background, white active lanes, and gray inactive lanes for clear visual distinction.

LaneImg

Class used for customizable lane images

Language

Complete language specification.

Core

LocationForecast

Weather forecast for a specific geographic location.

Contains the forecast update time, coordinates, and a list of conditions representing weather data for the location.

Obtained via WeatherService methods.

Weather

Logger

Configurable logger for the Magic Lane Maps SDK.

Provides centralized logging with configurable levels, custom handlers, and optional timestamps. By default, only error messages are logged.

LogMetadata

Provides metadata for a recorded sensor data log.

The LogMetadata object exposes information extracted from a recorded log file such as start/end timestamps and positions, route coordinates, activity details, user-provided metadata, and basic metrics. The LogMetadata class provides information about the recorded log via the Recorder class.

Do not construct this class directly; obtain an instance via RecorderBookmarks.getLogMetadata.

LogMetrics

Provides metrics about a recorded log, such as distance, elevation gain, and average speed.

These metrics are typically retrieved from a LogMetadata instance and represent summary information for a saved recording.

LogUploader

Uploads a recorded log file to Magic Lane servers for bug reports.

LogUploader sends .gm or .mp4 recordings to Magic Lane backends and reports progress and status updates through the optional callback provided at construction.

Use this class to programmatically upload logs for diagnostics or bug reporting.

Sensor Data Source

MagneticField

Magnetic field sensor data.

Reports raw magnetic field strength along three axes. Useful for environmental sensing or heading correction.

Sensor Data Source

MapCamera

Map camera class.

This class should not be instantiated directly. Instead, use the GemView.camera getter to obtain an instance.

Controls the map view camera. It lets clients save and restore the camera state, read the current orientation and position, and set position or orientation either directly (quaternion/3D position) or via higher‑level camera transforms (absolute camera placement, target‑centered or target‑relative setups).

It also provides helpers to compute a camera position and orientation for a given geographic target and heading/pitch/roll or distance parameters, returning a typed position+orientation result together with an operation status.

Common uses are persisting/ restoring view state, programmatically placing the camera around a point or object, and generating camera matrices for custom actors or animations.

Maps & 3D Scene

MapDownloaderService

Service for downloading offline map tiles for one or more geographic areas.

Use this service to initiate downloads of map tiles for offline viewing. Manage the downloaded map data and monitor transfer statistics.

This service does not manage map data storage. Downloaded tiles cannot be used for search, navigation or routing. See the ContentStore for managing offline map data.

Maps & 3D Scenes

MappedDrivingEvent

A mapped driving event.

Provides information about a driving event.

This class should not be instantiated directly. Instead, use the DriverBehaviourAnalysis.drivingEvents getter to obtain a list of instances.

Driver Behaviour

MapSceneObject

Maps scene object

MapViewExtensions

Map View Extensions

A compact set of view-scoped helpers that extend the native map view with lightweight, platform-proxied utilities for view tuning and small integrations. Exposes convenience features for performance and interaction tuning as well as integrations with sensing/positioning subsystems.

Common tasks are enforcing zoom limits and toggling performance optimizations for lower-end devices, switching reduced-rate navigation updates, enabling or disabling enhanced position-tracking visualizations (optionally driven by a specific data source and rendering settings), and querying the current tracked positions or tracking state.

Maps & 3D Scene

MapViewMarkerCollections

MapViewOverlayCollection

OverlayCollection for a MapView object.

MapViewPathCollection

Collection of paths for a map view.

This class should not be instantiated directly. Instead, use the MapViewPreferences.paths getter to obtain an instance.

Core

MapViewPreferences

Mapview preferences

MapViewRenderInfo

Information produced when the map view finishes a render pass.

Provides the data and camera transition statuses, the geographic area visible in the view (as a polygon), and lists of marker and source IDs that were rendered. Prefer for accurate area calculations when the map is rotated.

MapViewRoute

MapViewRoutesCollection

Marker

Marker

A compact map model representing a visual geometry (icon, point, polyline or polygon) placed at geographic coordinates for annotations, waypoints or temporary content.

Common operations include creating, managing their geometric parts and coordinates (adding, updating and removing points or parts), querying the enclosing bounds and coordinate lists for layout or hit‑testing, reading and setting basic metadata such as title and identifier.

Can be added to a MarkerCollection and displayed on the map using the MapViewMarkerCollections object associated with a GemMapController. The appearance is highly customizable using the MarkerRenderSettings and MarkerCollectionRenderSettings class.

MarkerCollection

Marker collection class

Holds markers of a single visual style and geometry class for a map view.

Common tasks are creating a collection for a specific marker kind and adding or removing markers, looking up markers by position or identifier, iterating or counting entries, querying the collection's geographic extent for layout or hit‑testing, grouping and retrieving related components.

Can be presented on a map via the MapViewMarkerCollections object associated with a GemMapController.

Also see MarkerSketches for a specialized marker collection with per-marker render settings.

MarkerCollectionRenderSettings

MarkerInfo

MarkerJson

MarkerMatch

MarkerRenderSettings

MarkerWithRenderSettings

MGRSProjection

MGRSProjection class

Projections

MotorVehicleProfile

Motor vehicle profile.

Base class for motorized vehicle profiles such as CarProfile and TruckProfile. Provides common routing parameters used by the routing engine (mass, maximum speed and fuel type).

Routing

MountInformation

Device mounting information sensor data.

Describes how the device is physically mounted or oriented within a fixed system, such as in a vehicle.

Sensor Data Source

NavigationInstruction

NextSpeedLimit

NmeaChunk

NMEA sentence data from GNSS receivers.

Raw navigation data in NMEA sentence format, typically from GNSS receivers for high-precision tracking.

Only available on Android devices.

Sensor Data Source

OffBoardListener

OffBoard Listener

Core

Orientation

Device orientation sensor data.

Combines multiple sensors (like accelerometer and magnetometer) to determine the absolute device orientation including screen rotation and face direction.

Sensor Data Source

OverlayCategory

Overlay category

Maps & 3D Scene

OverlayInfo

Overlay info class

This class should not be instantiated directly.

Maps & 3D Scene

OverlayItem

Overlay Item class

This class should not be instantiated directly.

Maps & 3D Scene

OverlayItemAlarmsList

Geographic coordinates referenced list of OverlayItem alarms.

Routes & Navigation

OverlayItemPosition

Overlay Item Position class

This class should not be instantiated directly.

Maps & 3D Scene

OverlayMutableCollection

Mutable Overlay Collection class

This class should not be instantiated directly.

Maps & 3D Scene

Pair

A pair consisting of 2 objects

Parameter

Weather parameter data.

Contains weather-related measurements such as temperature, humidity, wind speed, etc. Provided by Conditions.params to represent specific weather attributes.

Weather

ParameterList

Parameter List class

Path

Represents a path object.

Core

PathMatch

Represents a path match result from hit testing.

Core

Playback

Represents the operations that can be performed on a DataSource which has playback capabilities

Point3d

A point in 3d space, consisting of x, y and z coordinates.

Point4d

A point in 4d space, consisting of x, y, z and w coordinates.

PolygonGeographicArea

PolygonGeographicArea object.

PositionOrientation

The position and orientation of an object in 3D space.

Core

PositionSensorConfiguration

Configuration class for position sensor

PositionService

Position service class

PredefinedExtraInfoKey

Predefined custom landmark extra info keys

Projection

Projection interface which deals with all types of projections.

Projections

PTAgency

Public transport agency information.

Holds identifying metadata for a transit agency: numeric id, display name and an optional website URL.

Is provided as part of PTStopInfo.agencies.

Maps & 3D Scene

PTAlert

PTBuyTicketInformation

Public transport buy ticket information class Routes & Navigation

PTRoute

Public transport route class

Routes & Navigation

PTRouteInfo

Public-facing route information for a stop.

Contains rider-visible route metadata such as short/long names, route type and color hints. Use this when presenting routes associated with a stop in UI or lists.

Instances are provided as part of PTStop.routes or PTTrip.route.

Maps & 3D Scene

PTRouteInstruction

Public transport route instruction class

Routes & Navigation

PTRouteSegment

PTStop

Public transport stop metadata.

Represents a stop (or platform/entrance) with an id, display name and the set of routes that serve it.

Instances are produced as part of PTStopInfo.stops.

Maps & 3D Scene

PTStopInfo

Aggregated public transport data for a selected overlay item.

Instances are produced by OverlayItem.getPTStopInfo() and contain the agencies, stops and trips associated with the selected public transport overlay item. Use the filtering helpers to query trips by short name, type or agency.

PTStopTime

Stop-time information for a single stop within a trip.

Contains local-time departure, delay and realtime availability flags. NOTE: departure times are returned as Date objects with UTC flag but encoded as local time; convert using TimezoneService when needed.

Maps & 3D Scene

PTTranslation

PTTrip

A scheduled public transport trip instance.

Represents a single scheduled run of a route with times, delays, cancellation and accessibility metadata.

Maps & 3D Scene

Recorder

Recorder for capturing sensor and multimedia logs.

Use a configured RecorderConfiguration to create a Recorder with Recorder.create(). The recorder manages recording lifecycle (start, stop, pause, resume), audio/video capture and user metadata. See recorder guides for background permissions and storage recommendations.

The recorded logs can be accessed and managed using RecorderBookmarks and their metadata through LogMetadata.

Sensor Data Source

RecorderBookmarks

Provides access to recorded logs and their metadata on the device.

RecorderBookmarks lets you list, inspect, export, import and manage recorded .gm and .mp4 files stored in a logs directory.

Do not instantiate directly; use to obtain an instance bound to a specific folder.

RecorderConfiguration

Configuration used to control recorder behavior and log storage settings.

Use this object to specify which data types to record, where logs are stored, chunking and retention policies, video quality and audio options, and device-specific hardware metadata. Construct a RecorderConfiguration and pass it to Recorder.create() or Recorder.setRecorderConfiguration() to apply the settings.

Sensor Data Source

RecordMetrics

Performance metrics produced while a recording is active.

RecordMetrics is exposed by the Recorder while it is in RecorderStatus.recording. The values reset at the start of each recording session and provide realtime measurements that can be used in UI or analytics.

RectangleGeographicArea

RectangleGeographicArea object.

RectType

A generic type consisting of x, y, width and height coordinates.

RenderableImg

Represents a renderable image with its dimensions and binary data

RenderSettings

RoadInfo

RoadInfoImageRenderSettings

Road info image render settings. Initialized with default optimal values

RoadInfoImg

Class used for road info images

RoadTypeSection

Road type sections

Sections list is in route begin -> end walk orders

RotationRate

Gyroscope rotation rate sensor data.

Measures the rate of rotation around the device's axes. Used to detect turns and angular movement.

Sensor Data Source

RoundTripParameters

Round trip parameters

Routing

Route

RouteBookmarks

Manages a persistent collection of saved routes (bookmarks).

Provides operations to create, add, import, update, remove and export saved routes. Use RouteBookmarks.create to open or create a named bookmarks collection backed by a file.

RouteInstruction

RouteInstructionBase

RouteListener

Listener for events related to a route

RoutePreferences

Comprehensive route calculation configuration for customizing routing behavior.

RoutePreferences centralizes all route calculation options including transport mode, vehicle profiles, avoidance settings (motorways, tolls, ferries, unpaved roads), traffic handling, algorithm selection, result detail levels, and alternative route handling. Set preferences before calling RoutingService.calculateRoute() to control how routes are computed.

Each transport mode supports specific profile configurations: - for cars, including fuel type and vehicle mass - for trucks, with dimensions and axle load constraints - for bicycles, supporting both standard and electric bikes - for walking or wheelchair-accessible routes

Common preferences include (fastest, shortest, economic), , , , , and strategies. Public transport options include departure/arrival times via and , transfer constraints, and sorting strategies. Emergency vehicle mode relaxes routing constraints.

Routing

RouteRenderSettings

RouteSegment

RouteTerrainProfile

Route terrain profile

This class should not be instantiated directly. Instead, use the RouteBase.terrainProfile getter to obtain an instance. Note that the RoutePreferences.buildTerrainProfile setting should be configured correctly when calling the RoutingService.calculateRoute method for the RouteBase.terrainProfile getter to return a valid object.

RouteTrafficEvent

Route traffic events class

SdkSettings

SearchableParameterList

Searchable parameters list. Container for different types of values.

SearchPreferences

Search preferences

Places

SenseDataFactory

Sense data factory

SensorConfiguration

Sensor configuration base class

SignpostDetails

SignpostImageRenderSettings

Rendering settings for signpost images in navigation instructions.

Configures the visual appearance of signpost images that display upcoming exit information and destination names on highways and major roads. Controls border styling, corner rounding, and the maximum number of destination rows displayed. All properties default to optimal values: 10px border, rounded corners enabled, and maximum 3 rows of details.

SignpostImg

Class used for customizable signpost images

SignpostItem

SignpostItemList

SocialReportListener

Listens for updates to social report overlay items and delivers update events.

Notifies about changes to social report overlay items such as new comments, thumb (upvote/downvote) actions, or other detail changes. Use this listener to receive the updated OverlayItem whenever the social overlay emits an update for a specific report.

Typical usage:

const listener = new SocialReportListener({
  onReportUpdated: (report) => {
    // Do something with the updated report
  },
});

SocialOverlay.registerReportListener(reportItem, listener);

Obtain and register instances via SocialOverlay.registerReportListener.

Overlays

SocialReportsOverlayInfo

Social Reports Overlay Info

Provides access to social report category hierarchy and metadata.

Maps & 3D Scene

SoundMark

Represents a time interval in a recording where sound was captured.

A SoundMark identifies the start and end offsets (in milliseconds) of a section of a log that contains recorded audio and the geographic Coordinates associated with that interval.

Soundmarks are generated automatically during audio recording sessions. Play the .mp4 file with an external media player to play the audio content from the start to the end offsets.

SoundPlayingListener

Listener for events related to sound playback and text-to-speech.

Register callbacks on this listener to be notified when a sound starts, stops or when system audio interruptions occur. Only a single sound event can be played by the SDK at a time; use the getters soundPlayType, soundPlayContent and soundPlayFileName to inspect details about the currently playing item.

SoundPlayingPreferences

Preferences controlling how the SDK plays sounds and TTS.

Use this object to configure per-severity sound settings (volume, maximum playback time, audio stream type and focus delay).

Modifications to an instance of this class are not applied automatically. To apply changes, call SoundPlayingService.setSoundPlayingPreferences.

SoundSessionRequestPreferences

Preferences used when requesting an audio session from the platform.

This object controls how the SDK requests audio focus (category, preferred output, delay before granting focus and exclusivity).

Modifications to an instance of this class are not applied automatically. To apply changes, call SoundPlayingService.soundSessionRequestPreferences.

SteepSection

Steep sections

Sections list is in route begin -> end walk order.

SurfaceSection

Surface sections

Sections list is in route begin -> end walk order.

Temperature

Temperature sensor data.

Provides temperature readings, either ambient or internal device temperature, along with a severity level indicator.

Sensor Data Source

TextMark

Represents a textual annotation at a specific moment in a recording.

A TextMark stores an offset timestamp, geographic Coordinates, and a textual report describing the moment. Text marks are useful for bookmarks, notes, or labeling events during a recording session.

Text marks are added by calling the Recorder.addTextMark method while recording.

TilesCollectionGeographicArea

TilesCollectionGeographicArea object.

TimeDistance

Time distance representation based on meters and seconds.

TimeDistanceCoordinate

Timestamp & distance & coordinates structure

TimezoneResult

Result which contains all information about a timezone

This class should not be instantiated directly. Instead, use the related methods from TimezoneService to obtain an instance.

Core

TimezoneService

Timezone Service class

Provides information about timezones.

Core

TrafficEvent

Traffic events class

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.

Obtain an instance via TrafficEvent.getPreviewData(). The method may return null when no preview data is available for a given event.

TrafficPreferences

Traffic Preferences

This class should not be instantiated directly. Use the TrafficService.preferences getter to get an instance.

TrafficService

Traffic service. Adds support to update traffic information.

TransferStatistics

TruckProfile

Truck routing profile.

Profile used for truck/lorry routing that includes vehicle dimensions and axle/load constraints. These parameters are considered by the routing engine when calculating truck-compatible routes (bridges, height/weight limits, etc.).

Make sure to specify accurate values for the truck dimensions as they are measured in centimetres.

Routing

TurnDetails

UserRoadblockPathPreviewCoordinate

User roadblock path preview match info

Used for TrafficService.getPersistentRoadblockPathPreview.

UTMProjection

UTMProjection class

Projections

VehicleRegistration

Vehicle registration information.

Base class that holds vehicle registration details used by routing and transport-related preferences. Subclasses such as MotorVehicleProfile and ElectricBikeProfile extend this to provide additional routing parameters.

Routing

Version

Define the content version with major and minor.

Voice

Voice information object.

Provides metadata about a voice asset: its name, language and file location. Returned voices can be used with TTS and playback APIs.

It is usually obtained via SdkSettings.voice after setting the desired voice using SdkSettings.setVoiceByPath or SdkSettings.setTTSVoiceByLanguage.

W3WProjection

W3WProjection class

Projections

WGS84Projection

WGS84Projection class

Projections

XyType

A generic type consisting of x and y coordinates.

ActivationService

Service for activating and managing product licenses for the Magic Lane SDK.

Used in Magic Lane products. Provides methods to generate license keys, activate and deactivate products, complete online/offline activation flows, query activation state and list activations present on the device.

Activation

AlarmsList

Geographic coordinates referenced list of item alarms.

Routes & Navigation

ContentStore

Content store object

This behaves like a singleton, i.e. all instances are sharing behind the same API interface

Content

Debug

Provides debugging utilities for memory monitoring, logging, and SDK configuration.

The Debug class offers static methods for monitoring memory usage, controlling log output, configuring routing and navigation behavior, and retrieving SDK diagnostics. Key features include:

• Memory monitoring: Track used, free, and maximum memory consumption - Logging system: Send logs to Magic Lane servers for crash analysis - Debug flags: Control console output for object creation and method calls - Routing/Navigation modifiers: Alter algorithm behavior for testing - Storage information: Monitor mount points and disk space

Settings

DurationID

Predefined duration identifier constants (ISO 8601 period format).

These constants represent common license duration values used when requesting or describing product durations.

Activation

ExternalInfoService

GateKeeperService

Service used to check the status of gates.

Activation

GemImprovedPosition

Improved position class with map matching information

GemPosition

GemSdkNativeBase

GemView

Abstract class representing a GemView. Implements EventHandler and IMapViewListener.

Core

GenericCategories

Generic categories class

Core

IGemKitPlatform

IGemPositionListener

Position listener interface. Sensor Data Source

ImgBase

Base class for images

Represents the image in an abstract way, providing metadata and access to the RenderableImg.

ISOCodeConversions

ISO codes conversions class. Performs language & country conversions ISO2 to ISO3 / ISO3 to ISO2.

Core

LandmarkStoreService

Landmark store service

A static service providing high-level management for landmark store lifecycle and discovery. It is the central entry point for creating or registering stores, looking up existing stores, removing stores, enumerating all available stores and obtaining built-in store identifiers used by the map.

Main capabilities include store creation/registration and lookup, retrieval of special-purpose store identifiers used by the SDK, enumeration of available stores. Common tasks are creating or importing a store, resolving a store to use for imports or queries, removing an unused store, listing store and adding/removing event listeners to react to store lifecycle changes.

Places

LocalizationService

Localization service to retrieve localized strings.

This class provides methods to get localized strings based on string IDs. The returned strings are localized according to the current SdkSettings.language setting.

The ids from LocalizationStringIds might be valuable for all API users.

Localization Service

MapDetails

Utilities for querying map metadata, coverage and country information.

The static MapDetails API provides read-only helpers to inspect local map coverage, obtain country names and flags, compute sunrise/sunset times, enumerate map providers, and fetch version/release information.

NavigationService

Navigation service class

PersistentRoadblockListener

Persistent roadblock listener

ProductID

Well-known product identifier constants used by the activation API.

Use these constants when calling activation methods to specify the product to activate or query.

Activation

ProjectionService

Projection service class

Projections

RoutingService

Routing service class

Routes & Navigation

SearchService

Search service class

Places

SenseData

Base data class for sensor data

SocialOverlay

Static service for crowd-sourced social event reporting and interaction.

Provides a complete system for creating, managing, and interacting with user-generated reports about real-time road conditions and incidents.

Overlays

SoundPlayingService

High-level static API for playing sounds and TTS through the SDK.

This class exposes only static members and acts as a thin bridge to the native sound engine. Use SoundPlayingListener to observe playback lifecycle events, and SoundPlayingPreferences to configure per-severity playback settings.

TaskHandler

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.

Core

TtsLocalizationService

Text-to-speech localization service to retrieve localized strings for voice synthesis.

This class provides methods to get localized strings based on string IDs. The returned strings are localized according to the current SdkSettings.voice setting.

These strings are intended for text-to-speech output and may differ from UI strings where a voice-specific variant exists.

Localization Service

WeatherService

Service for retrieving weather forecasts and conditions.

This service provides methods to fetch current weather conditions, hourly forecasts, daily forecasts, and general weather data for specified geographic locations.

Weather

ActivationStatus

The various states an activation can be in on the device.

Use ActivationInfo.status to obtain the current state of an activation. These states reflect different lifecycle stages of a product activation on the device and with the remote activation service.

ActivityConfidence

Activity confidence levels

ActivityType

User activity types

ActivityVisibility

Defines visibility settings for an activity.

Does not control sharing; activities are local only. For use by applications to manage who can view the activity.

AddressDetailLevel

Address level of detail. Places

AddressField

Address field enumeration Places

AlertSeverity

Alert severity levels used for sound-related settings.

Severity controls which preferences apply when playing alerts.

AnchorType

The anchor type.

The anchor is a point (all intersections), a circle (roundabout, complex traffic figure) or a waypoint.

Routes & Navigation

AnimationType

The type of animation.

AppTheme

ArrowDirection

The arrow direction of the shape.

The arrow direction will be only valid for and some combined turns.

Routes & Navigation

ArrowType

The arrow type of the shape.

The arrow is either attached to the anchor side (begin), or the opposite side (end).

Routes & Navigation

AudioCategory

Audio category type used when requesting an audio session.

AudioOutput

Audio output type.

The audio output for sound playback.

AudioStreamType

Audio stream type used for playback.

Select which platform audio stream category should be used when requesting audio focus.

BatteryHealth

Battery health status

BatteryState

Battery states

BikeProfile

Bike profile selection used for bicycle routing.

Influences route generation to prefer roads/paths suitable for the chosen cycling style.

Routing

BuildingsVisibility

Buildings visibility modes

CommonOverlayId

Overlay Ids enumeration

Maps & 3D Scene

CompassAccuracy

Compass accuracy levels

ContactInfoFieldType

Contact info field type

ContentDownloadThreadPriority

Enumerates the priority levels for content download threads.

Specifies hints for the download thread scheduling priority.

Content

ContentStoreItemStatus

Enumerates possible states for a ContentStoreItem in the context of a download operation.

Content

ContentType

Downloadable content types managed by the Magic Lane SDK.

The ContentType enum lists kinds of downloadable content that the SDK can manage (map regions, style packages, voice packs, etc.).

Not all enum values are fully supported yet; consult upstream documentation when in doubt and prefer the values marked as supported by this package.

Content

ContentUpdaterStatus

Enumerates the possible statuses for a content updater operation.

Content

DataInterruptionReason

Data interruption reason Sensor Data Source

DataSavePolicy

Enumerates the data save policies for content downloads.

Specifies where downloaded content data should be stored on the device.

Content

DataSourceType

The data source type.

Sensor Data Source

DataType

Known sense data types

Daylight

Represents the state of daylight conditions.

Weather

DriveSide

The drive side of the abstract geometry.

The drive side allows to render the correct U-Turn shape.

Routes & Navigation

DrivingEvent

Describes various driving-related events.

Driver Behaviour

EffortType

Represents the effort level for an activity.

ElectricBikeType

Electric bike drivetrain type.

Enumerates supported e-bike drivetrain classifications used in ElectricBikeProfile.

Routing

EngineMisc

Miscellaneous icons

EntranceLocationType

Type of an entrance location

EVChargingConnector

Electric vehicle charging connector type

Not yet supported by the routing engine.

Routing

FaceType

Device face types

FileSortOrder

Values that represent file sorting orders.

Sensor Data Source

FileSortType

Values that represent file sorting types.

Sensor Data Source

FileType

Path import supported formats

Sensor Data Source

FollowPositionMapRotationMode

Follow position map rotation mode

FollowPositionState

Follow position state. Used in IMapViewListener.onFollowPositionState and IMapViewListener.onTouchHandlerModifyFollowPosition

Maps & 3D Scene

FuelType

Fuel type for motorized vehicles.

Enumerates engine fuel types used by vehicle profiles.

Routing

Gate

Gate enumeration representing different gates that can be checked.

Gates represent different functional areas or features of the SDK that can be enabled or disabled based on license status. Use with GateKeeperService to check whether specific features are available.

GateDecision

GateKeeperService decisions describing the kind of states a GateStatus can be in.

These values represent the decision outcome when checking whether access to a feature (gate) is allowed based on license status and activation state.

GemCameraPlayerStatus

Playback status for a camera player.

Describes the current state of camera playback, indicating whether the player is loading, playing, paused, ended, or in an error state.

Sensor Data Source

GemConsoleLogLevel

Logging levels for SDK debug output to console.

Controls the verbosity of log messages displayed in the console during development. Higher levels produce more detailed logging.

Settings

GemDumpSdkLevel

Verbosity levels for crash report logs sent to Magic Lane servers.

These levels control how much detail is included in logs automatically sent to Magic Lane in case of crashes. Lower levels minimize log traffic. Higher levels provide detailed diagnostics but are only available in debug SDK builds.

Settings

GemError

Enum representing various error states in the Gem system

GemIcon

SDK icons

GenericCategoriesId

Generic categories

Core

GeographicAreaType

Types of geographic areas

GetWaypointsOptions

Grade

Climb grade - UCI based, see https://bicycles.stackexchange.com/questions/1210/how-are-the-categories-for-climbs-decided

Categories are sorted in descending order by difficulty ( GradeHC - most difficult, Grade4 - less difficult )

HardwareSpecification

Enum for easily accessible hardware information on Android and iOS

Sensor Data Source

Hemisphere

The hemisphere type

Projections

HighlightOptions

ImageFileFormat

Enumerates known image file formats.

ImagePixelFormat

Image pixel encoding formats.

Defines various pixel formats used by camera sensors for encoding frame data.

ImagePosition

ImprovedPositionDefTransportMode

Default transport mode for improved position

ISOCodeType

ISO code variants.

Core

LandmarkFileFormat

Landmark import supported formats

Places

LandmarkOrder

Ways in which Landmarks from a LandmarkBrowseSession can be ordered

Core

LandmarkStoreType

Landmark store types

Places

LayoutImageId

Predefined image ids for SDK layout assets.

Core

LineType

LogUploaderState

State of a log upload operation.

Describes the lifecycle states a log upload can be in while being transferred to the server.

Sensor Data Source

MapCoverage

MapCoverage indicates the availability of map data for a region.

Use this enum to understand whether map tiles are available offline, available via cached tiles, only available online on the server, or unknown.

MapDetailsQualityLevel

Map details quality levels

MapExtendedCapability

Extended capabilities that may be available in a particular map dataset.

Each enum value represents an optional feature or behaviour flag that map data may provide. Use MapDetails.getMapExtendedCapabilities to obtain the set of capabilities available for the current map.

MapLanguage

MapProviderId

Identifiers for map data providers supported by the SDK.

Use these values when calling provider-specific APIs such as MapDetails.getProviderName or MapDetails.getProviderSentence. The numeric ids returned by MapDetails.getMapProviderIds correspond to these enum values.

MapStatus

Worldwide road map support status

Core

MapViewPerspective

Perspectives in which the map is viewed

MarkerLabelingMode

MarkerType

NavigationEventType

Navigation instruction event types

NavigationInstructionUpdateEvents

Navigation instruction update events

NavigationModifiers

Modifies navigation behavior for debugging and testing purposes.

These modifiers alter navigation behavior to simulate specific conditions or enable certain strategies. Used primarily for testing and debugging navigation features.

Settings

NavigationStatus

NextSpeedLimitStatus

OnlineRestrictions

Represents online restrictions using bitwise flags.

Core

OrientationType_2

UI orientation types

Origin

Data origin.

Sensor Data Source

PathFileFormat

Supported formats for path import.

Core

PedestrianProfile

Pedestrian profile

Used to specify the type of pedestrian for route calculation. Determines the pedestrian characteristics and routing preferences.

Routing

PlayingStatus

Represents the playing status of a data source.

Sensor Data Source

PluggedType

Plugged types

PositionAccuracy

The position accuracy

PositionActivity

The position activity

PositionQuality

Position quality enum

Core

ProjectionType

The map projection type

Projections

Provider

Position provider

PTAlgorithmType

Algorithm type

Used to specify whether the provided timestamp is for departure or arrival. Only used for public transport routing.

Routing

PTRouteType

Enumeration of public transport route types.

Mirrors common route categories (bus, tram, rail, etc.) used in GTFS-like data models.

Maps & 3D Scene

PTSortingStrategy

Sorting strategy

Used to specify the preferred sorting strategy for public transport routes. Only used for public transport routing.

Routing

PublicTransportImageId

Predefined image ids for public transport assets.

Core

RangeType

Range type to define ranges in.

Unit type to define ranges in. Currently only used for the roundtrips feature, not the ranges (aka isochrones) feature.

Routing

RealtimeStatus

Reason

Error reason type

Core

RecorderStatus

Enumerates different states of a recorder.

Sensor Data Source

RecordingTransportMode

Enumeration representing different modes of transportation.

Used in recording configurations to specify the transport mode. It is different from navigation transport modes.

Sensor Data Source

Resolution

Video resolution options for camera recording.

Sensor Data Source

RestrictionType

The restriction type of the shape.

The restriction type can be used to visualize the restriction for the connected street.

Routes & Navigation

RoadModifier

Current position road modifiers. Sensor Data Source

RoadShieldType

RoadType

Get road type

RouteAlternativesSchema

Alternative routes scheme

Routing

RouteBookmarksSortOrder

Sort order options for RouteBookmarks.

RouteDisplayMode

Route display modes

RoutePathAlgorithm

Path calculation algorithm

Used to specify the path calculation algorithm for route calculation.

Routing

RoutePathAlgorithmFlavor

Path calculation flavors

Used to specify the path calculation flavor for route calculation.

Routing

RoutePreviewBubbleImageId

Predefined image ids for route preview bubble assets.

Core

RouteRenderOptions

RouteResultDetails

Routing result details

Used to specify the level of detail in the routing result.

Routing

RouteResultType

Route result

Used to specify the type of route result to be returned. Determines whether a navigable path or a reachable area is computed.

Routing

RouteStatus

RouteTransportMode

Transport mode

Used to specify the primary transport mode for route calculation. Determines the vehicle or movement type used for routing.

Routing

RouteType

Route type

Used to specify the type of route to be calculated. Influences the optimization criteria for the route calculation.

Routing

RouteTypePreferences

Route type preference

Only relevant for public transport routing. Used to specify the preferred type of public transport for route calculation.

Routing

SceneObjectFileFormat

File format of the scene object

ScriptVariant

Script variants

Core

SdkCapability

Enumerates the possible capabilities for the SDK.

Core

ServiceGroupType

Service group enum, including map tiles, traffic, terrain.

Core

ShapeForm

The type of the shape.

Use the type to render the shape in different width and color.

Routes & Navigation

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.

Routes & Navigation

SignpostConnectionInfo

SignpostItemType

SignpostPictogramType

SoundPlayType

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.

SportType

Sport type enumeration.

Represents various sports activities, categorized by their nature

StepType

SurfaceType

Get surface type

TemperatureLevel

Temperature levels

TimeZoneStatus

Enumerates the type of response from the timezone plugin.

Core

TouchGestures

Touch gestures list

TrafficAvoidance

Traffic avoidance options

Used to specify the level of traffic avoidance during route calculation. Determines which types of traffic events to avoid.

Routing

TrafficEventClass

Traffic events classes

Routes & Navigation

TrafficEventImpactZone

Traffic event shape

Routes & Navigation

TrafficEventSeverity

Traffic event severity enum.

Routes & Navigation

TrafficOnlineRestrictions

Restrictions which prevent online service functionality

TrafficUsage

Define how traffic service will be used

Routes & Navigation

TransitType

TurnEvent

Navigation turn events

Routes & Navigation

UnitOfMeasurementAcceleration

Unit of measurement for acceleration

UnitSystem

ValueType

Types of values. Core

ViewCameraTransitionStatus

The camera transition status during a render.

Indicates whether the camera was stationary or moving while the view was produced. Moving states typically imply the render might be transitional.

ViewDataTransitionStatus

The status of view data transitions for a render pass.

Use this to determine whether the rendered content represents a final state or if the view is still waiting for additional online data.

VoiceType

Enumerates available voice types for TTS and voice playback.

Distinguishes between human (recorded) and computer-generated (TTS) voices used in navigation instructions and other audio output.

CameraConfiguration

Camera hardware and capture settings.

Encapsulates camera parameters including field of view, resolution, frame rate, pixel format, focal lengths, exposure, and ISO settings.

ColorLike

EventHandler

Interface for receiving events from the SDK

Core

GemPositionListenerParams

Parameters for creating a GemPositionListener

GeographicArea

This object represents a geographical area on the surface of a WGS 84 Ellipsoid.

IMapViewListener

Map view listener interface.

Implement this interface to receive map view events such as touch, gestures, selection, and rendering updates.

Maps & 3D Scene

LoggerConfig

Configuration options for the SDK logger.

Core

LogMark

Base interface for log marks, which can be either SoundMark or TextMark.

Sensor Data Source

Metrics

Base Metrics interface for metric objects used by the sense library.

Used internally to represent metric containers returned from recorder and log metadata APIs.

ProgressListener

Interface for implementing progress of async operations (routing, search)

Core

Size

Size interface representing width and height

SizeAndFormat

WeatherDurationCoordinates

Duration coordinates for weather forecasts with time offsets.

Specifies a location and a future time offset for which weather forecast is requested.

Weather

ActivationStatus

ActivationStatus extension methods.

ActivityVisibility

AddressField

AlertSeverity

AlertSeverity extension methods

AnchorType

ArrowDirection

ArrowType

AudioCategory

AudioCategory extension methods

AudioOutput

AudioOutput extension methods

AudioStreamType

AudioStreamType extension methods

ContactInfoFieldType

ContactInfoFieldType extension methods

Daylight

Daylight extension methods.

DriveSide

EffortType

EngineMisc

EngineMisc extension methods

EntranceLocationType

EntranceLocationType extension methods

FileSortOrder

FileSortType

FileType

Gate

Gate extension methods.

GateDecision

GateDecision extension methods.

GemConsoleLogLevel

GemConsoleLogLevel extension methods.

GemDumpSdkLevel

GemDumpSdkLevel extension methods.

GemError

GemIcon

GemIcon extension methods

GeographicArea

GeographicAreaType

GeographicAreaType extension methods

HardwareSpecification

Hemisphere

HighlightOptions

ImageFileFormat

ImageFileFormat extension methods

ImagePosition

LineType

MapCoverage

MapCoverage extension methods

MapExtendedCapability

MapExtendedCapability extension methods

MapProviderId

MapProviderId extension methods

NavigationModifiers

NavigationModifiers extension methods.

NavigationStatus

PathFileFormat

Extension methods for PathFileFormat enum.

ProjectionType

RecorderStatus

RecordingTransportMode

Resolution

RestrictionType

RouteDisplayMode

RouteRenderOptions

ShapeForm

ShapeType

SoundPlayType

SoundPlayType extension methods

SportType

TimeZoneStatus

TurnEvent

ValueType

Core

ViewCameraTransitionStatus

Extension methods for ViewCameraTransitionStatus.

ViewDataTransitionStatus

Extension methods for ViewDataTransitionStatus.

VoiceType

VoiceType extension methods.

SdkImageIds

Grouped predefined image ids.

Core

CursorSelectionCallback

FollowPositionStateCallback

HoveredMapLabelHighlightedLandmarkCallback

Callback invoked when a hovered map label highlights a landmark.

HoveredMapLabelHighlightedOverlayItemCallback

Callback invoked when a hovered map label highlights an overlay item.

HoveredMapLabelHighlightedTrafficEventCallback

Callback invoked when a hovered map label highlights a traffic event.

LogLevel

Log levels for SDK logging. Levels are hierarchical: 'debug' includes all logs, 'none' disables all logs.

Core

MapAngleUpdateCallback

MapViewMoveStateChangedCallback

MapViewRenderedCallback

MoveCallback

PinchCallback

PinchSwipeCallback

Point

RenderMapScaleCallback

SdkPredefinedImageId

Union type for all predefined SDK image ids.

Core

SetMapStyleCallback

Callback invoked when the map style is set.

ShoveCallback

SwipeCallback

TouchCallback

TouchPinchCallback

ViewportResizedCallback

Callback invoked when the viewport is resized.