NaviSession (JNaviCore SDK Documentation)

java.lang.Object
- com.mapbar.navi.NaviSession

```
public class NaviSession
extends java.lang.Object
```
导航逻辑控制模块
是导航逻辑的核心实现，核心的导航逻辑都由此类提供方法

Notice:

注意：所有的API调用应该保证都是在主线程中

嵌套类概要

嵌套类
限定符和类型	类和说明
`class`	`NaviSession.AvoidRoadType` 需要避让的道路类型
`class`	`NaviSession.AvoidUTurnMode` 防止掉头设置
`class`	`NaviSession.CameraDataState` 初始化引擎后，已加载的电子眼数据状态
`class`	`NaviSession.Event` 导航中回调函数使用的事件类型
`static interface`	`NaviSession.EventHandler` 事件回调处理接口可以通过实现此接口中的`NaviSession.EventHandler.onNaviSessionEvent(int,Object)`方法来控制各种事件触发之后的行为
`class`	`NaviSession.GuidanceMode` Guidance的播报模式
`class`	`NaviSession.Module` 引擎提供的模块支持，用以控制模块的开关
`class`	`NaviSession.NaviStartVoiceMode` 导航开始时的语音播报模式，分为详细模式和简洁模式
`class`	`NaviSession.RouteMethod` 控制算路方式
`class`	`NaviSession.TmcReportError` TMC播报失败对应的错误类型
`class`	`NaviSession.TmcRequest` TMC更新请求
`class`	`NaviSession.TrafficDirection` 道路行车方向，当地政策规定靠左或靠右

方法概要

所有方法静态方法实例方法具体方法已过时的方法
限定符和类型	方法和说明
`void`	`cancelRouting()` 用于手动取消算路过程在事件`NaviSession.Event.routeStarted`后取消算路会收到事件 `NaviSession.Event.routeCancelled` 在事件`NaviSession.Event.rerouteStarted`后取消重算路会收到事件 `NaviSession.Event.rerouteCancelled`
`boolean`	`canResumeNavigation()` 用于判断是否可以恢复导航路线每次算路后可以将路线保存为文件，以便在下次启动时自动载入上次的路线此方法用于判断是否存在这样的可恢复道路的文件
`boolean`	`canResumeNavigation(RoutePlan plan)` 用于判断是否可以回复导航路线，主要是上次导航没有结束就关闭了软件此方法同时会获取路线规划方式，主要用于显示起点终点如果不需要显示起点终点，那么应该使用`canResumeNavigation()`
`void`	`cleanup()` 清理`NaviSession`引擎模块的JNI方法用于清理引擎的NaviSession模块相关资源，应该在应用程序退出时或重启之前调用
`void`	`enableConditionalRestriction(boolean enable)` 已过时。 since 2018/5/31 master 开启条件限行
`void`	`enableGps(boolean enable)` 开启/关闭GPS引擎一般来说，程序切换到后台，或者用户关闭了GPS设备，应该关闭引擎中的GPS
`void`	`enableGpsSpeedZeroPolicy(boolean enable)` 开启引擎处理GPS速度为零时的策略，默认：未开启
`void`	`enableModule(int module, boolean enable)` 开关`NaviSession`所管理的模块`NaviSession.Module` 通过此方法可以动态开启或关闭相应的模块功能
`void`	`enableOfflineCameraData(boolean enable)` 打开/关闭离线电子眼，默认: true
`void`	`enableRepeatSimulation(boolean enable)` 是否开启循环模拟导航在到达终点后是否重新从头模拟导航
`void`	`enableSound(boolean enabled)` 开启/关闭各种播报语音
`void`	`enableVanGuide(boolean enabled)` 开启/关闭货车播报，默认false
`void`	`endManeualStartState()` 结束手动起点状态
`void`	`endRouteOverview()` 用于结束道路的地图呈现
`void`	`endSimulation()` 结束模拟导航
`java.lang.String`	`getErrorStr()` 获取算路异常时错误信息
`static NaviSession`	`getInstance()` 获取`NaviSession`实例
`NaviSessionData`	`getNaviData()` 用于获取导航实时数据一般情况下，在回调函数中的tracking事件会返回`NaviSessionData`对象此对象即表示当前实时导航信息，不需要手动调用此方法获取实时信息
`int`	`getNaviStartVoiceMode()` 获取当前"导航开始语音模式"设置`NaviSession.NaviStartVoiceMode`
`RoutePlan`	`getPlan()` 返回当前有效的路线规划信息
`RouteBase`	`getRoute()` 获取当前有效的路线，在`takeRoute(RouteBase)`后才能获取到有效的路线
`java.lang.String`	`getRouteTmcUrlBase()` 获取蚯蚓路TMC服务器的URL(?
`float`	`getSimulationSpeed()` 获取当前模拟导航速度
`int`	`getStepCounter()` 用于获取当前算路进行到第几步
`static RestrictionInfo[]`	`getVehicleRestrictions()` 获取接下来一段行程中的限行信息数组
`int`	`GPSDebuggerGetFrameNumber()` 获取当前gps_log数据的总帧数
`boolean`	`GPSDebuggerLoad(java.lang.String filename)` 打开gps_log文件，会根据文件后缀名来判断文件的类型，文件分为NmeaMode和InfoMode两种格式 nmea格式数据以.txt或者.nmea格式结尾，info格式数据以.info结尾
`void`	`GPSDebuggerPause()` 暂停播放gps_log数据
`void`	`GPSDebuggerPlay()` 从当前帧播放gps_log数据当前帧通过`GPSDebuggerSetFrameByIndex(int)`方法设置
`void`	`GPSDebuggerSetFrameByIndex(int index)` 根据索引设置指定的帧为当前帧
`void`	`GPSDebuggerSetSpeed(int speed)` 设置gps_log播放的速度，即，每一秒播放多少帧数据，单位：帧/秒
`void`	`GPSDebuggerStop()` 停止播放gps_log数据会结束播放线程
`boolean`	`GPSIsInDebugMode()` 判断当前是否为debug模式
`SegmentGrabInfo`	`grabSegment(android.graphics.Point pos, short ori)` 指定位置和方向进行离线抓路
`void`	`init(android.content.Context context, NaviSession.EventHandler handler, NaviSessionParams params)` 初始化`NaviSession`引擎模块用于初始化引擎的NaviSession模块相关资源，应该在应用程序初始化阶段调用
`boolean`	`isGpsEnabled()` GPS引擎是否开启每次需要调用`enableGps(boolean)`时需要调用此接口判断
`boolean`	`isGpsSpeedZeroPolicyEnabled()` 判断引擎当前GPS速度为零处理策略是否开启
`boolean`	`isInited()` 导航引擎是否初始化过
`boolean`	`isInManualStartState()` 判断当前是否为手动起点状态所谓“手动起点状态”，就是不采用GPS定位点位起点，而是手动设置的起点，此时虽然偏航，但是并不会引起重新计算进入状态条件： 1、如果用户采用GPS定位起点，则不会进入此状态。
`boolean`	`isInSimulation()` 判断当前是否在模拟导航模式中
`boolean`	`isModuleEnabled(int module)` 判断`NaviSession`中那些模块开启用于判断给定的模块是否开启
`boolean`	`isNaviPaused()` 判断当前导航是否暂停
`boolean`	`isPositionFixed()` 判断当前引擎是否处在定位状态
`boolean`	`isRepeatSimulationEnabled()` 判断当前是否为循环模拟
`boolean`	`isRouting()` 判断当前是否正在算路
`boolean`	`isSimulationPaused()` 判断当前是否为模拟导航暂停状态当前如果不在模拟导航模式中，那么此方法也会返回`false` 所以此方法应该和`isInSimulation()`方法一同使用
`boolean`	`isSoundEnabled()` 判断当前语音播报是否在打开状态
`boolean`	`isUsingExperienceAccuracyForGps()` 是否使用经验值替代GPS设备给出的精度值，默认为使用设备给出的精度值，即，返回false
`boolean`	`isVanGuideEnabled()` 查看当前货车播报是否开启,相关`enableVanGuide(boolean)`
`void`	`onLocationChanged(android.location.Location location)` 当前地理坐标位置发生变化
`void`	`onSatelliteStatusChanged(java.util.ArrayList<MapbarGpsSatellite> satellites)` 卫星状态发生变化
`void`	`onSatelliteStatusChanged(java.lang.Iterable<android.location.GpsSatellite> satellites)` 卫星状态发生变化
`void`	`pauseNavi()` 暂停导航，保存当前导航状态此函数使用了引用计数，使用时需要与@see #resumeNavi()成对使用
`void`	`pauseSimulation()` 暂停模拟导航
`void`	`removeRoute()` 删除当前道路信息使用此方法时，仅会删除导航逻辑内部的道路，不会删除地图上绘制好的用于显示的道路线条应当在调用此方法是同时调用用于删除地图上绘制的路线的方法
`void`	`resumeNavi()` 用于恢复已暂停的导航状态此函数使用了引用计数，使用时需要与@see #pauseNavi()成对使用
`void`	`resumeNavigation()` 用于恢复导航路线配合`canResumeNavigation()`方法使用如果`NaviSession.canResumeNavigation()`方法返回`true` 则可以调用此方法恢复路线
`void`	`resumeSimulation()` 恢复模拟导航
`void`	`setAvoidUTurnMode(int mode)` 设置防调头模式
`void`	`setGuidanceMode(int mode)` 设置Guidance语音的播报模式
`void`	`setNav2TmcUrlBase(java.lang.String urlBase)` 设置根据四维ID获取路况的接口默认：http://navicore.mapbar.com/nav2tmc
`void`	`setNaviStartVoiceMode(int mode)` 设置"导航开始语音模式"，默认值为`NaviSession.NaviStartVoiceMode.detailed` "导航开始语音模式"的设置会影响导航开始以及模拟导航开始时的语音播报内容，详见 `NaviSessionParams.voiceFeedback`和 `NaviSession.NaviStartVoiceMode`的注释说明
`void`	`setReroutePreferExisting(boolean prefer)` 设置偏航重计算的结果是否倾向于与原有路线相似此接口的需求来自这样的应用场景：用户在“单规则多结果”算路方式下选择了非第一条路线作为当前路线进行导航，但在起点附近很快就发生了偏航重计算，此时用户希望重计算的结果仍然是之前选择的路线。
`void`	`setRouteTmcUrlBase(java.lang.String urlBase)` 设置蚯蚓路TMC获取服务器的URL基础部分(?
`void`	`setRouteUrlBase(java.lang.String urlBase)` 设置在线算路服务器URL基础部分(?
`void`	`setSignalLostDelay(int delay)` 设置引擎处理丢星策略时的延时时间，单位：ms 默认：10000ms
`void`	`setSimulationInterval(int milliseconds)` 已过时。最新的商量结果表明应该去掉此方法
`void`	`setSimulationSpeed(float speed)` 设置模拟导航速度等级可以理解为设置模拟导航速度百分比的方法，比如想要设置为两倍速度则`speed`参数应该设置为2.0，不能设置为负数
`void`	`startRoute(RoutePlan plan, int method)` 使用指定的路线计划开始算路，用于手动启动算路逻辑算路时，引擎内部会自动保存一个路线规划文件，如果本次没有导航结束，软件就被关闭，那么路线将在下次开机时通过`canResumeNavigation()`或 `canResumeNavigation(RoutePlan)`，以及 `resumeNavigation()` 来恢复上一次的路线算路开始后，典型地，调用者会收到以下事件： 1条 `NaviSession.Event.routeStarted` 0~N条 `NaviSession.Event.routing` 0~1条 `NaviSession.Event.offlineRouteFaildInAutoMode` (自动模式下离线算路失败时会有此消息) 0~N条 `NaviSession.Event.routing` 1条`NaviSession.Event.routeComplete` 或 `NaviSession.Event.routeFailed` 或 `NaviSession.Event.routeCancelled`
`void`	`startRouteOverview()` 用于在地图上呈现当前算的路线
`void`	`startSimulation()` 开始模拟导航此方法应该在算路成功之后调用
`void`	`startSimulationWithPlan(RoutePlan plan)` 根据手动提供的路线计划来开始模拟导航不同于`startSimulation()`方法此方法主要用于实景模拟，以指定的路线计划来开始模拟导航演示
`void`	`takeRoute(RouteBase route)` 应用当前道路当算路结束时，可以通过此方法应用道路，之后才可以导航或者模拟导航
`void`	`takeRouteQuietly(RouteBase route)` 功能与`takeRoute(RouteBase)`基本相同但是不播报导航开始语音同时不发送startNavi事件
`boolean`	`tryGrabSegments(android.graphics.Point pos, short ori)` 在指定的位置用指定的方向在离线算路数据中尝试抓路用于在设置起点/终点/途经点前检查附近是否有道路
`TTSRoleDescription[]`	`TTSEnumRoles()` 枚举出所有支持切换的语音角色
`TTSRoleDescription`	`TTSGetRole()` 获取当前播报语音的角色
`void`	`TTSResetRole()` 重设语音播报角色为默认角色
`void`	`TTSSetDelayedDuration(long delayedBefore, long delayedAfter)` 设置TTS播报延迟时间，值小于等于0时无延迟。
`void`	`TTSSetRole(TTSRoleDescription ttsRole)` 设置当前用于播报的语音角色
`void`	`useExperienceAccuracyForGps(boolean useExperienceAccuracy)` 使用经验值替代GPS设备给出的精度值，默认为使用设备给出精度值

从类继承的方法 java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 方法详细资料
  - getInstance
```
public static NaviSession getInstance()
```
    获取NaviSession实例
    
    返回:
    
    NaviSession实例
  - init
```
public void init(android.content.Context context,
                 NaviSession.EventHandler handler,
                 NaviSessionParams params)
          throws java.lang.Exception
```
    初始化NaviSession引擎模块
    用于初始化引擎的NaviSession模块相关资源，应该在应用程序初始化阶段调用
    
    参数:
    
    context - 主线程应用的上下文
    
    handler - 注册回调方法的接口
    
    params - 初始化模块时的配置信息
    
    抛出:
    
    java.lang.Exception - 如果SDK导航包无授权，那么抛出授权异常
    
    InitializationException - 如果初始化顺序错误，那么会抛出此异常
    
    另请参阅:
    
    NaviSession.EventHandler, NaviSessionData
    
    Notice:
    
    注意：模块初始化过程必须在主线程中调用。
  - cleanup
```
public void cleanup()
```
    清理NaviSession引擎模块的JNI方法
    用于清理引擎的NaviSession模块相关资源，应该在应用程序退出时或重启之前调用
    
    Notice:
    
    注意：模块销毁过程必须在主线程中调用。
  - isInited
```
public boolean isInited()
```
    导航引擎是否初始化过
    
    返回:
    
    如果初始化过则返回true,否则返回false
  - enableModule
```
public void enableModule(int module,
                         boolean enable)
```
    开关NaviSession所管理的模块NaviSession.Module
    通过此方法可以动态开启或关闭相应的模块功能
    参数:
    
    module - 模块对应标志序号
    
    enable - 是否开启，如果是true表示开启模块，如果是false表示关闭模块
    
    另请参阅:
    
    NaviSession.Module
    
    Notice:
    
    注意：这里所能控制的模块一定是在调用 init(Context, EventHandler, NaviSessionParams) 时被有效初始化过的模块
    
    Example:
    // e.g. 可以通过使用"|"运算来同时操作多个模块 NaviSession ns = NaviSession.getInstance(); // 同时打开电子眼播报和路口放大图模块 ns.enableModule(NaviSession.Module.cameraWarning | NaviSession.Module.expandView, true); // 关闭行政区划播报和高速路牌信息模块 ns.enableModule(NaviSession.Module.adminSpeaker, false); ns.enableModule(NaviSession.Module.highwayGuide, false);
  - enableConditionalRestriction
```
public void enableConditionalRestriction(boolean enable)
```
    已过时。 since 2018/5/31 master 开启条件限行
    
    参数:
    
    enable - true开启/false关闭默认关闭相关VehicleInfo
  - isModuleEnabled
```
public boolean isModuleEnabled(int module)
```
    判断NaviSession中那些模块开启
    用于判断给定的模块是否开启
    
    参数:
    
    module - 模块对应标志序号
    
    返回:
    
    模块开启则返回true，否则返回false
    
    另请参阅:
    
    NaviSession.Module
  - startRoute
```
public void startRoute(RoutePlan plan,
                       int method)
```
    使用指定的路线计划开始算路，用于手动启动算路逻辑
    算路时，引擎内部会自动保存一个路线规划文件，如果本次没有导航结束，
    软件就被关闭，那么路线将在下次开机时通过canResumeNavigation()或
    canResumeNavigation(RoutePlan)，以及 resumeNavigation()
    来恢复上一次的路线
    算路开始后，典型地，调用者会收到以下事件：
    1条 NaviSession.Event.routeStarted
    0~N条 NaviSession.Event.routing
    0~1条 NaviSession.Event.offlineRouteFaildInAutoMode (自动模式下离线算路失败时会有此消息)
    0~N条 NaviSession.Event.routing
    1条NaviSession.Event.routeComplete 或 NaviSession.Event.routeFailed 或 NaviSession.Event.routeCancelled
    
    参数:
    
    plan - 路线计划信息，其中保存着起点、终点、途径点算路所需信息
    
    method - 制定算路方式，使用NaviSession.RouteMethod表示
    
    另请参阅:
    
    RoutePlan, NaviSession.RouteMethod, canResumeNavigation(), canResumeNavigation(RoutePlan), resumeNavigation()
  - cancelRouting
```
public void cancelRouting()
```
    用于手动取消算路过程
    在事件NaviSession.Event.routeStarted后取消算路会收到事件 NaviSession.Event.routeCancelled
    在事件NaviSession.Event.rerouteStarted后取消重算路会收到事件 NaviSession.Event.rerouteCancelled
  - getRoute
```
public RouteBase getRoute()
```
    获取当前有效的路线，在takeRoute(RouteBase)后才能获取到有效的路线
    
    返回:
    
    当前有效的路线
    
    另请参阅:
    
    takeRoute(RouteBase)
  - getPlan
```
public RoutePlan getPlan()
```
    返回当前有效的路线规划信息
    
    返回:
    
    当前有效的路线规划信息
    
    另请参阅:
    
    RoutePlan
  - takeRoute
```
public void takeRoute(RouteBase route)
```
    应用当前道路
    当算路结束时，可以通过此方法应用道路，之后才可以导航或者模拟导航
    
    参数:
    
    route - 欲设置的有效路线
    
    另请参阅:
    
    RouteBase, NaviSession.RouteMethod, NaviSessionParams.autoTakeRoute, takeRouteQuietly(RouteBase)
    
    Notice:
    
    当规划多条路时(算路引擎是支持规划多条路线的，详情请查看 NaviSession.RouteMethod中的说明)，即使设置了 NaviSessionParams.autoTakeRoute 为true(也就是要求导航引擎自动载入路线)，此设置也会失效，需要手动调用此方法( takeRoute(RouteBase))，让导航引擎载入路线。
  - takeRouteQuietly
```
public void takeRouteQuietly(RouteBase route)
```
    功能与takeRoute(RouteBase)基本相同但是不播报导航开始语音同时不发送startNavi事件
    
    参数:
    
    route - 欲设置的有效路线
    
    另请参阅:
    
    takeRoute(RouteBase)
  - removeRoute
```
public void removeRoute()
```
    删除当前道路信息
    使用此方法时，仅会删除导航逻辑内部的道路，不会删除地图上绘制好的用于显示的道路线条
    应当在调用此方法是同时调用用于删除地图上绘制的路线的方法
  - isRouting
```
public boolean isRouting()
```
    判断当前是否正在算路
    
    返回:
    
    返回true表示正在算路中，否则返回false
  - getStepCounter
```
public int getStepCounter()
```
    用于获取当前算路进行到第几步
    
    返回:
    
    算路所进行到的步骤
  - canResumeNavigation
```
public boolean canResumeNavigation()
```
    用于判断是否可以恢复导航路线
    每次算路后可以将路线保存为文件，以便在下次启动时自动载入上次的路线
    此方法用于判断是否存在这样的可恢复道路的文件
    
    返回:
    
    如果可以恢复导航路线则返回true，否则返回false
  - canResumeNavigation
```
public boolean canResumeNavigation(RoutePlan plan)
```
    用于判断是否可以回复导航路线，主要是上次导航没有结束就关闭了软件
    此方法同时会获取路线规划方式，主要用于显示起点终点
    如果不需要显示起点终点，那么应该使用canResumeNavigation()
    
    参数:
    
    plan - 所获取的RoutePlan，如果传入null，则与 canResumeNavigation()作用相同
    
    返回:
    
    如果可以回复上次的路线，那么返回相应的RoutePlan，否则返回null
  - resumeNavigation
```
public void resumeNavigation()
```
    用于恢复导航路线
    配合canResumeNavigation()方法使用
    如果NaviSession.canResumeNavigation()方法返回true
    则可以调用此方法恢复路线
  - setReroutePreferExisting
```
public void setReroutePreferExisting(boolean prefer)
```
    设置偏航重计算的结果是否倾向于与原有路线相似此接口的需求来自这样的应用场景：
    用户在“单规则多结果”算路方式下选择了非第一条路线作为当前路线进行导航，
    但在起点附近很快就发生了偏航重计算，此时用户希望重计算的结果仍然是之前选择的路线。
    此接口设置为 true后可能带来的副作用是重计算结果立刻要掉头的概率会更大一些。
    
    参数:
    
    prefer - true表示倾向于与原有路线相似，false 表示不考虑原有路线。缺省值: false。
    
    从以下版本开始:
    
    4.10.x
  - setAvoidUTurnMode
```
public void setAvoidUTurnMode(int mode)
```
    设置防调头模式
    
    参数:
    
    mode - 防掉头模式NaviSession.AvoidUTurnMode
    
    从以下版本开始:
    
    4.10.x
    
    另请参阅:
    
    NaviSession.AvoidUTurnMode
  - getErrorStr
```
public java.lang.String getErrorStr()
```
    获取算路异常时错误信息
    
    返回:
    
    返回当前算路错误的信息字串
  - isPositionFixed
```
public boolean isPositionFixed()
```
    判断当前引擎是否处在定位状态
    
    Notice:
    
    引擎的“定位状态”包含了GPS定位以及隧道中丢星后的GPS信号推演状态
  - getNaviData
```
public NaviSessionData getNaviData()
```
    用于获取导航实时数据
    一般情况下，在回调函数中的tracking事件会返回NaviSessionData对象
    此对象即表示当前实时导航信息，不需要手动调用此方法获取实时信息
    
    返回:
    
    导航实时数据对象
    
    另请参阅:
    
    NaviSessionData
  - startSimulation
```
public void startSimulation()
```
    开始模拟导航
    此方法应该在算路成功之后调用
    
    Notice:
    
    注意：开始模拟导航与结束模拟导航一定要配对使用，客户端需要保证这一点，否则可能导致引擎崩溃。
  - startSimulationWithPlan
```
public void startSimulationWithPlan(RoutePlan plan)
```
    根据手动提供的路线计划来开始模拟导航
    不同于startSimulation()方法
    此方法主要用于实景模拟，以指定的路线计划来开始模拟导航演示
    
    参数:
    
    plan - 指定的路线计划
    
    另请参阅:
    
    startSimulation(), RoutePlan
    
    Notice:
    
    注意：开始模拟导航与结束模拟导航一定要配对使用，客户端需要保证这一点，否则可能导致引擎崩溃。
  - endSimulation
```
public void endSimulation()
```
    结束模拟导航
    
    Notice:
    
    注意：开始模拟导航与结束模拟导航一定要配对使用，客户端需要保证这一点，否则可能导致引擎崩溃。
  - isInSimulation
```
public boolean isInSimulation()
```
    判断当前是否在模拟导航模式中
    
    返回:
    
    如果处于模拟导航模式中返回true，否则返回false
  - pauseSimulation
```
public void pauseSimulation()
```
    暂停模拟导航
    
    另请参阅:
    
    resumeSimulation()
  - resumeSimulation
```
public void resumeSimulation()
```
    恢复模拟导航
    
    另请参阅:
    
    #pauseSimulation()}
  - isSimulationPaused
```
public boolean isSimulationPaused()
```
    判断当前是否为模拟导航暂停状态
    当前如果不在模拟导航模式中，那么此方法也会返回false
    所以此方法应该和isInSimulation()方法一同使用
    
    返回:
    
    是否当前已经暂停了模拟导航状态，已经暂停返回true，否则返回false
    
    另请参阅:
    
    pauseSimulation()
  - setSimulationSpeed
```
public void setSimulationSpeed(float speed)
```
    设置模拟导航速度等级
    可以理解为设置模拟导航速度百分比的方法，比如想要设置为两倍速度
    则speed参数应该设置为2.0，不能设置为负数
    
    参数:
    
    speed - 当前的速度等级(相对于基础速度的百分比)
  - getSimulationSpeed
```
public float getSimulationSpeed()
```
    获取当前模拟导航速度
    
    返回:
    
    当前模拟导航的速度等级(相对于基础速度的百分比)
  - enableRepeatSimulation
```
public void enableRepeatSimulation(boolean enable)
```
    是否开启循环模拟导航
    在到达终点后是否重新从头模拟导航
    
    参数:
    
    enable - 设置为true则表示循环模拟，设置为false表示单次模拟
  - isRepeatSimulationEnabled
```
public boolean isRepeatSimulationEnabled()
```
    判断当前是否为循环模拟
    
    返回:
    
    如果此时为循环模拟，返回true，否则返回false
  - setSimulationInterval
```
public void setSimulationInterval(int milliseconds)
```
    已过时。最新的商量结果表明应该去掉此方法
    
    设置模拟导航的更新间隔时间
    
    参数:
    
    milliseconds - 设置模拟导航刷新的间隔时间，单位为毫秒(ms)
  - startRouteOverview
```
public void startRouteOverview()
```
    用于在地图上呈现当前算的路线
  - endRouteOverview
```
public void endRouteOverview()
```
    用于结束道路的地图呈现
  - pauseNavi
```
public void pauseNavi()
```
    暂停导航，保存当前导航状态
    此函数使用了引用计数，使用时需要与@see #resumeNavi()成对使用
  - resumeNavi
```
public void resumeNavi()
```
    用于恢复已暂停的导航状态
    此函数使用了引用计数，使用时需要与@see #pauseNavi()成对使用
  - isNaviPaused
```
public boolean isNaviPaused()
```
    判断当前导航是否暂停
    
    返回:
    
    如果当前为导航暂停状态，返回true，否则返回false
    
    另请参阅:
    
    pauseNavi()
  - isInManualStartState
```
public boolean isInManualStartState()
```
    判断当前是否为手动起点状态
    所谓“手动起点状态”，就是不采用GPS定位点位起点，而是手动设置的起点，此时虽然偏航，但是并不会引起重新计算
    进入状态条件：
    1、如果用户采用GPS定位起点，则不会进入此状态。
    2、如果用户自己采用 RoutePlan.setDestination(int, com.mapbar.mapdal.PoiFavorite)， RoutePlan.addDestination(com.mapbar.mapdal.PoiFavorite)， RoutePlan.setEndPoint(com.mapbar.mapdal.PoiFavorite)， RoutePlan.insertDestination(int, com.mapbar.mapdal.PoiFavorite) 等方法手动设置起点，且此时定位中，则可能进入。
    3、满足条件2情况下，如果定位点不在算出的路上，进入此状态。
    
    返回:
    
    如果当前处于手动起点状态返回true，否则返回false
    
    另请参阅:
    
    endManeualStartState()
  - endManeualStartState
```
public void endManeualStartState()
```
    结束手动起点状态
  - setNaviStartVoiceMode
```
public void setNaviStartVoiceMode(int mode)
```
    设置"导航开始语音模式"，默认值为NaviSession.NaviStartVoiceMode.detailed
    "导航开始语音模式"的设置会影响导航开始以及模拟导航开始时的语音播报内容，详见 NaviSessionParams.voiceFeedback和 NaviSession.NaviStartVoiceMode的注释说明
    
    参数:
    
    mode - 模式NaviSession.NaviStartVoiceMode
    
    另请参阅:
    
    NaviSession.NaviStartVoiceMode, NaviSessionParams
  - getNaviStartVoiceMode
```
public int getNaviStartVoiceMode()
```
    获取当前"导航开始语音模式"设置NaviSession.NaviStartVoiceMode
    
    返回:
    
    导航开始语音模式NaviSession.NaviStartVoiceMode
    
    另请参阅:
    
    NaviSession.NaviStartVoiceMode, setNaviStartVoiceMode(int), NaviSessionParams
  - tryGrabSegments
```
public boolean tryGrabSegments(android.graphics.Point pos,
                               short ori)
```
    在指定的位置用指定的方向在离线算路数据中尝试抓路
    
    用于在设置起点/终点/途经点前检查附近是否有道路
    
    参数:
    
    pos - 制定位置的经纬度坐标，单位：十万分之一度
    
    ori - 给定的方向，单位：度。以正东为0，逆时针为正，Short.MAX_VALUE表示任意方向，即，不带方向抓路。
    
    返回:
    
    如果能成功抓路则返回true，否则返回false ，没抓到路表示该点附近没有道路，无法作为起点/终点/途经点进行离线路算规划
  - grabSegment
```
public SegmentGrabInfo grabSegment(android.graphics.Point pos,
                                   short ori)
```
    指定位置和方向进行离线抓路
    
    参数:
    
    pos - 位置坐标
    
    ori - 方向，单位：度。以正东为0，逆时针为正，用Short.MAX_VALUE表示不考虑方向
    
    返回:
    
    抓路结果SegmentGrabInfo，抓路失败时返回null
  - setRouteUrlBase
```
public void setRouteUrlBase(java.lang.String urlBase)
```
    设置在线算路服务器URL基础部分(?和参数之前的部分)，便于不同服务器切换使用
    
    参数:
    
    urlBase - 欲设置的在线算路服务器URL地址的基础部分
    
    Notice:
    
    注意：此方法非线程安全，只能在主线程中使用。
  - setRouteTmcUrlBase
```
public void setRouteTmcUrlBase(java.lang.String urlBase)
```
    设置蚯蚓路TMC获取服务器的URL基础部分(?和参数之前的部分)。默认值：http://search.api.mapbar.com/tmc/getTmc.jsp
    
    参数:
    
    urlBase - 蚯蚓路Tmc服务器URL地址的基础部分
    
    Notice:
    
    注意：此方法非线程安全，只能在主线程中使用。
  - getRouteTmcUrlBase
```
public java.lang.String getRouteTmcUrlBase()
```
    获取蚯蚓路TMC服务器的URL(?和参数之前的部分)。
    
    返回:
    
    蚯蚓路Tmc服务器URL地址的基础部分
    
    Notice:
    
    注意：此方法非线程安全，只能在主线程中使用。
  - setNav2TmcUrlBase
```
public void setNav2TmcUrlBase(java.lang.String urlBase)
```
    设置根据四维ID获取路况的接口
    默认：http://navicore.mapbar.com/nav2tmc
    
    参数:
    
    urlBase - URL地址
  - setGuidanceMode
```
public void setGuidanceMode(int mode)
```
    设置Guidance语音的播报模式
    
    参数:
    
    mode - 播报模式NaviSession.GuidanceMode
    
    另请参阅:
    
    NaviSession.GuidanceMode
  - enableSound
```
public void enableSound(boolean enabled)
```
    开启/关闭各种播报语音
    
    参数:
    
    enabled - true表示打开语音播报，false表示关闭语音播报
  - isSoundEnabled
```
public boolean isSoundEnabled()
```
    判断当前语音播报是否在打开状态
    
    返回:
    
    true表示打开，false表示未打开
  - enableOfflineCameraData
```
public void enableOfflineCameraData(boolean enable)
```
    打开/关闭离线电子眼，默认: true
    
    参数:
    
    enable： - true为打开，false为关闭
    
    Notice:
    
    注意：引擎中部提供重新载入电子眼的接口，此接口的作用为：当用户拷贝了离线电子眼，而使用在线算路时
    那么客户端可以通过此方法来限制用户使用无权限的本地电子眼，仅能使用在线算路得到的普通电子眼。
  - onLocationChanged
```
public void onLocationChanged(android.location.Location location)
```
    当前地理坐标位置发生变化
    
    参数:
    
    location - 变化后的地理坐标位置
    
    另请参阅:
    
    GpsTracker.onLocationChanged(Location)
    
    Notice:
    
    NaviSession初始化参数中 NaviSessionParams.useNaviCoreGPS 设为false时需要调用此接口
  - onSatelliteStatusChanged
```
public void onSatelliteStatusChanged(java.lang.Iterable<android.location.GpsSatellite> satellites)
```
    卫星状态发生变化
    
    参数:
    
    satellites - 卫星状态
    
    另请参阅:
    
    GpsTracker.onSatelliteStatusChanged(Iterable)
    
    Notice:
    
    NaviSession初始化参数中 NaviSessionParams.useNaviCoreGPS 设为false时需要调用此接口
  - onSatelliteStatusChanged
```
public void onSatelliteStatusChanged(java.util.ArrayList<MapbarGpsSatellite> satellites)
```
    卫星状态发生变化
    
    参数:
    
    satellites - 卫星状态
    
    另请参阅:
    
    GpsTracker.onSatelliteStatusChanged(ArrayList)
    
    Notice:
    
    NaviSession初始化参数中 NaviSessionParams.useNaviCoreGPS 设为false时需要调用此接口
  - enableGps
```
public void enableGps(boolean enable)
```
    开启/关闭GPS引擎
    一般来说，程序切换到后台，或者用户关闭了GPS设备，应该关闭引擎中的GPS
    
    参数:
    
    enable - true表示开启，false标识关闭
    
    另请参阅:
    
    isGpsEnabled()
  - isGpsEnabled
```
public boolean isGpsEnabled()
```
    GPS引擎是否开启
    每次需要调用enableGps(boolean)时需要调用此接口判断
    
    返回:
    
    true表示已经开启，false标识已经关闭
    
    另请参阅:
    
    enableGps(boolean)
  - enableGpsSpeedZeroPolicy
```
public void enableGpsSpeedZeroPolicy(boolean enable)
```
    开启引擎处理GPS速度为零时的策略，默认：未开启
    
    参数:
    
    enable - true为开启，false为关闭
    
    另请参阅:
    
    GpsTracker.enableSpeedZeroPolicy(boolean), isGpsSpeedZeroPolicyEnabled()
  - isGpsSpeedZeroPolicyEnabled
```
public boolean isGpsSpeedZeroPolicyEnabled()
```
    判断引擎当前GPS速度为零处理策略是否开启
    
    返回:
    
    true为已开启，false为已关闭
    
    另请参阅:
    
    GpsTracker.isSpeedZeroPolicyEnabled(), enableGpsSpeedZeroPolicy(boolean)
  - setSignalLostDelay
```
public void setSignalLostDelay(int delay)
```
    设置引擎处理丢星策略时的延时时间，单位：ms
    默认：10000ms
    
    参数:
    
    delay - 延时时间
  - useExperienceAccuracyForGps
```
public void useExperienceAccuracyForGps(boolean useExperienceAccuracy)
```
    使用经验值替代GPS设备给出的精度值，默认为使用设备给出精度值
    
    参数:
    
    useExperienceAccuracy - true表示使用经验值，false表示使用GPS设备给出的精度值
    
    另请参阅:
    
    isUsingExperienceAccuracyForGps()
  - isUsingExperienceAccuracyForGps
```
public boolean isUsingExperienceAccuracyForGps()
```
    是否使用经验值替代GPS设备给出的精度值，默认为使用设备给出的精度值，即，返回false
    
    返回:
    
    true表示正在使用经验值，否则返回false
    
    另请参阅:
    
    useExperienceAccuracyForGps(boolean)
  - GPSIsInDebugMode
```
public boolean GPSIsInDebugMode()
```
    判断当前是否为debug模式
  - GPSDebuggerLoad
```
public boolean GPSDebuggerLoad(java.lang.String filename)
```
    打开gps_log文件，会根据文件后缀名来判断文件的类型，文件分为NmeaMode和InfoMode两种格式
    nmea格式数据以.txt或者.nmea格式结尾，info格式数据以.info结尾
    
    参数:
    
    filename - 文件路径, 是一个相对路径，相对于NativeEnv.getRootDirectory()返回的结果
    
    返回:
    
    是否打开成功，打开成功返回true，否则返回false，一般不成功的原因是文件路径错误
  - GPSDebuggerGetFrameNumber
```
public int GPSDebuggerGetFrameNumber()
```
    获取当前gps_log数据的总帧数
    
    返回:
    
    总帧数
  - GPSDebuggerSetFrameByIndex
```
public void GPSDebuggerSetFrameByIndex(int index)
```
    根据索引设置指定的帧为当前帧
    
    参数:
    
    index - 帧索引
  - GPSDebuggerPlay
```
public void GPSDebuggerPlay()
```
    从当前帧播放gps_log数据
    当前帧通过GPSDebuggerSetFrameByIndex(int)方法设置
    
    另请参阅:
    
    GPSDebuggerSetFrameByIndex(int)
  - GPSDebuggerPause
```
public void GPSDebuggerPause()
```
    暂停播放gps_log数据
    
    另请参阅:
    
    GPSDebuggerPlay()
  - GPSDebuggerStop
```
public void GPSDebuggerStop()
```
    停止播放gps_log数据会结束播放线程
  - GPSDebuggerSetSpeed
```
public void GPSDebuggerSetSpeed(int speed)
```
    设置gps_log播放的速度，即，每一秒播放多少帧数据，单位：帧/秒
    
    参数:
    
    speed - 每秒播放多少帧数据
  - TTSEnumRoles
```
public TTSRoleDescription[] TTSEnumRoles()
```
    枚举出所有支持切换的语音角色
    
    返回:
    
    语音角色数组
  - TTSGetRole
```
public TTSRoleDescription TTSGetRole()
```
    获取当前播报语音的角色
    
    返回:
    
    当前的语音角色
  - enableVanGuide
```
public void enableVanGuide(boolean enabled)
```
    开启/关闭货车播报，默认false
  - isVanGuideEnabled
```
public boolean isVanGuideEnabled()
```
    查看当前货车播报是否开启,相关enableVanGuide(boolean)
  - getVehicleRestrictions
```
public static RestrictionInfo[] getVehicleRestrictions()
```
    获取接下来一段行程中的限行信息数组
    
    返回:
    
    路线限行信息数组
  - TTSSetRole
```
public void TTSSetRole(TTSRoleDescription ttsRole)
```
    设置当前用于播报的语音角色
    
    参数:
    
    ttsRole - 需要使用的语音角色
  - TTSResetRole
```
public void TTSResetRole()
```
    重设语音播报角色为默认角色
  - TTSSetDelayedDuration
```
public void TTSSetDelayedDuration(long delayedBefore,
                                  long delayedAfter)
```
    设置TTS播报延迟时间，值小于等于0时无延迟。对每次播报都生效。单位：ms
    
    参数:
    
    delayedBefore - 播报前延迟时间
    
    delayedAfter - 播报后延迟时间

类 NaviSession

嵌套类概要

方法概要

从类继承的方法 java.lang.Object

方法详细资料

getInstance

init

cleanup

isInited

enableModule

enableConditionalRestriction

isModuleEnabled

startRoute

cancelRouting

getRoute

getPlan

takeRoute

takeRouteQuietly

removeRoute

isRouting

getStepCounter

canResumeNavigation

canResumeNavigation

resumeNavigation

setReroutePreferExisting

setAvoidUTurnMode

getErrorStr

isPositionFixed

getNaviData

startSimulation

startSimulationWithPlan

endSimulation

isInSimulation

pauseSimulation

resumeSimulation

isSimulationPaused

setSimulationSpeed

getSimulationSpeed

enableRepeatSimulation

isRepeatSimulationEnabled

setSimulationInterval

startRouteOverview

endRouteOverview

pauseNavi

resumeNavi

isNaviPaused

isInManualStartState

endManeualStartState

setNaviStartVoiceMode

getNaviStartVoiceMode

tryGrabSegments

grabSegment

setRouteUrlBase

setRouteTmcUrlBase

getRouteTmcUrlBase

setNav2TmcUrlBase

setGuidanceMode

enableSound

isSoundEnabled

enableOfflineCameraData

onLocationChanged

onSatelliteStatusChanged

onSatelliteStatusChanged

enableGps

isGpsEnabled

enableGpsSpeedZeroPolicy

isGpsSpeedZeroPolicyEnabled

setSignalLostDelay

useExperienceAccuracyForGps

isUsingExperienceAccuracyForGps

GPSIsInDebugMode

GPSDebuggerLoad

GPSDebuggerGetFrameNumber

GPSDebuggerSetFrameByIndex

GPSDebuggerPlay

GPSDebuggerPause

GPSDebuggerStop

GPSDebuggerSetSpeed

TTSEnumRoles

TTSGetRole