Package-level declarations

Types

Link copied to clipboard
annotation class AppendersDsl
Link copied to clipboard
@JsonClass(generateAdapter = true)
data class Audio(@Json(name = "SoundSettings") val soundSettings: Audio.SoundSettings? = null)
Link copied to clipboard
annotation class AudioDsl
Link copied to clipboard
Link copied to clipboard
@JsonClass(generateAdapter = true)
data class Authentication(@Json(name = "app_key") val appKey: String, @Json(name = "app_secret") val appSecret: String? = null)
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
@JsonClass(generateAdapter = true)
data class License(@Json(name = "license_key") val licenseKey: String)
Link copied to clipboard
annotation class LoggingItemDsl
Link copied to clipboard
data class LoggingSettings(val loggingItems: List<LoggingSettings.LoggingItem>)
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
@JsonClass(generateAdapter = true)
data class MapReaderSettings(@Json(name = "file_handling") val fileHandling: MapReaderSettings.FileHandling? = null, @Json(name = "startup_poi_provider") val startupPoiProvider: MapReaderSettings.StartupPoiProvider? = null, @Json(name = "memory_mapped_file_extension") val memoryMappedFileExtension: List<String>? = null, @Json(name = "startup_online_maps_enabled") val startupOnlineMapsEnabled: Boolean? = null)
Link copied to clipboard
@JsonClass(generateAdapter = true)
data class MapSettings(@Json(name = "breadcrumbs_enabled") val breadCrumbsEnabled: Boolean? = false, @Json(name = "heightmap_enabled") val heightmapEnabled: Boolean? = null, @Json(name = "normalmap_enabled") val normalmapEnabled: Boolean? = null, @Json(name = "debug") val debug: MapSettings.Debug? = null, @Json(name = "max_roads_per_frame") val maxRoadsPerFrame: Int? = null)
Link copied to clipboard
abstract class NativeMethodsReceiver
Link copied to clipboard
@JsonClass(generateAdapter = true)
data class Navigation(@Json(name = "WarningSettings") val warningSettings: Navigation.WarningSettings? = null, @Json(name = "EvSettings") val evSettings: Navigation.EvSettings? = null, @Json(name = "RecomputeSettings") val recomputeSettings: Navigation.RecomputeSettings? = null, @Json(name = "ScoutSettings") val scoutSettings: Navigation.ScoutSettings? = null)
Link copied to clipboard
annotation class NavigationDsl
Link copied to clipboard
@JsonClass(generateAdapter = true)
data class Online(@Json(name = "General") val general: Online.General? = null, @Json(name = "SSOSession") val sSOSession: Online.SSOSession? = null, @Json(name = "ProductServer") val productServer: Online.ProductServer? = null, @Json(name = "Routing") val routing: Online.Routing? = null, @Json(name = "Search") val search: Online.Search? = null, @Json(name = "Places") val places: Online.Places? = null, @Json(name = "SpeedCameras") val speedCameras: Online.SpeedCameras? = null, @Json(name = "Incidents") val incidents: Online.Incidents? = null, @Json(name = "Traffic") val traffic: Online.Traffic? = null, @Json(name = "OfflineMapsApi") val offlineMapsApi: Online.OfflineMapsApi? = null, @Json(name = "Voices") val voices: Online.Voices? = null)
Link copied to clipboard
annotation class OnlineDsl
Link copied to clipboard
open class OperationStatus
Link copied to clipboard
@JsonClass(generateAdapter = true)
data class PositionSettings(@Json(name = "Matching") val matching: PositionSettings.Matching? = null, @Json(name = "Interpolation") val interpolation: PositionSettings.Interpolation? = null)
Link copied to clipboard
@JsonClass(generateAdapter = true)
data class Routing(@Json(name = "route_compute_type") val routeComputeType: Routing.RouteComputeType? = null, val vehicle: Routing.Vehicle? = null, val service: Routing.Service? = null, @Json(name = "fuel_type") val fuelType: Routing.FuelType? = null, @Json(name = "emissionCategory") val emissionCategory: Routing.EmissionCategory? = null, @Json(name = "vehicle_max_speed") val vehicleMaxSpeed: Int? = null, @Json(name = "recompute_iteration") val recomputeIteration: Int? = null, @Json(name = "max_recompute_count") val maxRecomputeCount: Int? = null, @Json(name = "recompute_distance") val recomputeDistance: Int? = null, @Json(name = "load_restrictions") val loadRestrictions: Int? = null, val trailers: Int? = null, @Json(name = "trailer_axles") val trailerAxles: Int? = null, @Json(name = "vehicle_axles") val vehicleAxles: Int? = null, @Json(name = "manufactureYear") val manufactureYear: Int? = null, @Json(name = "avoid_parkways") val avoidParkways: Boolean? = null, @Json(name = "arrive_in_direction") val arriveInDirection: Boolean? = null, @Json(name = "generate_extended_info") val generateExtendedInfo: Boolean? = null, @Json(name = "compute_alternatives") val computeAlternatives: Boolean? = null, @Json(name = "avoid_toll_roads") val avoidTollRoads: Boolean? = null, @Json(name = "avoid_motorways") val avoidMotorways: Boolean? = null, @Json(name = "avoid_special_areas") val avoidSpecialAreas: Boolean? = null, @Json(name = "avoid_unpaved_roads") val avoidUnpavedRoads: Boolean? = null, @Json(name = "avoid_ferries") val avoidFerries: Boolean? = null, @Json(name = "speed_profiles") val speedProfiles: Boolean? = null, @Json(name = "use_traffic") val useTraffic: Boolean? = null, @Json(name = "vehicle_restrictions") val vehicleRestrictions: Routing.VehicleRestrictionsSettings? = null, @Json(name = "turn_preference_setting") val turnPreferenceSetting: Routing.TurnPreferenceSetting? = null, @Json(name = "preferred_road") val preferredRoad: Routing.PreferredRoad? = null)
Link copied to clipboard
@JsonClass(generateAdapter = true)
data class Server(@Json(name = "is_on_server") val isOnServer: Boolean? = null)
Link copied to clipboard
@JsonClass(generateAdapter = true)
data class StorageFolders(@Json(name = "root_path") val rootPath: String? = null, @Json(name = "trusted_root_path") val trustedRootPath: String? = null, @Json(name = "assets_path") val assetsPath: String? = null, @Json(name = "mmiMaps") val mmiMaps: String? = null, @Json(name = "mmiVoices") val mmiVoices: String? = null)
Link copied to clipboard

Use this interface to set mandatory authentication credentials. You have to set the app-key in order to use the APIs contained within this SDK. Some APIs may appear to work without valid credentials but they may stop functioning in the near future when server side configurations change, so please always obtain and use valid credentials.

Link copied to clipboard
@JsonClass(generateAdapter = true)
data class SygicJsonConfig(@Json(name = "Authentication") val authentication: Authentication? = null, @Json(name = "StorageFolders") val storageFolders: StorageFolders? = null, @Json(name = "Server") val server: Server? = null, @Json(name = "MapReaderSettings") val mapReaderSettings: MapReaderSettings? = null, @Json(name = "Online") val online: Online? = null, @Json(name = "Routing") val routing: Routing? = null, @Json(name = "Navigation") val navigation: Navigation? = null, @Json(name = "Audio") val audio: Audio? = null, @Json(name = "Logging") val logging: LoggingSettings? = null, @Json(name = "Map") val mapSettings: MapSettings? = null, @Json(name = "License") val license: License? = null, @Json(name = "Position") val positionSettings: PositionSettings? = null)
Link copied to clipboard
annotation class SygicJsonConfigDsl
Link copied to clipboard

Functions

Link copied to clipboard
inline fun buildJsonConfig(jsonConfig: String? = null, buildJsonConfig: SygicEngine.JsonConfigBuilder.() -> Unit): String