class
ActiveLevelMode
Режим отображения этажного плана.
ActiveLevelMode(index: Long)
Режим отображения этажного плана.
index
val index
Индекс этажа в векторе IIndoorBuilding::levels().
ActivityTracker
val stopChannel
Флаг, активное состояние которого указывает на то, что навигатор необходимо остановить. Если в состоянии Finished навигация прекращается, т.е. движение останавливается или его скорость становится ниже порогового значения, и если такое состояние сохраняется некоторое время, то устанавливается флаг устанавливается в true, в противном случае он имеет значение false.
val stop
Флаг, активное состояние которого указывает на то, что навигатор необходимо остановить. Если в состоянии Finished навигация прекращается, т.е. движение останавливается или его скорость становится ниже порогового значения, и если такое состояние сохраняется некоторое время, то устанавливается флаг устанавливается в true, в противном случае он имеет значение false.
AddEventResult
Результат добавления события (объект события или ошибка).
fun match(event: Function1, error: Function1): T
event
error
fun toString(): String
fun hashCode(): Int
fun equals(other: Any?): Boolean
other
Address
Адрес в виде набора отдельных компонентов.
Address(
drillDown: List<AddressAdmDiv>,
components: List<AddressComponent>,
buildingName: String?,
buildingId: BuildingId?,
postCode: String?,
buildingCode: String?,
fiasCode: String?,
addressComment: String?
)
Адрес в виде набора отдельных компонентов.
drillDown
components
buildingName
buildingId
postCode
buildingCode
fiasCode
addressComment
val drillDown
Набор объектов административного деления, в которых находится описываемый объект.
val components
Полный адрес объекта может содержать несколько отдельных адресных компонент.
val buildingName
Название здания.
val buildingId
Уникальный идентификатор здания.
val postCode
Почтовый индекс.
val buildingCode
Уникальный почтовый код здания.
val fiasCode
Код ФИАС объекта.
Для получения данной информации запросите дополнительную настройку ключа.
val addressComment
Комментарий к адресу. Пример: "301 офис; 9 этаж"
AddressAdmDiv
Объект административного деления.
AddressAdmDiv(type: String, name: String)
Объект административного деления.
type
name
AddressComponent
Компонент адреса: улица, номер дома или словесное описание местоположения.
fun match(
streetAddress: Function1,
number: Function1,
location: Function1
): T
streetAddress
number
location
fun toString(): String
fun hashCode(): Int
fun equals(other: Any?): Boolean
other
AddressLocation
Применяется для компонентов, которые тяжело описать конкретным адресом.
AddressLocation(comment: String)
Применяется для компонентов, которые тяжело описать конкретным адресом.
comment
val comment
Словесное описание местоположения строения.
AddressNumber
В некоторых населённых пунктах обозначается только номер дома, без улицы (например, Краснообск).
AddressNumber(number: String, fiasCode: String?)
В некоторых населённых пунктах обозначается только номер дома, без улицы (например, Краснообск).
number
fiasCode
AddressStreet
Обычный адрес, есть улица и номер дома.
AddressStreet(
street: String,
number: String,
fiasCode: String?
)
Обычный адрес, есть улица и номер дома.
street
number
fiasCode
AddRoadEventButton
Кнопка добавления дорожного события.
AddRoadEventButton(
context: Context,
attrs: AttributeSet? = null,
defStyle: Int = 0
)
Кнопка добавления дорожного события.
context
attrs
defStyle
fun attachToModel(model: AddRoadEventCardModel): Unit
AddRoadEventCard
Карточка добавления дорожного события.
AddRoadEventCard(
context: Context,
attrs: AttributeSet? = null,
defStyle: Int = 0
)
Карточка добавления дорожного события.
context
attrs
defStyle
fun attachToModel(model: AddRoadEventCardModel): Unit
const MAX_DESCRIPTION_LENGTH
AddRoadEventCardModel
Модель карточки добавления дорожного события.
AddRoadEventCardModel(roadEventManager: RoadEventManager, map: Map)
Модель карточки добавления дорожного события.
fun onEventTypeClicked(type: RoadEventType): Unit
Действие при нажатии UI-элемента управления выбором типа события.
fun onLaneClicked(lane: Lane): Unit
Действие при нажатии UI-элемента управления выбором полосы.
fun onDescriptionEntered(description: String): Unit
Действие при вводе описания.
description
fun onSendClicked(): Unit
Действие при нажатии кнопки отправки.
fun close(): Unit
val eventTypeChannel
Выбранный тип события.
val lanesChannel
Выбранные полосы.
val canSelectLanesChannel
Есть ли возможность задать полосы.
val descriptionChannel
Введенное описание.
val markerPositionChannel
Позиция маркера на экране.
val canSendChannel
Есть ли возможность отправить событие.
val resultChannel
Результат отправки события.
AddRoadEventControl
Базовый класс для UI-элементов добавления дорожных событий.
AddRoadEventControl(
context: Context,
attrs: AttributeSet? = null,
defStyle: Int = 0
)
Базовый класс для UI-элементов добавления дорожных событий.
context
attrs
defStyle
fun attachToModel(model: AddRoadEventCardModel): Unit
@CallSuper
fun detachFromModel(): Unit
fun onAttachedToWindow(): Unit
fun onDetachedFromWindow(): Unit
AddRoadEventControls
Набор UI-элементов для добавления дорожных событий. Состоит из карточки с параметрами события, кнопки "Отправить" и маркера, указывающего место добавления события на карте.
val cardHeightChannel
Высота в пикселях, на которую раскрыта карточка.
AddRoadEventMarker
Маркер добавления дорожного события.
AddRoadEventMarker(
context: Context,
attrs: AttributeSet? = null,
defStyle: Int = 0
)
Маркер добавления дорожного события.
context
attrs
defStyle
fun attachToModel(model: AddRoadEventCardModel): Unit
fun detachFromModel(): Unit
Aggregate
Обобщенное описание станции зарядки автомобилей.
Aggregate(
connectorsFree: Short,
connectorsTotal: Short,
isActive: Boolean,
isBusy: Boolean,
power: Short
)
Обобщенное описание станции зарядки автомобилей.
connectorsFree
connectorsTotal
isActive
isBusy
power
val connectorsFree
Количество доступных коннекторов.
val connectorsTotal
Общее количество коннекторов (кроме недоступных).
val isActive
Статус активности. true, если есть хотя бы один доступный, зарезервированный или на зарядке коннектор.
val isBusy
Статус занятости. true, если половина или более коннекторов заняты.
val power
Максимальная мощность из всех коннекторов.
AlternativeRouteSelector
AlternativeRoutesProviderSettings
Настройки поиска альтернативных маршрутов и маршрута лучше.
var alternativeRoutesEnabled
Флаг включения/выключения предложения альтернативных маршрутов. По умолчанию предложение альтернативных маршрутов включено.
var betterRouteEnabled
Флаг включения/выключения предложения маршрута лучше. По умолчанию предложение маршрута лучше включено.
var routeSearchDelay
Задержка перед поиском альтернативных маршрутов при старте поездки по маршруту или после перехода на какой-либо другой маршрут. Должна быть не меньше 5 секунд. По умолчанию 20 секунд.
var onAlternativeRoutesSuggestedRouteSearchDelay
Задержка перед следующим поиском маршрутов сразу после предложения пользователю альтернативных маршрутов. Сбрасывается в случае, если после предложения альтернативных маршрутов пользователь переходит на любой другой маршрут помимо одного из предложенных альтернативных.
var betterRouteTimeCostThreshold
Минимальная разница во времени движения между исходным маршрутом и альтернативным маршрутом, при которой альтернативный маршрут считается маршрутом лучше.
var betterRouteLengthThreshold
Минимальная суммарная длина рёбер маршрута, которые отличаются между исходным маршрутом и альтернативным маршрутом, при которой альтернативный маршрут считается маршрутом лучше.
var routerType
Тип поисковика для поиска альтернативных маршрутов.
Anchor
Точка привязки изображения (0, 0) - левый верхний угол, (1, 1) - правый нижний
Anchor(x: Float = 0.5f, y: Float = 0.5f)
Точка привязки изображения (0, 0) - левый верхний угол, (1, 1) - правый нижний
x
y
AndroidAutoMapSession
Car App session that renders a map on the surface provided by the AppManager.
Supports both shift and scale gestures.
The map's visibility is tied to the session's Lifecycle:
- Map becomes visible during the onStart event.
- Map becomes hidden during the onStop event.
Action.PAN must be included in the Template. Otherwise, the surface won't be available.
Next permissions are already declared in the SDK:
- androidx.car.app.ACCESS_SURFACE
- androidx.car.app.NAVIGATION_TEMPLATES
Important: ensure that SDK context has been initialized before creating instance of this class.
AndroidAutoMapSession(options: MapControllerOptions)
Car App session that renders a map on the surface provided by the AppManager.
Supports both shift and scale gestures.
The map's visibility is tied to the session's Lifecycle:
- Map becomes visible during the onStart event.
- Map becomes hidden during the onStop event.
Action.PAN must be included in the Template. Otherwise, the surface won't be available.
Next permissions are already declared in the SDK:
- androidx.car.app.ACCESS_SURFACE
- androidx.car.app.NAVIGATION_TEMPLATES
Important: ensure that SDK context has been initialized before creating instance of this class.
options
The configuration of the map controller.
fun onSurfaceAvailable(
surface: Surface,
width: Int,
height: Int
): Unit
Provides a surface for rendering additional content on top of the map. This surface can be created and provided before the onMapReady callback is triggered.
surface
The Surface object that will be used for rendering content on top of the map.
width
The width of the surface.
height
The height of the surface.
fun onSurfaceDestroyed(surface: Surface): Unit
Indicates that the surface has been destroyed.
surface
fun onSurfaceClicked(x: Float, y: Float): Unit
Forwards the SurfaceCallback.onClick event.
x
y
fun onSurfaceStableAreaChanged(stableArea: Rect): Unit
Forwards the SurfaceCallback.onStableAreaChanged event.
stableArea
fun onSurfaceVisibleAreaChanged(visibleArea: Rect): Unit
Forwards the SurfaceCallback.onVisibleAreaChanged event.
visibleArea
fun onMapReady(map: Map): Unit
Provides a map when it is successfully initialized.
fun onMapReadyException(exception: Exception): Unit
Provides an exception in case of an error during initialization.
exception
fun setAppearance(appearance: MapAppearance): Unit
Applies the appearance to the map.
This takes effect only after the map has been initialized (i.e., after onMapReady has been called). To set a theme before the map is initialized, use MapControllerOptions.attributes.
fun setCopyrightPosition(position: CopyrightPosition): Unit
Sets the position of the copyright icon on the screen.
Important: This method must be called only after the onCreate state of Lifecycle.
AnimationSettings
Настройки анимаций объектов карты. Применяются для слоев стилей, в которых указан источник модели. Например, такими слоями являются слои с типами "3D model" и "Directional model". Индекс анимации должен быть обязательно указан для анимированной модели.
var animationIndex
Индекс текущей анимации модели. Если null, то используется значение из стилей. Если в стилях значение не задано или задано отрицательное, никакая анимация не проигрывается.
var animationName
Название текущей анимации модели. Если null, то используется значение из стилей. Если в стилях значение не задано, никакая анимация не проигрывается.
var sceneIndex
Индекс текущей сцены модели. Если null, то используется значение из стилей. Если в стилях значение не задано или задано отрицательное, используется сцена по умолчанию, которая определена в самой модели.
var sceneName
Название текущей сцены модели. Если null, то используется значение из стилей. Если в стилях значение не задано, используется сцена по умолчанию, которая определена в самой модели.
var animationRepeatCount
Количество повторений анимации модели. Если null, то используется значение из стилей. Если в стилях значение не задано или задано отрицательное, анимация будет проигрываться бесконечно.
var animationSpeed
Скорость проигрывания анимации модели. Если null, то используется значение из стилей. Значения больше единицы ускоряют проигрывание, меньше замедляют. Если в стилях значение не задано, используется скорость по умолчанию.
ApartmentRange
Диапазон квартир.
ApartmentRange(start: String, end: String? = null)
Диапазон квартир.
start
end
val start
Начало диапазона/хранимое значение. На текущий момент возможны только числовые значения, а квартиры с суффиксами в данных пока отсутствуют.
val end
Окончание диапазона. Если отсутствует, то диапазон состоит из одного значения start. Иначе это арифметическая прогрессия от start до end с шагом 1.
Attribute
Дополнительный атрибут. Пример: { tag: "hotel_room_internet", name: "Бесплатный интернет в номерах" }
Attribute(tag: String, value: String)
Дополнительный атрибут. Пример: { tag: "hotel_room_internet", name: "Бесплатный интернет в номерах" }
tag
value
Attributes
Интерфейс для управления свойствами объекта карты.
Свойства есть только у объектов карты, но можно задавать свойства по умолчанию для всей карты, для стиля и для источника (подробнее см. ISource).
fun setAttributeValue(name: String, value: AttributeValue): Unit
Установка свойства.
fun setAttributeValues(values: Map, attributesToRemove: List<String> = listOf()): Unit
Установка набора свойств. Сначала удаляются свойства attributes_to_remove, затем добавляются свойства values. Если свойство с таким названием уже было добавлено, то оно заменяется.
values
Набор пар "имя":"значение" для добавляемых свойства.
attributesToRemove
Список имён свойств, которые нужно удалить.
fun removeAttribute(name: String): Unit
Удаление свойства.
name
Имя свойства для удаления.
fun getAttributeValue(name: String): AttributeValue
Получение свойства.
AttributeValue
Свойства объектов карты.
AttributeValue()
AttributeValue(boolean: Boolean)
boolean
AttributeValue(number: Double)
number
AttributeValue(integer: Long)
integer
AttributeValue(string: String)
string
AttributeValue(data: ByteArray)
data
AttributeValue(array: List<AttributeValue>)
array
AttributeValue(item: Map)
item
fun match(
empty: Function0<T>,
boolean: Function1,
number: Function1,
integer: Function1,
string: Function1,
data: Function1,
array: Function1,
item: Function1
): T
empty
boolean
number
integer
string
data
array
item
fun toString(): String
fun hashCode(): Int
fun equals(other: Any?): Boolean
other
val isEmpty
val isBoolean
val asBoolean
val isNumber
val asNumber
val isInteger
val asInteger
val isString
val asString
val isData
val asData
val isArray
val asArray
val isObject
val asObject
val value
AudioSettings
Класс для управления звуком.
Все методы могут вызываться из любого потока.
@JvmStatic
fun get(context: Context): AudioSettings?
Настройки аудио. Null, если аудио драйвер недоступен.
AudioStreamReader
fun read(): List<Short>
Описание типа функции обратного вызова, которую вызывает аудиодрайвер для чтения потока аудиоданных.
буфер, в который записывается аудиопоток.
Описание формата данных аудиопотока: Кодировка: LPCM (https://en.wikipedia.org/wiki/Pulse-code_modulation). Количество фреймов в пакете: 1. Количество семплов в фрейме: 1. Формат сэмпла: знаковое целое. Размер сэмпла: 16 бит. Количество каналов: 1. Частота дискретизации (Sample rate): 22050 семплов в секунду.