VenueNavigationManager (HERE Android Premium SDK)

java.lang.Object
- com.here.android.mpa.venues3d.VenueNavigationManager

```
public class VenueNavigationManager
extends java.lang.Object
```
A navigation manager class that provides guidance advice and information along an indoor route.
IMPORTANT: Venue Navigation Manager is a Beta feature. The related classes are subject to change without notice.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`VenueNavigationManager.NavigationState` The possible states of `VenueNavigationManager`.
`static class`	`VenueNavigationManager.TrackingMode` The mode that is used when map tracking is enabled.
`static class`	`VenueNavigationManager.TrackingTilt` The tilt that is used when map tracking is enabled.
`static interface`	`VenueNavigationManager.VenueNavigationManagerListener` An interface for responding to navigation events sent by the `VenueNavigationManager`.

Field Summary

Fields
Modifier and Type	Field and Description
`static float`	`INVALID_DISTANCE_VALUE` Represents an invalid distance value.
`static long`	`INVALID_TIME_INTERVAL_VALUE` Represents an invalid time interval value.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addListener(VenueNavigationManager.VenueNavigationManagerListener listener)` Adds a listener to the navigation manager.
`boolean`	`areBeepsEnabled()`
`float`	`getAverageSpeed()` Returns the current average speed in the current navigation session.
`VenueManeuver`	`getCurrentManeuver()` Returns the current, upcoming VenueManeuver in the current navigation session.
`float`	`getDistanceFromStart()` Returns the current distance from the start point of navigation.
`float`	`getDistanceToCurrentManeuver()` Returns the remaining distance to the current VenueManeuver.
`float`	`getDistanceToDestination()` Returns the current distance to destination.
`float`	`getDistanceToNextManeuver()` Returns the remaining distance to the next VenueManeuver after the current one.
`float`	`getManeuverZoomDistance()` Gets the distance from the maneuver at which the maneuver zoom is active.
`float`	`getManeuverZoomLevel()` Gets the level to which to zoom in when the maneuver zoom is active.
`VenueNavigationManager.TrackingMode`	`getMapTrackingMode()` Returns map tracking mode.
`VenueNavigationManager.TrackingTilt`	`getMapTrackingTilt()` Returns how the map is tilted when map tracking is enabled.
`VenueNavigationManager.NavigationState`	`getNavigationState()` Gets the current state of the navigation related to the tracked route.
`VenueManeuver`	`getNextManeuver()` Returns the next VenueManeuver after the current VenueManeuver in the current navigation session.
`long`	`getReroutingTimeout()` Returns the time interval in seconds, after which the route will be recalculated in case the user moves far away from the current route.
`long`	`getTimeToArrival()` Returns the number of seconds that remain to travel to the destination, or `VenueNavigationManager.INVALID_TIME_INTERVAL_VALUE` on error.
`float`	`getTravelledDistance()` Returns the travelled distance in the current navigation session.
`Venue`	`getVenue()` Returns the `Venue` object where the navigation is taking place.
`VenueLayerAdapter`	`getVenueLayer()`
`boolean`	`isManeuverZoomEnabled()` Returns wether zooming in on maneuvers is enabled during navigation.
`boolean`	`isMapTrackingEnabled()` Returns `true`, if @code `VenueNavigationManager` is allowed to automatically update map position as navigation progresses, `false` otherwise.
`boolean`	`isPaused()` Returns `true`, if current navigation is paused, `false` otherwise.
`boolean`	`isVibrationEnabled()` Returns whether device vibration is enabled during navigation.
`void`	`pause(boolean value)` When set to `true`, the current navigation will be paused (if any).
`void`	`removeListener(VenueNavigationManager.VenueNavigationManagerListener listener)` Removes a listener from the navigation manager.
`void`	`setBeepsEnabled(boolean enabled)` Enables/disables device beep sounds during navigation.
`void`	`setManeuverZoomDistance(float distance)` Sets the distance from the maneuver at which the maneuver zoom is active.
`void`	`setManeuverZoomEnabled(boolean enabled)` Enables/disables zooming in on maneuvers during navigation.
`void`	`setManeuverZoomLevel(float level)` Sets the level to which to zoom in when the maneuver zoom is active.
`void`	`setMapTrackingEnabled(boolean value)` Allows the `VenueNavigationManager` to automatically update map position as navigation progresses.
`void`	`setMapTrackingMode(VenueNavigationManager.TrackingMode value)` Controls how the map is moved and rotated when map tracking is enabled.
`void`	`setMapTrackingTilt(VenueNavigationManager.TrackingTilt value)` Controls how the map is tilted when map tracking is enabled.
`void`	`setReroutingTimeout(long timeoutInSeconds)` Sets the rerouting timeout in seconds.
`void`	`setVibrationEnabled(boolean enabled)` Enables/disables device vibration during navigation.
`boolean`	`start(LinkingRoute routeSection, CombinedRoute route)` Starts a turn-by-turn navigation session using the specified linking route section.
`boolean`	`start(VenueRoute routeSection, CombinedRoute route)` Starts a turn-by-turn navigation session using the specified venue route section.
`void`	`stop()` Stops a turn-by-turn navigation session started via `VenueNavigationManager.start(VenueRoute, CombinedRoute)`.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - INVALID_DISTANCE_VALUE
```
public static final float INVALID_DISTANCE_VALUE
```
    Represents an invalid distance value.
    
    See Also:
    
    VenueNavigationManager.getDistanceFromStart(), VenueNavigationManager.getDistanceToCurrentManeuver(), VenueNavigationManager.getDistanceToDestination(), VenueNavigationManager.getDistanceToNextManeuver()
  - INVALID_TIME_INTERVAL_VALUE
```
public static final long INVALID_TIME_INTERVAL_VALUE
```
    Represents an invalid time interval value.
    
    See Also:
    
    VenueNavigationManager.getTimeToArrival()
- Method Detail
  - getNavigationState
```
public VenueNavigationManager.NavigationState getNavigationState()
```
    Gets the current state of the navigation related to the tracked route.
    
    Returns:
    
    The current state of the navigation related to the tracked route.
  - isPaused
```
public boolean isPaused()
```
    Returns true, if current navigation is paused, false otherwise.
    
    Returns:
    
    true, if current navigation is paused, false otherwise.
  - pause
```
public void pause(boolean value)
```
    When set to true, the current navigation will be paused (if any). When set to false, the current navigation will resume if previously paused. This has no effect if there is no navigation currently in progress.
    
    Parameters:
    
    value - When set to true, the current navigation will be paused (if any).
  - isMapTrackingEnabled
```
public boolean isMapTrackingEnabled()
```
    Returns true, if @code VenueNavigationManager is allowed to automatically update map position as navigation progresses, false otherwise. By default returns true.
    
    Returns:
    
    true, if @code VenueNavigationManager is allowed to automatically update map position as navigation progresses, false otherwise.
  - setMapTrackingEnabled
```
public void setMapTrackingEnabled(boolean value)
```
    Allows the VenueNavigationManager to automatically update map position as navigation progresses.
    
    Parameters:
    
    value - true to enable map tracking, false otherwise.
  - getMapTrackingTilt
```
public VenueNavigationManager.TrackingTilt getMapTrackingTilt()
```
    Returns how the map is tilted when map tracking is enabled. The default value is VenueNavigationManager.TrackingTilt.TILT3D.
    
    Returns:
    
    How the map is tilted when map tracking is enabled.
  - setMapTrackingTilt
```
public void setMapTrackingTilt(VenueNavigationManager.TrackingTilt value)
```
    Controls how the map is tilted when map tracking is enabled. In 2D and 3D modes, the map will automatically be tilted back appropriately when the tilt value is changed. In Custom mode, the tilt will not be changed. Use custom mode to allow the map to be manually tilted during navigation or to set the tilt to a fixed custom value.
    
    Parameters:
    
    value - VenueNavigationManager.TrackingTilt value to define how the map is tilted when map tracking is enabled.
  - getMapTrackingMode
```
public VenueNavigationManager.TrackingMode getMapTrackingMode()
```
    Returns map tracking mode. The default value is VenueNavigationManager.TrackingMode.FOLLOW.
    
    Returns:
    
    How the map is moved and rotated when map tracking is enabled.
  - setMapTrackingMode
```
public void setMapTrackingMode(VenueNavigationManager.TrackingMode value)
```
    Controls how the map is moved and rotated when map tracking is enabled.
    
    Parameters:
    
    value - VenueNavigationManager.TrackingMode value to define how the map is moved when map tracking is enabled.
  - addListener
```
public void addListener(VenueNavigationManager.VenueNavigationManagerListener listener)
```
    Adds a listener to the navigation manager. The listener must implement the VenueNavigationManager.VenueNavigationManagerListener interface. The listener receives event callbacks containing information about the current navigation session.
    
    Parameters:
    
    listener - The VenueNavigationManager.VenueNavigationManagerListener object to be added.
  - removeListener
```
public void removeListener(VenueNavigationManager.VenueNavigationManagerListener listener)
```
    Removes a listener from the navigation manager. The listener must implement the VenueNavigationManager.VenueNavigationManagerListener interface. The listener receives event callbacks containing information about the current navigation session.
    
    Parameters:
    
    listener - The VenueNavigationManager.VenueNavigationManagerListener object to be removed.
  - start
```
public boolean start(VenueRoute routeSection,
                     CombinedRoute route)
```
    Starts a turn-by-turn navigation session using the specified venue route section.
    
    Parameters:
    
    routeSection - The venue route section to navigate.
    
    route - The route used to navigate.
    
    Returns:
    
    True if started successfully and false otherwise, indicating that the venue route section is invalid or the navigation is already running.
  - start
```
public boolean start(LinkingRoute routeSection,
                     CombinedRoute route)
```
    Starts a turn-by-turn navigation session using the specified linking route section.
    
    Parameters:
    
    routeSection - The linking route section to navigate.
    
    route - The route used to navigate.
    
    Returns:
    
    True if started successfully and false otherwise, indicating that the venue route section is invalid or the navigation is already running.
  - stop
```
public void stop()
```
    Stops a turn-by-turn navigation session started via VenueNavigationManager.start(VenueRoute, CombinedRoute).
  - getVenueLayer
```
public VenueLayerAdapter getVenueLayer()
```
    Returns:
    
    The VenueLayerAdapter object for this instance of navigation manager.
  - getVenue
```
public Venue getVenue()
```
    Returns the Venue object where the navigation is taking place.
    
    Returns:
    
    The Venue object where the navigation is running. If the navigation is started with the LinkingRoute route section, then the returned Venue object will be null.
  - getCurrentManeuver
```
public VenueManeuver getCurrentManeuver()
```
    Returns the current, upcoming VenueManeuver in the current navigation session.
    
    Returns:
    
    The upcoming VenueManeuver. Can be null, if navigation hasn't been started.
  - getNextManeuver
```
public VenueManeuver getNextManeuver()
```
    Returns the next VenueManeuver after the current VenueManeuver in the current navigation session.
    
    Returns:
    
    The next VenueManeuver after the current one. Can be null, if navigation hasn't been started or when the current VenueManeuver is the last one.
    
    See Also:
    
    VenueNavigationManager.getCurrentManeuver()
  - getDistanceToCurrentManeuver
```
public float getDistanceToCurrentManeuver()
```
    Returns the remaining distance to the current VenueManeuver.
    
    Returns:
    
    the distance to the current VenueManeuver in meters. Returns VenueNavigationManager.INVALID_DISTANCE_VALUE if an error occured or if the upcoming maneuver is not available yet.
    
    See Also:
    
    VenueNavigationManager.getCurrentManeuver()
  - getDistanceToNextManeuver
```
public float getDistanceToNextManeuver()
```
    Returns the remaining distance to the next VenueManeuver after the current one.
    
    Returns:
    
    the distance to the next VenueManeuver in meters. Returns VenueNavigationManager.INVALID_DISTANCE_VALUE if an error occurred or if the next maneuver is not available yet.
    
    See Also:
    
    VenueNavigationManager.getNextManeuver()
  - getDistanceToDestination
```
public float getDistanceToDestination()
```
    Returns the current distance to destination.
    
    Returns:
    
    the distance to destination in meters. Returns VenueNavigationManager.INVALID_DISTANCE_VALUE if an error occurred or navigation hasn't been started.
  - getDistanceFromStart
```
public float getDistanceFromStart()
```
    Returns the current distance from the start point of navigation.
    
    Returns:
    
    the distance from the start point in meters. Returns VenueNavigationManager.INVALID_DISTANCE_VALUE if an error occurred or navigation hasn't been started.
  - getTravelledDistance
```
public float getTravelledDistance()
```
    Returns the travelled distance in the current navigation session.
    
    Returns:
    
    travelled distance in meters.
  - getAverageSpeed
```
public float getAverageSpeed()
```
    Returns the current average speed in the current navigation session.
    
    Returns:
    
    average speed in m/s.
  - getTimeToArrival
```
public long getTimeToArrival()
```
    Returns the number of seconds that remain to travel to the destination, or VenueNavigationManager.INVALID_TIME_INTERVAL_VALUE on error.
    
    Returns:
    
    The number of seconds that remain to travel to the destination.
  - getReroutingTimeout
```
public long getReroutingTimeout()
```
    Returns the time interval in seconds, after which the route will be recalculated in case the user moves far away from the current route. When the user significantly deviates from the specified route, a new route will be calculated starting from the user's current position after this timeout expires.
    
    Returns:
    
    The time interval in seconds, after which the route will be recalculated in case the user moves far away from the current route.
    
    See Also:
    
    VenueNavigationManager.setReroutingTimeout(long), VenueNavigationManager.VenueNavigationManagerListener.onRerouteBegin()
  - setReroutingTimeout
```
public void setReroutingTimeout(long timeoutInSeconds)
```
    Sets the rerouting timeout in seconds. This is the time interval in seconds, after which the route will be recalculated in case the user moves far away from the current route
    
    Parameters:
    
    timeoutInSeconds - Time interval in seconds.
    
    See Also:
    
    VenueNavigationManager.getReroutingTimeout()
  - areBeepsEnabled
```
public boolean areBeepsEnabled()
```
    Returns:
    
    Whether beep sounds are enabled during navigation.
    
    See Also:
    
    VenueNavigationManager.setBeepsEnabled(boolean)
    
    Note:
    
    Beep sounds are enabled by default
  - setBeepsEnabled
```
public void setBeepsEnabled(boolean enabled)
```
    Enables/disables device beep sounds during navigation. If enabled, these will be triggered on specific navigation events, like maneuver change, rerouting, reaching destination, etc.
    
    Parameters:
    
    enabled - Flag to indicate the enable state of device beep sounds.
    
    See Also:
    
    VenueNavigationManager.areBeepsEnabled()
  - isVibrationEnabled
```
public boolean isVibrationEnabled()
```
    Returns whether device vibration is enabled during navigation.
    
    Returns:
    
    true if device vibration is enabled during navigation.
    
    See Also:
    
    VenueNavigationManager.setVibrationEnabled(boolean)
    
    Note:
    
    Vibration is enabled by default, unless android.permission.VIBRATE is not granted in the AndroidManifest.xml file of your application.
  - setVibrationEnabled
```
public void setVibrationEnabled(boolean enabled)
```
    Enables/disables device vibration during navigation. If enabled, vibration will be triggered on specific navigation events, like maneuver change, rerouting, reaching destination, etc.
    
    Parameters:
    
    enabled - Flag to indicate the enable state of device vibration.
    
    Throws:
    
    java.security.AccessControlException - in case when there are no android.permission.VIBRATE permission granted.
    
    Note:
    
    In order to actually enable vibration, you have to add android.permission.VIBRATE permission to AndroidManifest.xml file of your application.
  - isManeuverZoomEnabled
```
public boolean isManeuverZoomEnabled()
```
    Returns wether zooming in on maneuvers is enabled during navigation.
    
    Returns:
    
    true if zooming in on maneuvers is enabled during navigation, and false otherwise.
  - setManeuverZoomEnabled
```
public void setManeuverZoomEnabled(boolean enabled)
```
    Enables/disables zooming in on maneuvers during navigation.
    
    Parameters:
    
    enabled - Flag to indicate the enable state of maneuver zooming.
  - getManeuverZoomDistance
```
public float getManeuverZoomDistance()
```
    Gets the distance from the maneuver at which the maneuver zoom is active.
    
    Returns:
    
    The distance to the maneuver in meters.
  - setManeuverZoomDistance
```
public void setManeuverZoomDistance(float distance)
```
    Sets the distance from the maneuver at which the maneuver zoom is active.
    
    Parameters:
    
    distance - The distance to the maneuver in meters.
  - getManeuverZoomLevel
```
public float getManeuverZoomLevel()
```
    Gets the level to which to zoom in when the maneuver zoom is active.
    
    Returns:
    
    The zoom level.
  - setManeuverZoomLevel
```
public void setManeuverZoomLevel(float level)
```
    Sets the level to which to zoom in when the maneuver zoom is active.
    
    Parameters:
    
    level - The zoom level.

Class VenueNavigationManager

Nested Class Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

INVALID_DISTANCE_VALUE

INVALID_TIME_INTERVAL_VALUE

Method Detail

getNavigationState

isPaused

pause

isMapTrackingEnabled

setMapTrackingEnabled

getMapTrackingTilt

setMapTrackingTilt

getMapTrackingMode

setMapTrackingMode

addListener

removeListener

start

start

stop

getVenueLayer

getVenue

getCurrentManeuver

getNextManeuver

getDistanceToCurrentManeuver

getDistanceToNextManeuver

getDistanceToDestination

getDistanceFromStart

getTravelledDistance

getAverageSpeed

getTimeToArrival

getReroutingTimeout

setReroutingTimeout

areBeepsEnabled

setBeepsEnabled

isVibrationEnabled

setVibrationEnabled

isManeuverZoomEnabled

setManeuverZoomEnabled

getManeuverZoomDistance

setManeuverZoomDistance

getManeuverZoomLevel

setManeuverZoomLevel