interface
AudioDriver
Интерфейс для реализации аудио драйвера на платформе.
Methods
fun setReader(reader: AudioStreamReader): Unit
Устанавливает функцию обратного вызова, которую вызывает аудиодрайвер для загрузки данных.<p>Повторный вызов данного метода перезаписывает сохраненную ранее функцию обратного вызова.</p>
Parameters
fun setAvailableCallback(callback: AvailableCallback): Unit
Устанавливает функцию обратного вызова на сигнал о смене доступности аудиоустройства приложению.<p>Повторный вызов данного метода перезаписывает сохраненную ранее функцию обратного вызова.</p>
Parameters
fun play(): Unit
Запускает воспроизведение звукового потока.<p>После вызова этого метода должна начать вызываться функция обратного вызова,
если она установлена в методе set_reader.</p><p>Если функция обратного вызова вернет 0 записанных байт, воспроизведение звукового потока можно остановить.</p>
Returns
BufferedChannel
Extends: ru.dgis.sdk.Channel
Properties
val value
T?
CameraMoveController
Класс, позволяющий управлять положением камеры для нужд анимации<p>Класс должен быть потокобезопасным.</p>
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>
Набор видов значений, которыми умеет управлять данный контроллер.
Returns
fun requestValues(values: EnumSet<FollowValue>): Unit
С помощью этого метода в контроллер сообщается, какие из
предоставляемых им значений используются. Это позволяет освободить
ресурсы, связанные с вычислением неиспользуемых значений. Метод может
вызываться многократно с разными значениями, в этом сл учае актуальным
является последнее из них.
Parameters
fun setNewValuesNotifier(notifier: NewValuesNotifier?): Unit
Установка нотифаера, который оповещает о новых значениях.
Нотифаер нужно сохранить в реализуемом контроллере
Parameters
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
fun onComplete(resultCallback: FutureResultCallback<T>, errorCallback: FutureErrorCallback): Unit
Parameters
fun onResult(executor: Executor, callback: FutureResultCallback<T>): Unit
Parameters
fun onResult(callback: FutureResultCallback<T>): Unit
Parameters
fun onError(executor: Executor, 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
LocationService
Интерфейс, предоставляющий последнюю известную геопозицию.
Properties
val lastLocation
Наилучшая известная на текущий момент геопозиция.
Если известная на текущий момент геопозиция отсутствует, возвращается null.
Возвращаемая геопозиция может быть недостоверной, например являться устаревшей и/или
не соответствовать требуемой точности.
LocationSource
Methods
fun activate(listener: LocationChangeListener): Unit
Parameters
fun deactivate(): Unit
Returns
LogSink
Приемник логирования.
Methods
fun write(message: LogMessage): Unit
Запись в лог.
Метод может вызываться на произвольном потоке.
Parameters
MagneticHeadingSource
Methods
fun activate(listener: MagneticChangeListener): Unit
Parameters
fun deactivate(): Unit
Returns
MapEventSender
Интерфейс, позволяющий отправить событие ввода в карту.
MapGestureRecognitionEngine
Интерфейс для распознавания жестов.
Extends: java.lang.AutoCloseable
Methods
fun resetRecognitionState(): Unit
Returns
fun setMapEventSender(mapEventSender: MapEventSender): Unit
Parameters
MutableChannel
Extends: ru.dgis.sdk.Channel
Methods
MutableStatefulChannel
Extends: ru.dgis.sdk.StatefulChannel
Properties
var value
T
RoadEventActionButtonModel
Модель UI-элемента дорожного события.
Methods
Properties
val icon
Icon?
Иконка.
val name
Название, например, "Подтвердить".
val countChannel
Количество действий, применённых к событию всеми пользователями.
val highlightChannel
Подсвеченность.
SafeLocationListener
Extends: android.location.LocationListener
SearchViewCallback
Интерфейс для установки функций обратного вызова для SearchLayout.
Methods
fun directoryObjectChosen(obj: DirectoryObject): Unit
Метод будет вызван при выборе пользователем результата из поисковой выдачи.
Будет возвращен выбранный DirectoryObject.
Parameters
fun searchCompletedSuccessfully(items: List<DirectoryObject>): Unit
Метод будет вызван при успешном завершении поиска.
Будет возвращен список результатов DirectoryObject, полученный в результате поиска.
Parameters
fun searchCompletedWithException(message: String): Unit
Метод будет вызван, если в процессе поиска возникнет исключение.
Будет возвращено сообщение из исключения.
Parameters
fun searchAborted(): Unit
Метод будет вызван, если поисковая строка была очищена от ввода.
Returns
fun searchClosed(): Unit
Метод будет вызван, если пользователь закрыл поиск стандартным способом: кнопкой закрытия,
рядом с поисковой строкой.
Returns
SearchViewConfigurator
Интерфейс для настройки поиска в SearchLayout.
Methods
fun setSuggestorType(suggestorType: SuggestorType): Unit
Установить тип подсказчика.
По умолчанию: SuggestorType.GENERAL
Parameters
fun setSortingType(sortingType: SortingType): Unit
Установить тип сортировки поисковой выдачи.
По умолчанию: SortingType.BY_RELEVANCE
Parameters
fun setAllowedSearchResultTypes(allowedSearchResultTypes: List<ObjectType>): Unit
Установить типы объектов ObjectType, разрешенные в результате поискового запроса.
По умолчанию: все, кроме ObjectType.ROUTE.
Parameters
fun setAllowedSuggestedTypes(allowedSuggestedTypes: List<SuggestedType>): Unit
Установить типы объектов SuggestedType, разрешенные в поисковых подсказках.
По умолчанию: все, кроме SuggestedType.ROUTE.
Parameters
fun setPageSize(size: Int): Unit
Установить лимит на количество подсказок в suggest'e и результатов в выдаче
Допустимы значения от 1 до 50.
По умолчанию: 10.
Parameters
fun setSpatialRestrictions(spatialRestriction: List?<GeoPoint>): Unit
Установить ограничение области поиска в форме полигона. Первая и последняя точки полигона не обязаны совпадать.
По умолчанию: отсутствует.
Parameters
fun setAreaOfInterest(rect: GeoRect?): Unit
Установить прямоугольную область интереса в географических координатах.
По умолчанию: отсутствует.
Parameters
fun setSearchType(type: SearchType): Unit
Установить тип SearchType поисковика. Возможные варианты и значение по умолчанию
зависят от типа поставки SDK. Подробнее см. SearchType и SearchOptions
Parameters
fun setLocationProvider(provider: LocationService?): Unit
Установить провайдера геопозиции для определения расстояния до объекта в выдаче.
По умолчанию не установлен.
Parameters
SimpleClusterRenderer
Класс для кастомизации внешнего вида кластера в IMapObjectManager.
Methods
fun renderCluster(cluster: SimpleClusterObject): SimpleClusterOptions
Получение маркера для кластера.
Parameters
StatefulChannel
Extends: ru.dgis.sdk.Channel
Properties
val value
T
StyleZoomToTiltRelation
Объект для описания зависимости угла наклона камеры от стилевого уровня масштабирования.
Methods
TouchEventsObserver
Methods
fun onDragEnd(): Unit
Returns