Navmii Turn-by-Turn SDK
Write yourself a navigation system in Android
Classes | Public Member Functions | List of all members
navmiisdk.NavmiiSettings Class Reference

Navigation settings object. More...

Classes

enum  DistanceUnits
 Distance units. More...
 
enum  MapHorizonPosition
 Map horizon position. More...
 
enum  RouteOptimization
 Route optimization. More...
 
enum  SpeedCameraAlertMode
 Speed cameras alert mode. More...
 
class  VehicleParameters
 Vehicle parameters. More...
 
enum  VehicleType
 Vehicle type. More...
 
class  VoicePack
 Voice pack. More...
 

Public Member Functions

native void save ()
 Save settings. More...
 
void setMapHorizonPosition (MapHorizonPosition value)
 Sets map horizon position. More...
 
MapHorizonPosition getMapHorizonPosition ()
 Returns map horizon value. More...
 
native void setWalkingCursorRatio (float value)
 Sets walking cursor ratio. More...
 
native float getWalkingCursorRatio ()
 Returns walking cursor ratio. More...
 
native void setDriving2DCursorRatio (float value)
 Sets driving in 2D cursor ratio. More...
 
native float getDriving2DCursorRatio ()
 Returns driving in 2D cursor ratio. More...
 
native void setDriving3DCursorRatio (float value)
 Sets driving in 3D cursor ratio. More...
 
native float getDriving3DCursorRatio ()
 Returns driving in 3D cursor ratio. More...
 
native void setRouteLineColour (int color)
 Sets route color. More...
 
native int getRouteLineColour ()
 Returns route color. More...
 
native void setDirectionArrowColor (int fillColor, int borderColor)
 Sets direction arrow color. More...
 
Languages
native void setLanguage (String value)
 Changes sdk language. More...
 
native String getLanguage ()
 Returns current sdk language. More...
 
Volume control
native void setMutedEnabled (boolean value)
 Changes muted mode. More...
 
native boolean getMutedEnabled ()
 Returns is muted. More...
 
native void setVolume (float volume)
 Changes voices and notifications volume. More...
 
native float getVolume ()
 Returns current volume. More...
 
Auto zoom
native void setAutozoomEnabled (boolean value)
 Changes auto zoom. More...
 
native boolean getAutozoomEnabled ()
 Returns auto zoom. More...
 
native float getAutozoomResumeInterval ()
 
native void setAutozoomResumeInterval (float autozoomResumeInterval)
 
native void setAutozoomAtDirections (boolean value)
 Changes auto zoom at directions state. More...
 
native boolean getAutozoomAtDirections ()
 Returns auto zoom at directions state. More...
 
native void setAutozoomOnSpeed (boolean value)
 Changes auto zoom on speed state. More...
 
native boolean getAutozoomOnSpeed ()
 Returns auto zoom on speed state. More...
 
Day/Night mode and brightness
native void setAutoDayNightEnabled (boolean value)
 Changes auto day/night mode state. More...
 
native boolean getAutoDayNightEnabled ()
 Returns auto day/night mode state. More...
 
native void setNightModeEnabled (boolean value)
 Changes day/night mode. More...
 
native boolean getNightModeEnabled ()
 Returns day/night mode state. More...
 
Traffic
native void setTrafficEnabled (boolean value)
 TODO. More...
 
native boolean getTrafficEnabled ()
 TODO. More...
 
native void setDrawTrafficOnMap (boolean value)
 Changes traffic on map drawing state. More...
 
native boolean getDrawTrafficOnMap ()
 Returns draw traffic on map state. More...
 
native void setUseTrafficInRouting (boolean value)
 Changes traffic in routing using state. More...
 
native boolean getUseTrafficInRouting ()
 Returns traffic in routing using state. More...
 
Draw items on map
native void setDrawPositionOnMapEnabled (boolean value)
 Changes position on map drawing. More...
 
native boolean getDrawPositionOnMapEnabled ()
 Returns is position drawing on map. More...
 
native void setDrawEventsOnMapEnabled (boolean value)
 Changes events on map drawing. More...
 
native boolean getDrawEventsOnMapEnabled ()
 Returns is events drawing on map. More...
 
native void setDrawUsersOnMapEnabled (boolean value)
 Changes users on map drawing. More...
 
native boolean getDrawUsersOnMapEnabled ()
 Returns is users drawing on map. More...
 
native void setDrawOverlaysEnabled (boolean value)
 Changes overlays (waypoints, start, finish) drawing on map. More...
 
native boolean getDrawOverlaysEnabled ()
 Returns is overlays drawing on map. More...
 
native void setDrawSpeedCameraEnabled (boolean value)
 Changes speed camera drawing on map. More...
 
native boolean getDrawSpeedCameraEnabled ()
 Returns is speed camera drawing on map. More...
 
native void setDrawPoiOnMapEnabled (boolean value)
 Changes POI on map drawing. More...
 
native boolean getDrawPoiOnMapEnabled ()
 Returns is POI drawing on map. More...
 
native POICategory[] getPoiCategories ()
 Returns POI Categories list. More...
 
native POICategory[] getSpeedCameraCategories ()
 Returns speed camera POI Categories list. More...
 
native POICategory[] getRoadEventCategories ()
 Returns road event POI Categories list. More...
 
native boolean getPoiCategoryExist (int id)
 Returns is POI category exist. More...
 
native void setPoiCategoryDisplayedOnMap (int id, boolean value)
 Sets POI category displayed on map. More...
 
native boolean getPoiCategoryDisplayedOnMap (int id)
 Returns is POI category displayed on map. More...
 
native void setPoiCategoriesDisplayedOnMap (int[] ids, boolean value)
 Sets POI categories displayed on map. More...
 
native android.graphics.Bitmap getPoiCategoryIcon (int id)
 Returns POI category UI image. More...
 
native String getPoiCategoryName (int id)
 Returns POI category name. More...
 
native void setPoiCategoryName (int id, String name)
 Sets POI category name. More...
 
native int getPoiCategoryZoomLevel (int id)
 Returns POI category zoom level. More...
 
native void setPoiCategoryZoomLevel (int id, int zoomLevel)
 Sets POI category zoom level. More...
 

Distance units

DistanceUnits getDistanceUnits ()
 Returns current distance units. More...
 
void setDistanceUnits (DistanceUnits value)
 Changes current distance units. More...
 

Voices

VoicePack[] getVoicePacks ()
 Returns voices pack list. More...
 
native void selectVoicePack (int index)
 Select voice pack. More...
 
native int getSelectedVoicePackIndex ()
 Returns selected voice pack index. More...
 
native void setVoiceGuidanceInBackgroundEnabled (boolean value)
 Enables voice guidance in background. More...
 
native boolean getVoiceGuidanceInBackgroundEnabled ()
 Returns voice guidance in background state. More...
 

Speed cameras

native void setSpeedCameraBeepSoundEnabled (boolean value)
 Sets speed camera beep sound state. More...
 
native boolean getSpeedCameraBeepSoundEnabled ()
 Returns speed camera beep sound state. More...
 
native void setSpeedCameraVoiceWarningEnabled (boolean value)
 Sets speed camera voice warning state. More...
 
native boolean getSpeedCameraVoiceWarningEnabled ()
 Returns voice warning state. More...
 
native void setSpeedCameraAlertDistance (float value)
 Sets speed camera alert distance. More...
 
native float getSpeedCameraAlertDistance ()
 Returns speed camera alert distance in meters. More...
 
void setSpeedCameraAlertMode (SpeedCameraAlertMode value)
 Sets speed camera alerting mode. More...
 
SpeedCameraAlertMode getSpeedCameraAlertMode ()
 Returns current speed camera alert mode. More...
 
native void setAlertOnSpeedingEnabled (boolean value)
 Enables alert on speeding. More...
 
native boolean getAlertOnSpeedingEnabled ()
 Returns alert on speeding state. More...
 

Route parameters

native void setAvoidTollRoads (boolean value)
 Sets avoid toll roads state. More...
 
native boolean getAvoidTollRoads ()
 Returns avoid toll roads state. More...
 
native void setAvoidMotorways (boolean value)
 Sets avoid motorways state. More...
 
native boolean getAvoidMotorways ()
 Returns avoid toll motorways. More...
 
native void setWalkingMode (boolean value)
 Changes walking mode state. More...
 
native boolean getWalkingMode ()
 Returns walking mode state. More...
 
void setVehicleType (VehicleType value)
 Sets vehicle type. More...
 
VehicleType getVehicleType ()
 Returns vehicle type. More...
 
void setRouteOptimization (RouteOptimization value)
 Sets route optimization type. More...
 
RouteOptimization getRouteOptimization ()
 Returns route optimization type. More...
 
void setVehicleParameters (VehicleParameters parameters)
 
VehicleParameters getVehicleParameters ()
 

Detailed Description

Navigation settings object.

Member Function Documentation

native void navmiisdk.NavmiiSettings.save ( )

Save settings.

Settings will automaticaly saved after route calculation and on NavmiiControl.destroy()

DistanceUnits navmiisdk.NavmiiSettings.getDistanceUnits ( )

Returns current distance units.

void navmiisdk.NavmiiSettings.setDistanceUnits ( DistanceUnits  value)

Changes current distance units.

native void navmiisdk.NavmiiSettings.setLanguage ( String  value)

Changes sdk language.

native String navmiisdk.NavmiiSettings.getLanguage ( )

Returns current sdk language.

native void navmiisdk.NavmiiSettings.setMutedEnabled ( boolean  value)

Changes muted mode.

native boolean navmiisdk.NavmiiSettings.getMutedEnabled ( )

Returns is muted.

native void navmiisdk.NavmiiSettings.setVolume ( float  volume)

Changes voices and notifications volume.

Parameters
volumeNew value in 0..1
native float navmiisdk.NavmiiSettings.getVolume ( )

Returns current volume.

VoicePack [] navmiisdk.NavmiiSettings.getVoicePacks ( )

Returns voices pack list.

native void navmiisdk.NavmiiSettings.selectVoicePack ( int  index)

Select voice pack.

native int navmiisdk.NavmiiSettings.getSelectedVoicePackIndex ( )

Returns selected voice pack index.

native void navmiisdk.NavmiiSettings.setVoiceGuidanceInBackgroundEnabled ( boolean  value)

Enables voice guidance in background.

Parameters
valuetrue - enabled, false - disabled
native boolean navmiisdk.NavmiiSettings.getVoiceGuidanceInBackgroundEnabled ( )

Returns voice guidance in background state.

native void navmiisdk.NavmiiSettings.setSpeedCameraBeepSoundEnabled ( boolean  value)

Sets speed camera beep sound state.

Parameters
valueTrue - beep is enabled, false beep is disabled
native boolean navmiisdk.NavmiiSettings.getSpeedCameraBeepSoundEnabled ( )

Returns speed camera beep sound state.

native void navmiisdk.NavmiiSettings.setSpeedCameraVoiceWarningEnabled ( boolean  value)

Sets speed camera voice warning state.

Parameters
valueTrue - voice warning is enabled, false voice warning is disabled
native boolean navmiisdk.NavmiiSettings.getSpeedCameraVoiceWarningEnabled ( )

Returns voice warning state.

native void navmiisdk.NavmiiSettings.setSpeedCameraAlertDistance ( float  value)

Sets speed camera alert distance.

Parameters
valueDistance in meters
native float navmiisdk.NavmiiSettings.getSpeedCameraAlertDistance ( )

Returns speed camera alert distance in meters.

void navmiisdk.NavmiiSettings.setSpeedCameraAlertMode ( SpeedCameraAlertMode  value)

Sets speed camera alerting mode.

Parameters
valueNew value
SpeedCameraAlertMode navmiisdk.NavmiiSettings.getSpeedCameraAlertMode ( )

Returns current speed camera alert mode.

native void navmiisdk.NavmiiSettings.setAlertOnSpeedingEnabled ( boolean  value)

Enables alert on speeding.

Parameters
valuetrue - enabled, false - disabled
native boolean navmiisdk.NavmiiSettings.getAlertOnSpeedingEnabled ( )

Returns alert on speeding state.

native void navmiisdk.NavmiiSettings.setAutozoomEnabled ( boolean  value)

Changes auto zoom.

Parameters
valuetrue - enabled, false - disabled
native boolean navmiisdk.NavmiiSettings.getAutozoomEnabled ( )

Returns auto zoom.

native void navmiisdk.NavmiiSettings.setAutozoomAtDirections ( boolean  value)

Changes auto zoom at directions state.

Parameters
valuetrue - enabled, false - disabled
native boolean navmiisdk.NavmiiSettings.getAutozoomAtDirections ( )

Returns auto zoom at directions state.

native void navmiisdk.NavmiiSettings.setAutozoomOnSpeed ( boolean  value)

Changes auto zoom on speed state.

Parameters
valuetrue - enabled, false - disabled
native boolean navmiisdk.NavmiiSettings.getAutozoomOnSpeed ( )

Returns auto zoom on speed state.

native void navmiisdk.NavmiiSettings.setAutoDayNightEnabled ( boolean  value)

Changes auto day/night mode state.

Parameters
valueTrue - enabled, false - disabled
native boolean navmiisdk.NavmiiSettings.getAutoDayNightEnabled ( )

Returns auto day/night mode state.

native void navmiisdk.NavmiiSettings.setNightModeEnabled ( boolean  value)

Changes day/night mode.

Parameters
valueTrue - night mode, False - day mode
native boolean navmiisdk.NavmiiSettings.getNightModeEnabled ( )

Returns day/night mode state.

void navmiisdk.NavmiiSettings.setMapHorizonPosition ( MapHorizonPosition  value)

Sets map horizon position.

Parameters
valueMap horizon value
MapHorizonPosition navmiisdk.NavmiiSettings.getMapHorizonPosition ( )

Returns map horizon value.

native void navmiisdk.NavmiiSettings.setWalkingCursorRatio ( float  value)

Sets walking cursor ratio.

Parameters
valueCursor position at the screen in normalized coords 0 - top, 1 - bottom.
native float navmiisdk.NavmiiSettings.getWalkingCursorRatio ( )

Returns walking cursor ratio.

native void navmiisdk.NavmiiSettings.setDriving2DCursorRatio ( float  value)

Sets driving in 2D cursor ratio.

Parameters
valueCursor position at the screen in normalized coords 0 - top, 1 - bottom.
native float navmiisdk.NavmiiSettings.getDriving2DCursorRatio ( )

Returns driving in 2D cursor ratio.

native void navmiisdk.NavmiiSettings.setDriving3DCursorRatio ( float  value)

Sets driving in 3D cursor ratio.

Parameters
valueCursor position at the screen in normalized coords 0 - top, 1 - bottom.
native float navmiisdk.NavmiiSettings.getDriving3DCursorRatio ( )

Returns driving in 3D cursor ratio.

native void navmiisdk.NavmiiSettings.setTrafficEnabled ( boolean  value)

TODO.

native boolean navmiisdk.NavmiiSettings.getTrafficEnabled ( )

TODO.

native void navmiisdk.NavmiiSettings.setDrawTrafficOnMap ( boolean  value)

Changes traffic on map drawing state.

Parameters
valueTrue - enables, false - disabled
native boolean navmiisdk.NavmiiSettings.getDrawTrafficOnMap ( )

Returns draw traffic on map state.

native void navmiisdk.NavmiiSettings.setUseTrafficInRouting ( boolean  value)

Changes traffic in routing using state.

Parameters
valueTrue - enables, false - disabled
native boolean navmiisdk.NavmiiSettings.getUseTrafficInRouting ( )

Returns traffic in routing using state.

native void navmiisdk.NavmiiSettings.setAvoidTollRoads ( boolean  value)

Sets avoid toll roads state.

Parameters
valueTrue - avoid toll roads false - not avoid toll roads
native boolean navmiisdk.NavmiiSettings.getAvoidTollRoads ( )

Returns avoid toll roads state.

native void navmiisdk.NavmiiSettings.setAvoidMotorways ( boolean  value)

Sets avoid motorways state.

Parameters
valueTrue - avoid motorways false - not avoid motorways
native boolean navmiisdk.NavmiiSettings.getAvoidMotorways ( )

Returns avoid toll motorways.

native void navmiisdk.NavmiiSettings.setWalkingMode ( boolean  value)

Changes walking mode state.

Parameters
valueTrue - enables, false - disabled
native boolean navmiisdk.NavmiiSettings.getWalkingMode ( )

Returns walking mode state.

void navmiisdk.NavmiiSettings.setVehicleType ( VehicleType  value)

Sets vehicle type.

Parameters
valueNew value
VehicleType navmiisdk.NavmiiSettings.getVehicleType ( )

Returns vehicle type.

void navmiisdk.NavmiiSettings.setRouteOptimization ( RouteOptimization  value)

Sets route optimization type.

Parameters
valueNew value
RouteOptimization navmiisdk.NavmiiSettings.getRouteOptimization ( )

Returns route optimization type.

native void navmiisdk.NavmiiSettings.setDrawPositionOnMapEnabled ( boolean  value)

Changes position on map drawing.

Parameters
valueNew value
native boolean navmiisdk.NavmiiSettings.getDrawPositionOnMapEnabled ( )

Returns is position drawing on map.

native void navmiisdk.NavmiiSettings.setDrawEventsOnMapEnabled ( boolean  value)

Changes events on map drawing.

Parameters
valueNew value
native boolean navmiisdk.NavmiiSettings.getDrawEventsOnMapEnabled ( )

Returns is events drawing on map.

native void navmiisdk.NavmiiSettings.setDrawUsersOnMapEnabled ( boolean  value)

Changes users on map drawing.

Parameters
valueNew value
native boolean navmiisdk.NavmiiSettings.getDrawUsersOnMapEnabled ( )

Returns is users drawing on map.

native void navmiisdk.NavmiiSettings.setDrawOverlaysEnabled ( boolean  value)

Changes overlays (waypoints, start, finish) drawing on map.

Parameters
valueNew value
native boolean navmiisdk.NavmiiSettings.getDrawOverlaysEnabled ( )

Returns is overlays drawing on map.

native void navmiisdk.NavmiiSettings.setDrawSpeedCameraEnabled ( boolean  value)

Changes speed camera drawing on map.

Parameters
valueNew value
native boolean navmiisdk.NavmiiSettings.getDrawSpeedCameraEnabled ( )

Returns is speed camera drawing on map.

native void navmiisdk.NavmiiSettings.setDrawPoiOnMapEnabled ( boolean  value)

Changes POI on map drawing.

Parameters
valueNew value
native boolean navmiisdk.NavmiiSettings.getDrawPoiOnMapEnabled ( )

Returns is POI drawing on map.

native POICategory [] navmiisdk.NavmiiSettings.getPoiCategories ( )

Returns POI Categories list.

native POICategory [] navmiisdk.NavmiiSettings.getSpeedCameraCategories ( )

Returns speed camera POI Categories list.

native POICategory [] navmiisdk.NavmiiSettings.getRoadEventCategories ( )

Returns road event POI Categories list.

native boolean navmiisdk.NavmiiSettings.getPoiCategoryExist ( int  id)

Returns is POI category exist.

Parameters
idCategory id
native void navmiisdk.NavmiiSettings.setPoiCategoryDisplayedOnMap ( int  id,
boolean  value 
)

Sets POI category displayed on map.

Parameters
idCategory id
valueNew value
native boolean navmiisdk.NavmiiSettings.getPoiCategoryDisplayedOnMap ( int  id)

Returns is POI category displayed on map.

Parameters
idCategory id
native void navmiisdk.NavmiiSettings.setPoiCategoriesDisplayedOnMap ( int[]  ids,
boolean  value 
)

Sets POI categories displayed on map.

Parameters
idsCategory identifiers
valueNew value
native android.graphics.Bitmap navmiisdk.NavmiiSettings.getPoiCategoryIcon ( int  id)

Returns POI category UI image.

Parameters
idCategory id
native String navmiisdk.NavmiiSettings.getPoiCategoryName ( int  id)

Returns POI category name.

Parameters
idCategory id
native void navmiisdk.NavmiiSettings.setPoiCategoryName ( int  id,
String  name 
)

Sets POI category name.

Parameters
idCategory id
nameNew name
native int navmiisdk.NavmiiSettings.getPoiCategoryZoomLevel ( int  id)

Returns POI category zoom level.

Parameters
idCategory id
native void navmiisdk.NavmiiSettings.setPoiCategoryZoomLevel ( int  id,
int  zoomLevel 
)

Sets POI category zoom level.

Parameters
idCategory id
zoomLevelSpecified zoom level in range 0..15
native void navmiisdk.NavmiiSettings.setRouteLineColour ( int  color)

Sets route color.

Parameters
colorARGB color
native int navmiisdk.NavmiiSettings.getRouteLineColour ( )

Returns route color.

native void navmiisdk.NavmiiSettings.setDirectionArrowColor ( int  fillColor,
int  borderColor 
)

Sets direction arrow color.

Parameters
fillColorARGB color to fill arrow
borderColorARGB color of arrow border

The documentation for this class was generated from the following file: