Перейти к основному содержимому

interface

AudioDriver

Интерфейс для реализации аудио драйвера на платформе.

Methods
fun setReader(reader: AudioStreamReader): Unit

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

Повторный вызов данного метода перезаписывает сохраненную ранее функцию обратного вызова.

Parameters
fun setAvailableCallback(callback: AvailableCallback): Unit

Устанавливает функцию обратного вызова на сигнал о смене доступности аудиоустройства приложению.

Повторный вызов данного метода перезаписывает сохраненную ранее функцию обратного вызова.

Parameters

callback

Returns
fun available(): Boolean

Доступно ли на текущий момент аудиоустройство приложению.

Returns
fun play(): Unit

Запускает воспроизведение звукового потока.

После вызова этого метода должна начать вызываться функция обратного вызова, если она установлена в методе set_reader.

Если функция обратного вызова вернет 0 записанных байт, воспроизведение звукового потока можно остановить.

Returns

BufferedChannel

Properties

val value

T?

CameraMoveController

Класс, позволяющий управлять положением камеры для нужд анимации

Класс должен быть потокобезопасным.

Methods
fun position(time: Duration): CameraPosition

Позиция области просмотра в конкретный момент времени. Контроллер должен быть готов к тому, что время анимации будет передаваться в любом порядке, не обязательно в неубывающем.

Parameters

time

Время от начала анимации в миллисекундах.

Returns
CameraPosition

Положение области просмотра в указанный момент времени.

fun animationTime(): Duration

Продолжительность анимации в миллисекундах.

Returns
Duration

Продолжительность анимации в миллисекундах.

Channel

Methods
@CheckResult
fun connect(executor: Executor, callback: ChannelCallback<T>): AutoCloseable
Parameters
@CheckResult
fun connect(callback: ChannelCallback<T>): AutoCloseable
Parameters

CustomFollowController

Интерфейс, который можно реализовать на платформе для создания собственного контроллера слежения за параметрами Для добавления контроллера в камеру, нужно реализовать этот интерфейс и создать объект FollowController'а передав в качестве аргумента объект, реализующий данные интерфейс.

Methods
fun availableValues(): EnumSet<FollowValue>

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

fun requestValues(values: EnumSet<FollowValue>): Unit

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

Parameters
fun setNewValuesNotifier(notifier: NewValuesNotifier?): Unit

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

Parameters

notifier

Returns
fun coordinates(): GeoPoint?

Географические координаты. Метод вызывается только после вызова request_values с соответствующими параметрами.

Returns
fun bearing(): Bearing?

Направление. Метод вызывается только после вызова request_values с соответствующими параметрами.

Returns
fun tilt(): Tilt?

Наклон карты. Метод вызывается только после вызова request_values с соответствующими параметрами.

Returns
fun styleZoom(): StyleZoom?

Стилевой уровень масштабирования карты. Метод вызывается только после вызова request_values с соответствующими параметрами.

Returns

Future

Extends: java.lang.AutoCloseable
Methods
fun onComplete(
executor: Executor,
resultCallback: FutureResultCallback<T>,
errorCallback: FutureErrorCallback
): Unit
Parameters

executor

resultCallback

errorCallback

Returns
fun onComplete(resultCallback: FutureResultCallback<T>, errorCallback: FutureErrorCallback): Unit
Parameters

resultCallback

errorCallback

Returns
fun onResult(executor: Executor, callback: FutureResultCallback<T>): Unit
Parameters
fun onResult(callback: FutureResultCallback<T>): Unit
Parameters
fun onError(executor: Executor, callback: FutureErrorCallback): Unit
Parameters

executor

callback

Returns
fun onError(callback: FutureErrorCallback): Unit
Parameters
suspend fun await(): T
Returns
T

HttpClient

Интерфейс для реализации сетевого клиента на платформе.

Methods
fun sendRequest(request: HttpRequest, callback: HttpResponseCallback): Unit

Метод для обработки запроса из SDK.

Parameters

request

запрос для отправки.

callback

объект с обратными вызовами для отправки и получения данных.

Returns

LocationChangeListener

Интерфейс для сообщения об изменении геопозиции и её доступности.

Methods
fun onLocationChanged(locations: Array<Location>): Unit
Parameters

locations

Returns
fun onAvailabilityChanged(availability: Boolean): Unit
Parameters

availability

Returns

LocationService

Интерфейс, предоставляющий последнюю известную геопозицию.

Properties

val lastLocation

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

LocationSource

Methods
fun activate(listener: LocationChangeListener): Unit
Parameters
fun deactivate(): Unit
Returns
fun setDesiredAccuracy(accuracy: DesiredAccuracy): Unit
Parameters

accuracy

Returns

LogSink

Приемник логирования.

Methods
fun write(message: LogMessage): Unit

Запись в лог. Метод может вызываться на произвольном потоке.

Parameters

message

Returns

MagneticHeadingSource

Methods
fun activate(listener: MagneticChangeListener): Unit
Parameters
fun deactivate(): Unit
Returns

MapEventSender

Интерфейс, позволяющий отправить событие ввода в карту.

Methods
fun sendEvent(event: Event): Unit
Parameters

event

Returns

MapGestureRecognitionEngine

Интерфейс для распознавания жестов.

Extends: java.lang.AutoCloseable
Methods
fun processMotionEvent(event: MotionEvent): Boolean
Parameters

event

Returns
fun resetRecognitionState(): Unit
Returns
fun onDevicePpiChanged(devicePpi: DevicePpi): Unit
Parameters

devicePpi

Returns
fun setMapEventSender(mapEventSender: MapEventSender): Unit
Parameters

mapEventSender

Returns

MutableChannel

Methods
fun send(value: T): Unit
Parameters

value

T
Returns

MutableStatefulChannel

Properties

var value

T

RoadEventActionButtonModel

Модель UI-элемента дорожного события.

Methods
fun onClicked(): Unit

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

Returns
Properties

val icon

Icon?

Иконка.

val name

Название, например, "Подтвердить".

val countChannel

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

val highlightChannel

Подсвеченность.

SafeLocationListener

Extends: android.location.LocationListener
Methods
fun onProviderDisabled(provider: String): Unit
Parameters

provider

Returns
fun onProviderEnabled(provider: String): Unit
Parameters

provider

Returns
fun onStatusChanged(
provider: String,
status: Int,
extras: Bundle
): Unit
Parameters

provider

status

extras

Returns

SearchViewCallback

Интерфейс для установки функций обратного вызова для SearchLayout.

Methods
fun directoryObjectChosen(obj: DirectoryObject): Unit

Метод будет вызван при выборе пользователем результата из поисковой выдачи. Будет возвращен выбранный DirectoryObject.

Parameters
fun searchCompletedSuccessfully(items: List<DirectoryObject>): Unit

Метод будет вызван при успешном завершении поиска. Будет возвращен список результатов DirectoryObject, полученный в результате поиска.

Parameters
fun searchCompletedWithException(message: String): Unit

Метод будет вызван, если в процессе поиска возникнет исключение. Будет возвращено сообщение из исключения.

Parameters

message

Returns
fun searchAborted(): Unit

Метод будет вызван, если поисковая строка была очищена от ввода.

Returns
fun searchClosed(): Unit

Метод будет вызван, если пользователь закрыл поиск стандартным способом: кнопкой закрытия, рядом с поисковой строкой.

Returns

SearchViewConfigurator

Интерфейс для настройки поиска в SearchLayout.

Methods
fun setSuggestorType(suggestorType: SuggestorType): Unit

Установить тип подсказчика. По умолчанию: SuggestorType.OBJECT

Parameters

suggestorType

Returns
fun setSortingType(sortingType: SortingType): Unit

Установить тип сортировки поисковой выдачи. По умолчанию: SortingType.BY_RELEVANCE

Parameters

sortingType

Returns
fun setAllowedSearchResultTypes(allowedSearchResultTypes: List<ObjectType>): Unit

Установить типы объектов ObjectType, разрешенные в результате поискового запроса. По умолчанию: все, кроме ObjectType.ROUTE.

Parameters

allowedSearchResultTypes

Returns
fun setAllowedSuggestedTypes(allowedSuggestedTypes: List<SuggestedType>): Unit

Установить типы объектов SuggestedType, разрешенные в поисковых подсказках. По умолчанию: все, кроме SuggestedType.ROUTE.

Parameters

allowedSuggestedTypes

Returns
fun setPageSize(size: Int): Unit

Установить лимит на количество подсказок в suggest'e и результатов в выдаче Допустимы значения от 1 до 50. По умолчанию: 10.

Parameters

size

Returns
fun setSpatialRestrictions(spatialRestriction: List?<GeoPoint>): Unit

Установить ограничение области поиска в форме полигона. Первая и последняя точки полигона не обязаны совпадать. По умолчанию: отсутствует.

Parameters

spatialRestriction

Returns
fun setAreaOfInterest(rect: GeoRect?): Unit

Установить прямоугольную область интереса в географических координатах. По умолчанию: отсутствует.

Parameters

rect

Returns
fun setSearchType(type: SearchType): Unit

Установить тип SearchType поисковика. Возможные варианты и значение по умолчанию зависят от типа поставки SDK. Подробнее см. SearchType и SearchOptions

Parameters

type

Returns
fun setLocationProvider(provider: LocationService?): Unit

Установить провайдера геопозиции для определения расстояния до объекта в выдаче. По умолчанию не установлен.

Parameters

provider

Returns

SimpleClusterRenderer

Класс для кастомизации внешнего вида кластера в IMapObjectManager.

Methods
fun renderCluster(cluster: SimpleClusterObject): SimpleClusterOptions

Получение маркера для кластера.

Parameters

cluster

Объект кластера.

Returns
SimpleClusterOptions

Объект маркера кластера.

SpeechRecognizer

Methods
fun recognize(onResult: Function1, onError: Function1): Unit

Запускает распознавание речи и обрабатывает результаты через функции обратного вызова.

Parameters

onResult

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

onError

Функция обратного вызова, получающая Exception при ошибке распознавания. Вызывается для обработки различных ошибок в процессе распознавания.

Returns

StatefulChannel

Properties

val value

T

StyleZoomToTiltRelation

Объект для описания зависимости угла наклона камеры от стилевого уровня масштабирования.

Methods
fun styleZoomToTilt(styleZoom: StyleZoom): Tilt

Получение наклона камеры по стилевому уровню масштабирования.

Parameters

styleZoom

Стилевой уровень масштабирования.

Returns
Tilt

угол наклона камеры

Функция должна быть непрерывной и монотонной.

Функция должна быть потокобезопасной.

TouchEventsObserver

Methods
fun onTap(point: ScreenPoint): Unit
Parameters

point

Returns
fun onLongTouch(point: ScreenPoint): Unit
Parameters

point

Returns
fun onDragBegin(data: DragBeginData): Unit
Parameters
fun onDragMove(point: ScreenPoint): Unit
Parameters

point

Returns
fun onDragEnd(): Unit
Returns