ru.dgis.sdk.androidauto.AndroidAutoMapSession | Android SDK | Urbi Documentation
Android SDK
Maps
Search
Navigation
Urbi Pro
CityLens
On‑Premise
Account

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
MapOptions

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

Returns
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
Surface

The Surface object that will be used for rendering content on top of the map.

width
Int

The width of the surface.

height
Int

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
x
y
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
MapTheme

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

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

Parameters
position
CopyrightPosition

The position of the copyright icon.

Returns