GuidanceEngineOptions

data class GuidanceEngineOptions(    val units: Units = Units.AUTO,     val announcementGenerators: List<AnnouncementGenerator> = ANNOUNCEMENT_GENERATORS,     val instructionDistanceThreshold: Distance = INSTRUCTION_DISTANCE_THRESHOLD,     val language: String? = null)

Options used by GuidanceEngineFactory.

Important: This is a Public Preview API. It may be changed or removed at any time.

Parameters

units

System of measurement used for instructions.

announcementGenerators

List of AnnouncementGenerators used to generate announcements.

instructionDistanceThreshold

Distance used to select the next instructions. Any instructions with a distance less than or equal to this value will be treated as the next instruction.

language

The guidance language as the IETF language tag. Defaults to language of the device.

Constructors

Link copied to clipboard
fun GuidanceEngineOptions(    units: Units = Units.AUTO,     announcementGenerators: List<AnnouncementGenerator> = ANNOUNCEMENT_GENERATORS,     instructionDistanceThreshold: Distance = INSTRUCTION_DISTANCE_THRESHOLD,     language: String? = null)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard
val announcementGenerators: List<AnnouncementGenerator>
Link copied to clipboard
val instructionDistanceThreshold: Distance
Link copied to clipboard
val language: String? = null
Link copied to clipboard
val units: Units