Skip to main content

class

ActiveLevelMode

Режим отображения этажного плана.

ActiveLevelMode(index: Long)

Режим отображения этажного плана.

Parameters

index

Properties

val index

Индекс этажа в векторе IIndoorBuilding::levels().

ActivityTracker

ActivityTracker(
platformContext: Context,
model: Model,
speedBound: Double = 4.2,
timeThreshold: Duration = Duration.ofMilliseconds(20000)
)

Расширение навигатора, которое отслеживает активность пользователя и выдает сигнал, когда пользователь перестал пользоваться навигатором и его можно выключить.

Parameters

platformContext

Контекст.

model

Модель навигатора, состояние которого отслеживается.

speedBound

Верхняя граница скорости в м/с, при превышении которой в состоянии Finished навигатора считается, что навигатор активен, т.е. движение продолжается.

timeThreshold

Время, в течение которого в состоянии Finished навигатора отслеживается скорость движения ниже пороговой для определения состояния неактивности навигатора. Если в течение этого времени скорость движения меньше установленного порога или нет данных о локации и скорости, навигатор считается неактивным.

Properties

val stopChannel

Флаг, активное состояние которого указывает на то, что навигатор необходимо остановить. Если в состоянии Finished навигация прекращается, т.е. движение останавливается или его скорость становится ниже порогового значения, и если такое состояние сохраняется некоторое время, то устанавливается флаг устанавливается в true, в противном случае он имеет значение false.

val stop

Флаг, активное состояние которого указывает на то, что навигатор необходимо остановить. Если в состоянии Finished навигация прекращается, т.е. движение останавливается или его скорость становится ниже порогового значения, и если такое состояние сохраняется некоторое время, то устанавливается флаг устанавливается в true, в противном случае он имеет значение false.

AddEventResult

Результат добавления события (объект события или ошибка).

AddEventResult(event: RoadEvent)
Parameters
AddEventResult(error: AddEventError)
Parameters
Methods
fun match(event: Function1, error: Function1): T
Parameters
fun toString(): String
Returns
fun hashCode(): Int
Returns
fun equals(other: Any?): Boolean
Parameters

other

Returns
Properties

val isEvent

val asEvent

val isError

val asError

val value

Address

Адрес в виде набора отдельных компонентов.

Address(
drillDown: List<AddressAdmDiv>,
components: List<AddressComponent>,
buildingName: String?,
buildingId: BuildingId?,
postCode: String?,
buildingCode: String?,
fiasCode: String?,
addressComment: String?
)

Адрес в виде набора отдельных компонентов.

Parameters

drillDown

components

buildingName

buildingId

postCode

buildingCode

fiasCode

addressComment

Properties

val drillDown

Набор объектов административного деления, в которых находится описываемый объект.

val components

Полный адрес объекта может содержать несколько отдельных адресных компонент.

val buildingName

Название здания.

val buildingId

Уникальный идентификатор здания.

val postCode

Почтовый индекс.

val buildingCode

Уникальный почтовый код здания.

val fiasCode

Код ФИАС объекта.

Для получения данной информации запросите дополнительную настройку ключа.

val addressComment

Комментарий к адресу. Пример: "301 офис; 9 этаж"

AddressAdmDiv

Объект административного деления.

AddressAdmDiv(type: String, name: String)

Объект административного деления.

Parameters

type

name

Properties

val type

Тип административной единицы. Один из следующих:

  • country — страна
  • region — регион (область/край/республика и т.п.)
  • district_area — район области
  • city — город
  • settlement — населённый пункт
  • division — округ
  • district — район
  • living_area — жилмассив, микрорайон
  • place — место

val name

AddressComponent

Компонент адреса: улица, номер дома или словесное описание местоположения.

AddressComponent(streetAddress: AddressStreet)
Parameters

streetAddress

AddressComponent(number: AddressNumber)
Parameters
AddressComponent(location: AddressLocation)
Parameters
Methods
fun match(
streetAddress: Function1,
number: Function1,
location: Function1
): T
Parameters
fun toString(): String
Returns
fun hashCode(): Int
Returns
fun equals(other: Any?): Boolean
Parameters

other

Returns
Properties

val isStreetAddress

val asStreetAddress

val isNumber

val asNumber

val isLocation

val asLocation

val value

AddressLocation

Применяется для компонентов, которые тяжело описать конкретным адресом.

AddressLocation(comment: String)

Применяется для компонентов, которые тяжело описать конкретным адресом.

Parameters

comment

Properties

val comment

Словесное описание местоположения строения.

AddressNumber

В некоторых населённых пунктах обозначается только номер дома, без улицы (например, Краснообск).

AddressNumber(number: String, fiasCode: String?)

В некоторых населённых пунктах обозначается только номер дома, без улицы (например, Краснообск).

Parameters

number

fiasCode

Properties

val number

Номер дома, включая дроби и буквенные обозначения. Возможно, имя собственное, если так принято.

val fiasCode

Код ФИАС улицы.

AddressStreet

Обычный адрес, есть улица и номер дома.

AddressStreet(
street: String,
number: String,
fiasCode: String?
)

Обычный адрес, есть улица и номер дома.

Parameters

street

number

fiasCode

Properties

val street

Название улицы.

val number

Номер дома, включая дроби, корпусы и буквенные обозначения.

val fiasCode

Код ФИАС улицы.

AddRoadEventButton

Кнопка добавления дорожного события.

AddRoadEventButton(
context: Context,
attrs: AttributeSet? = null,
defStyle: Int = 0
)

Кнопка добавления дорожного события.

Parameters

context

attrs

defStyle

Methods
fun attachToModel(model: AddRoadEventCardModel): Unit
Parameters

AddRoadEventCard

Карточка добавления дорожного события.

AddRoadEventCard(
context: Context,
attrs: AttributeSet? = null,
defStyle: Int = 0
)

Карточка добавления дорожного события.

Parameters

context

attrs

defStyle

Methods
fun attachToModel(model: AddRoadEventCardModel): Unit
Parameters
Properties

const MAX_DESCRIPTION_LENGTH

AddRoadEventCardModel

Модель карточки добавления дорожного события.

Implements: java.lang.AutoCloseable
AddRoadEventCardModel(roadEventManager: RoadEventManager, map: Map)

Модель карточки добавления дорожного события.

Parameters

roadEventManager

map

Methods
fun onEventTypeClicked(type: RoadEventType): Unit

Действие при нажатии UI-элемента управления выбором типа события.

Parameters
fun onLaneClicked(lane: Lane): Unit

Действие при нажатии UI-элемента управления выбором полосы.

Parameters

lane

Returns
fun onDescriptionEntered(description: String): Unit

Действие при вводе описания.

Parameters

description

Returns
fun onSendClicked(): Unit

Действие при нажатии кнопки отправки.

Returns
fun close(): Unit
Returns
Properties

val eventTypeChannel

Выбранный тип события.

val lanesChannel

Выбранные полосы.

val canSelectLanesChannel

Есть ли возможность задать полосы.

val descriptionChannel

Введенное описание.

val markerPositionChannel

Позиция маркера на экране.

val canSendChannel

Есть ли возможность отправить событие.

val resultChannel

Результат отправки события.

AddRoadEventControl

Базовый класс для UI-элементов добавления дорожных событий.

Extends: android.widget.FrameLayout
AddRoadEventControl(
context: Context,
attrs: AttributeSet? = null,
defStyle: Int = 0
)

Базовый класс для UI-элементов добавления дорожных событий.

Parameters

context

attrs

defStyle

Methods
fun attachToModel(model: AddRoadEventCardModel): Unit
Parameters
@CallSuper
fun detachFromModel(): Unit
Returns
fun onAttachedToWindow(): Unit
Returns
fun onDetachedFromWindow(): Unit
Returns

AddRoadEventControls

Набор UI-элементов для добавления дорожных событий. Состоит из карточки с параметрами события, кнопки "Отправить" и маркера, указывающего место добавления события на карте.

AddRoadEventControls(
context: Context,
attrs: AttributeSet? = null,
defStyle: Int = 0
)

Набор UI-элементов для добавления дорожных событий. Состоит из карточки с параметрами события, кнопки "Отправить" и маркера, указывающего место добавления события на карте.

Parameters

context

attrs

defStyle

Methods
fun show(): Unit
Returns
fun hide(): Unit
Returns
fun attachToMap(map: Map): Unit
Parameters

map

Returns
fun detachFromMap(map: Map): Unit
Parameters

map

Returns
Properties

val cardHeightChannel

Высота в пикселях, на которую раскрыта карточка.

AddRoadEventMarker

Маркер добавления дорожного события.

AddRoadEventMarker(
context: Context,
attrs: AttributeSet? = null,
defStyle: Int = 0
)

Маркер добавления дорожного события.

Parameters

context

attrs

defStyle

Methods
fun attachToModel(model: AddRoadEventCardModel): Unit
Parameters
fun detachFromModel(): Unit
Returns

Aggregate

Обобщенное описание станции зарядки автомобилей.

Aggregate(
connectorsFree: Short,
connectorsTotal: Short,
isActive: Boolean,
isBusy: Boolean,
power: Short
)

Обобщенное описание станции зарядки автомобилей.

Parameters

connectorsFree

connectorsTotal

isActive

isBusy

power

Properties

val connectorsFree

Количество доступных коннекторов.

val connectorsTotal

Общее количество коннекторов (кроме недоступных).

val isActive

Статус активности. true, если есть хотя бы один доступный, зарезервированный или на зарядке коннектор.

val isBusy

Статус занятости. true, если половина или более коннекторов заняты.

val power

Максимальная мощность из всех коннекторов.

AlternativeRouteSelector

Выбор альтернативного маршрута.

Methods
fun selectAlternativeRoute(trafficRoute: TrafficRoute): Unit

Выбор альтернативного маршрута. Если переданный маршрут не соответствует одному из актуальных альтернативных маршрутов, ничего не происходит. В противном случае соответствующий альтернативный маршрут становится текущим активным маршрутом.

Parameters

trafficRoute

Альтернативный маршрут, который должен быть выбран в качестве текущего активного маршрута.

Returns

AlternativeRoutesProviderSettings

Настройки поиска альтернативных маршрутов и маршрута лучше.

Properties

var alternativeRoutesEnabled

Флаг включения/выключения предложения альтернативных маршрутов. По умолчанию предложение альтернативных маршрутов включено.

var betterRouteEnabled

Флаг включения/выключения предложения маршрута лучше. По умолчанию предложение маршрута лучше включено.

var routeSearchDelay

Задержка перед поиском альтернативных маршрутов при старте поездки по маршруту или после перехода на какой-либо другой маршрут. Должна быть не меньше 5 секунд. По умолчанию 20 секунд.

var betterRouteTimeCostThreshold

Минимальная разница во времени движения между исходным маршрутом и альтернативным маршрутом, при которой альтернативный маршрут считается маршрутом лучше.

var betterRouteLengthThreshold

Минимальная суммарная длина рёбер маршрута, которые отличаются между исходным маршрутом и альтернативным маршрутом, при которой альтернативный маршрут считается маршрутом лучше.

var routerType

Тип поисковика для поиска альтернативных маршрутов.

Anchor

Точка привязки изображения (0, 0) - левый верхний угол, (1, 1) - правый нижний

Anchor(x: Float = 0.5f, y: Float = 0.5f)

Точка привязки изображения (0, 0) - левый верхний угол, (1, 1) - правый нижний

Parameters
Properties

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(mapOptions: MapOptions)

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.

Parameters

mapOptions

The configuration of the map. The following parameters are not utilized:

Methods
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.

Parameters

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.

Returns
fun onSurfaceDestroyed(surface: Surface): Unit

Indicates that the surface has been destroyed.

Parameters

surface

Returns
fun onSurfaceClicked(x: Float, y: Float): Unit

Forwards the SurfaceCallback.onClick event.

Parameters
fun onSurfaceStableAreaChanged(stableArea: Rect): Unit
Parameters

stableArea

Returns
fun onSurfaceVisibleAreaChanged(visibleArea: Rect): Unit
Parameters

visibleArea

Returns
fun onMapReady(map: Map): Unit

Provides a map when it is successfully initialized.

Parameters

map

Returns
fun onMapReadyException(exception: Exception): Unit

Provides an exception in case of an error during initialization.

Parameters

exception

Returns
fun setTheme(theme: MapTheme): Unit

Applies the theme 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 the mapOptions#mapTheme.

Parameters

theme

Theme to be applied. The loadingBackground attribute is not utilized.

Returns

AnimationSettings

Настройки анимаций объектов карты. Применяются для слоев стилей, в которых указан источник модели. Например, такими слоями являются слои с типами "3D model" и "Directional model". Индекс анимации должен быть обязательно указан для анимированной модели.

Properties

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)

Диапазон квартир.

Parameters
Properties

val start

Начало диапазона/хранимое значение. На текущий момент возможны только числовые значения, а квартиры с суффиксами в данных пока отсутствуют.

val end

Окончание диапазона. Если отсутствует, то диапазон состоит из одного значения start. Иначе это арифметическая прогрессия от start до end с шагом 1.

Attribute

Дополнительный атрибут. Пример: { tag: "hotel_room_internet", name: "Бесплатный интернет в номерах" }

Attribute(tag: String, value: String)

Дополнительный атрибут. Пример: { tag: "hotel_room_internet", name: "Бесплатный интернет в номерах" }

Parameters

tag

value

Properties

val tag

Тег.

val value

Значение.

Attributes

Интерфейс для управления свойствами объекта карты.

Свойства есть только у объектов карты, но можно задавать свойства по умолчанию для всей карты, для стиля и для источника (подробнее см. ISource).

Methods
fun setAttributeValue(name: String, value: AttributeValue): Unit

Установка свойства.

Parameters

name

Название свойства.

value

Значение.

Returns
fun setAttributeValues(values: Map, attributesToRemove: List<String> = listOf()): Unit

Установка набора свойств. Сначала удаляются свойства attributes_to_remove, затем добавляются свойства values. Если свойство с таким названием уже было добавлено, то оно заменяется.

Parameters

values

Набор пар "имя":"значение" для добавляемых свойства.

attributesToRemove

Список имён свойств, которые нужно удалить.

Returns
fun removeAttribute(name: String): Unit

Удаление свойства.

Parameters

name

Имя свойства для удаления.

Returns
fun getAttributeValue(name: String): AttributeValue

Получение свойства.

Parameters

name

Имя свойства для получения.

Returns
Properties

val attributeNames

Получение списка свойств.

val changed

Получение канала, уведомляющего об изменении свойств.

AttributeValue

Свойства объектов карты.

AttributeValue()
AttributeValue(boolean: Boolean)
Parameters

boolean

AttributeValue(number: Double)
Parameters

number

AttributeValue(integer: Long)
Parameters

integer

AttributeValue(string: String)
Parameters

string

AttributeValue(data: ByteArray)
Parameters
AttributeValue(array: List<AttributeValue>)
Parameters
AttributeValue(item: Map)
Parameters

item

Methods
fun match(
empty: Function0<T>,
boolean: Function1,
number: Function1,
integer: Function1,
string: Function1,
data: Function1,
array: Function1,
item: Function1
): T
Parameters
fun toString(): String
Returns
fun hashCode(): Int
Returns
fun equals(other: Any?): Boolean
Parameters

other

Returns
Properties

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

Класс для управления звуком.

Все методы могут вызываться из любого потока.

Methods
@JvmStatic
fun get(context: Context): AudioSettings?

Настройки аудио. Null, если аудио драйвер недоступен.

Parameters

context

Returns
Properties

var volume

Уровень громкости звука (0-100).

var mute

Проигрывание звука отключено.

var audioFocusPolicy

Поведения звуков других приложений при запрошенном фокусе.

AudioStreamReader

Methods
fun read(): List<Short>

Описание типа функции обратного вызова, которую вызывает аудиодрайвер для чтения потока аудиоданных.

Returns
List<Short>

буфер, в который записывается аудиопоток.

Описание формата данных аудиопотока: Кодировка: LPCM (https://en.wikipedia.org/wiki/Pulse-code_modulation). Количество фреймов в пакете: 1. Количество семплов в фрейме: 1. Формат сэмпла: знаковое це