#import <MBNaviSession.h>

类 MBNaviSession 继承关系图:

构造函数
(void)	- setTTSRole:

(void)	- enableModule:enable:

(BOOL)	- isModuleEnabled:

(void)	- startRoute:routeMethod:

(void)	- startRoute:avoidRoadType:

(void)	- cancelRouting

(MBRouteBase *)	- getRoute

(MBRoutePlan *)	- getPlan

(void)	- takeRoute:

(void)	- removeRoute

(BOOL)	- isRouting

(NSInteger)	- getStepCounter

(BOOL)	- canResumeNavigation:

(void)	- resumeNavigation

(NSString *)	- getErrorStr

((deprecated("准备废弃此方法")	- __attribute__

(void)	- startSimulation

(void)	- startSimulationWithPlan:

(void)	- endSimulation

(BOOL)	- isInSimulation

(void)	- pauseSimulation

(void)	- resumeSimulation

(BOOL)	- isSimulationPaused

(void)	- setSimulationSpeed:

(float)	- getSimulationSpeed

(void)	- enableRepeatSimulation:

(BOOL)	- isRepeatSimulationEnabled

(void)	- setSimulationInterval:

(void)	- startRouteOverview

(void)	- endRouteOverview

(void)	- pauseNavi

(void)	- resumeNavi

(BOOL)	- isNaviPaused

(BOOL)	- isInManualStartState

(void)	- endManualStartState

(void)	- updateSessionTracking

(BOOL)	- tryGrabSegments:ori:

(void)	- setRouteUrlBase:

(void)	- setGuidanceMode:

(void)	- setCameraMode:

(void)	- disableOfflineCamera

((deprecated("已废弃此方法")	- __attribute__

((deprecated("已废弃此方法")	- __attribute__

((deprecated("已废弃此方法")	- __attribute__

(BOOL)	- isPositionFixed

(void)	- setAvoidUTurnMode:

(void)	- setReroutePreferExisting:

(void)	- setRouteRequestCallback:userdata:

(void)	- setRouteResponseCallback:userdata:

(void)	- setRouteRequestBlock:

(void)	- setRouteResponseBlock:

类方法
(instancetype)	+ sharedInstance

(void)	+ cleanup

Public 属性
LiaoNingRouteRequest	_routeRequestBlock

LiaoNingRouteResponse	_routeResponseBlock

属性
MBNaviSessionParams *	params

MBSdkAuthError	authErrorType

NSString *	tmcUrlBase

NSString *	tiUrlBase

BOOL	enableCamera

BOOL	customize4LiaoNing

id< MBNaviSessionDelegate >	delegate

MBDataPreference	navPreference

MBNaviSessionNaviStartVoiceMode	naviStartVoiceMode

MBRouteCollection *	routes

MBNaviSessionData *	sessionData

MBNaviSessionSmoothData *	smoothData

BOOL	enableSound

详细描述

导航API，该模块需要先初始化 MBGpsTracker

函数文档

◆ attribute() [1/4]

- ((deprecated("准备废弃此方法") __attribute__

用于获取导航实时数据 [路线规划]

返回: NaviSessionData 导航实时数据对象一般情况下，在回调函数中的tracking事件会返回NaviSessionData对象此对象即表示当前实时导航信息，不需要手动调用此方法获取实时信息

◆ attribute() [2/4]

- ((deprecated("已废弃此方法") __attribute__

获取电子眼数据的授权验证结果废弃

返回: 授权结果，参见MBAuthError

◆ attribute() [3/4]

- ((deprecated("已废弃此方法") __attribute__

初始化引擎后，判断当前已经加载的电子眼数据状态废弃

返回: 电子眼数据状态,MBCameraDataState

◆ attribute() [4/4]

- ((deprecated("已废弃此方法") __attribute__

是否为VIP摄像头数据

◆ cancelRouting()

- (void) cancelRouting

取消正在进行的路线规划计算 [路线规划]

◆ canResumeNavigation:()

- (BOOL) canResumeNavigation: (MBRoutePlan *) plan

是否有上次运行留下来的路线计划文件可用于恢复导航 [路线规划]

返回: BOOL

◆ cleanup()

+ (void) cleanup

导航单例销毁

自从: 5.0.x

◆ disableOfflineCamera()

- (void) disableOfflineCamera

关闭离线电子眼

◆ enableModule:enable:()

- (void) enableModule:	(MBNaviSessionModule)	module
enable:	(BOOL)	enable

打开/关闭某个/某些子模块 [子模块管理]

参数

module	子模块
enable	是否开启

◆ enableRepeatSimulation:()

- (void) enableRepeatSimulation: (BOOL) enable

设置模拟导航是否循环模拟 [模拟导航]

参数

enable 设置为YES则表示循环模拟，设置为NO表示单次模拟

◆ endManualStartState()

- (void) endManualStartState

结束手动起点状态 [手动起点状态]

◆ endRouteOverview()

- (void) endRouteOverview

用于结束道路的地图呈现 [Route overview]

◆ endSimulation()

- (void) endSimulation

终止模拟导航 [模拟导航]

◆ getErrorStr()

- (NSString *) getErrorStr

获取算路异常时错误信息 [路线规划]

返回: 返回当前算路错误的信息字串

◆ getPlan()

- (MBRoutePlan *) getPlan

获取当前的路线计划(只读)线 [路线规划]

返回: RoutePlan

◆ getRoute()

- (MBRouteBase *) getRoute

获取当前路线 [路线规划]

返回: RouteBase

◆ getSimulationSpeed()

- (float) getSimulationSpeed

获取模拟导航的速度倍数 [模拟导航]

◆ getStepCounter()

- (NSInteger) getStepCounter

获取算路步数计数器的值 [路线规划]

返回: 算路步数计数器的值

◆ isInManualStartState()

- (BOOL) isInManualStartState

判断当前是否为手动起点状态 [手动起点状态]

返回: 如果当前处于手动起点状态返回YES，否则返回NO 所谓“手动起点状态”。就是说不采用GPS定位点为起点，而是手动设置的起点。此时虽然偏航，但是并不会引起重新计算

◆ isInSimulation()

- (BOOL) isInSimulation

是否在模拟导航状态 [模拟导航]

返回: 如果处于模拟导航模式中返回YES，否则返回NO 模拟导航暂停时，仍然在模拟导航状态

◆ isModuleEnabled:()

- (BOOL) isModuleEnabled: (MBNaviSessionModule) module

判断指定的子模块是否已打开 [子模块管理]

参数

module 子模块

返回: enable 是否开启

参见: - enableModule:enable:

◆ isNaviPaused()

- (BOOL) isNaviPaused

真实导航是否已暂停 [Pause and resume]

◆ isPositionFixed()

- (BOOL) isPositionFixed

判断当前引擎是否处在定位状态

返回: YES即定位

◆ isRepeatSimulationEnabled()

- (BOOL) isRepeatSimulationEnabled

模拟导航是否循环模拟 [模拟导航]

返回: 如果此时为循环模拟，返回YES，否则返回NO

◆ isRouting()

- (BOOL) isRouting

当前是否正在算路中 [路线规划]

◆ isSimulationPaused()

- (BOOL) isSimulationPaused

是否在模拟导航暂停状态 [模拟导航]

返回: 是否当前已经暂停了模拟导航状态，已经暂停返回YES，否则返回NO

◆ pauseNavi()

- (void) pauseNavi

暂停真实导航 [Pause and resume]

此函数使用了引用计数。注意要保证与 NaviSession_resumeNavi() 成对使用

◆ pauseSimulation()

- (void) pauseSimulation

暂停模拟导航 [模拟导航]

◆ removeRoute()

- (void) removeRoute

删除当前路线，以及路线计划文件 [路线规划]，也就是停止导航。对应 takeRoute: 方法。

◆ resumeNavi()

- (void) resumeNavi

恢复真实导航 [Pause and resume]

◆ resumeNavigation()

- (void) resumeNavigation

使用上次运行留下来的路线计划文件恢复导航 [路线规划]

◆ resumeSimulation()

- (void) resumeSimulation

恢复模拟导航 [模拟导航]

◆ setAvoidUTurnMode:()

- (void) setAvoidUTurnMode: (MBAvoidUTurnMode) mode

设置防调头模式

参数

mode	MBAvoidUTurnMode

◆ setCameraMode:()

- (void) setCameraMode: (MBCameraFilterMode) mode

设置电子眼播报模式

参数

mode	要设置的电子眼播报模式：简单、标准、全部。

◆ setGuidanceMode:()

- (void) setGuidanceMode: (MBGuidanceMode) mode

设置语音播报模式

参数

[in] mode 要设置的语音播报模式：简介、标准、安全。

◆ setReroutePreferExisting:()

- (void) setReroutePreferExisting: (BOOL) prefer

设置偏航重计算的结果是否倾向于与原有路线相似此接口的需求来自这样的应用场景：用户在“单规则多结果”算路方式下选择了非第一条路线作为当前路线进行导航，但在起点附近很快就发生了偏航重计算，此时用户希望重计算的结果仍然是之前选择的路线。此接口设置为 true后可能带来的副作用是重计算结果立刻要掉头的概率会更大一些。

参数

prefer YES表示尽可能相似。

◆ setRouteRequestBlock:()

- (void) setRouteRequestBlock: (LiaoNingRouteRequest) requestBlock

◆ setRouteRequestCallback:userdata:()

- (void) setRouteRequestCallback:	(MBRouteRequestCallback)	callback
userdata:	(void *)	data

◆ setRouteResponseBlock:()

- (void) setRouteResponseBlock: (LiaoNingRouteResponse) responseBlock

◆ setRouteResponseCallback:userdata:()

- (void) setRouteResponseCallback:	(MBRouteResponseCallback)	callback
userdata:	(void *)	data

◆ setRouteUrlBase:()

- (void) setRouteUrlBase: (NSString *) urlBase

设置在线算路服务器URL

参数

urlBase 服务器URL地址

◆ setSimulationInterval:()

- (void) setSimulationInterval: (uint) milliseconds

设置模拟导航刷新的时间步长 [模拟导航]

参数

milliseconds 设置模拟导航刷新的间隔时间，单位为毫秒(ms)

◆ setSimulationSpeed:()

- (void) setSimulationSpeed: (float) speed

设置模拟导航的速度倍数 [模拟导航]

参数

speed 当前的速度等级(相对于基础速度的百分比) 1.0,2.0 ...

◆ setTTSRole:()

- (void) setTTSRole: (NSUInteger) value

设置语音方言

参数

value 方言类型，参见 MBTTS_PARAM_SPEAKER

自从: 5.0.x

◆ sharedInstance()

+ (instancetype) sharedInstance

获取导航的单例对象，得到后需要设置 MBNaviSessionParams 才能正常使用相关导航功能

返回: MBNaviSession 对象

◆ startRoute:avoidRoadType:()

- (void) startRoute:	(const MBRoutePlan *)	newPlan
avoidRoadType:	(MBRouteRule)	type

使用指定的路线规则开始算路,返回1~3条结果 [路线规划]

参数

newPlan	指定的路线计划
type	用“系统推荐”、“距离优先”、“高速优先”、“避让收费”的一种规则算多条路。

算路开始后，典型地，调用者会收到以下事件：1条 NaviSessionEvent_routeStarted 若干条 NaviSessionEvent_routing 1条 NaviSessionEvent_routeComplete 或 NaviSessionEvent_routeFailed 或 NaviSessionEvent_routeCancelled

◆ startRoute:routeMethod:()

- (void) startRoute:	(const MBRoutePlan *)	newPlan
routeMethod:	(MBNaviSessionRouteMethod)	method

使用指定的路线计划开始算路 [路线规划]

参数

newPlan	指定的路线计划
method	算路方法：是只算一条路，是用多种规则计算多条路，还是用一种规则算多条路。

参见: - cancelRouting:

注解: 算路开始后，典型地，调用者会收到以下事件：1条 NaviSessionEvent_routeStarted 若干条 NaviSessionEvent_routing 1条 NaviSessionEvent_routeComplete 或 NaviSessionEvent_routeFailed 或 NaviSessionEvent_routeCancelled

◆ startRouteOverview()

- (void) startRouteOverview

用于在地图上呈现当前算的路线 [Route overview]

◆ startSimulation()

- (void) startSimulation

开始模拟导航 [模拟导航]

◆ startSimulationWithPlan:()

- (void) startSimulationWithPlan: (MBRoutePlan *) plan

用指定的 RoutePlan 启动实景模拟功能 [模拟导航]

参数

plan	指定的路线计划会暂时强制启用路口放大图功能

◆ takeRoute:()

- (void) takeRoute: (MBRouteBase *) route

采纳指定的路线，将其设为当前路线，用于导航和模拟导航 [路线规划]

参数

route 路线的基本信息

◆ tryGrabSegments:ori:()

- (BOOL) tryGrabSegments:	(MBPoint *)	pos
ori:	(short)	ori

测试根据给定的坐标和方向是否能抓路 [Misc]

参数

pos	给定的坐标点
ori	给定的方向

返回: 如果能成功抓路则返回YES，否则返回NO

◆ updateSessionTracking()

- (void) updateSessionTracking

更新导航数据

类成员变量说明

◆ _routeRequestBlock

- (LiaoNingRouteRequest) _routeRequestBlock

◆ _routeResponseBlock

- (LiaoNingRouteResponse) _routeResponseBlock

属性说明

◆ authErrorType

- (MBSdkAuthError) authErrorType

readnonatomicassign

导航授权

◆ customize4LiaoNing

- (BOOL) customize4LiaoNing

readwritenonatomicassign

◆ delegate

- (id<MBNaviSessionDelegate>) delegate

readwritenonatomicweak

导航代理

◆ enableCamera

- (BOOL) enableCamera

readwritenonatomicassign

是否启用摄像头播报

◆ enableSound

- (BOOL) enableSound

readwritenonatomicassign

◆ naviStartVoiceMode

- (MBNaviSessionNaviStartVoiceMode) naviStartVoiceMode

readwritenonatomicassign

设置“导航开始语音模式”，“导航开始语音模式”的设置会影响导航开始以及模拟导航开始时的语音播报内容。缺省值为 MBNaviSessionNaviStartVoiceMode_pnd

◆ navPreference

- (MBDataPreference) navPreference

readwritenonatomicassign

◆ params

- (MBNaviSessionParams*) params

readwritenonatomicstrong

设置导航相关参数

◆ routes

- (MBRouteCollection*) routes

readnonatomicstrong

近期导航得到的路线

◆ sessionData

- (MBNaviSessionData*) sessionData

readnonatomicstrong

近期导航得到的数据

◆ smoothData

- (MBNaviSessionSmoothData*) smoothData

readnonatomicstrong

近期导航得到的平滑数据

◆ tiUrlBase

- (NSString*) tiUrlBase

readwritenonatomiccopy

设置路况接口的url

◆ tmcUrlBase

- (NSString*) tmcUrlBase

readwritenonatomiccopy

设置蚯蚓路tmc状态获取接口的url,默认值："http://search.api.mapbar.com/tmc/getTmc.jsp"

该类的文档由以下文件生成:

/Users/zcl/Downloads/iNaviCore.framework/Versions/A/Headers/MBNaviSession.h

构造函数

类方法

Public 属性

属性

详细描述

函数文档

◆ __attribute__() [1/4]

◆ __attribute__() [2/4]

◆ __attribute__() [3/4]

◆ __attribute__() [4/4]

◆ cancelRouting()

◆ canResumeNavigation:()

◆ cleanup()

◆ disableOfflineCamera()

◆ enableModule:enable:()

◆ enableRepeatSimulation:()

◆ endManualStartState()

◆ endRouteOverview()

◆ endSimulation()

◆ getErrorStr()

◆ getPlan()

◆ getRoute()

◆ getSimulationSpeed()

◆ getStepCounter()

◆ isInManualStartState()

◆ isInSimulation()

◆ isModuleEnabled:()

◆ isNaviPaused()

◆ isPositionFixed()

◆ isRepeatSimulationEnabled()

◆ isRouting()

◆ isSimulationPaused()

◆ pauseNavi()

◆ pauseSimulation()

◆ removeRoute()

◆ resumeNavi()

◆ resumeNavigation()

◆ resumeSimulation()

◆ setAvoidUTurnMode:()

◆ setCameraMode:()

◆ setGuidanceMode:()

◆ setReroutePreferExisting:()

◆ setRouteRequestBlock:()

◆ setRouteRequestCallback:userdata:()

◆ setRouteResponseBlock:()

◆ setRouteResponseCallback:userdata:()

◆ setRouteUrlBase:()

◆ setSimulationInterval:()

◆ setSimulationSpeed:()

◆ setTTSRole:()

◆ sharedInstance()

◆ startRoute:avoidRoadType:()

◆ startRoute:routeMethod:()

◆ startRouteOverview()

◆ startSimulation()

◆ startSimulationWithPlan:()

◆ takeRoute:()

◆ tryGrabSegments:ori:()

◆ updateSessionTracking()

类成员变量说明

◆ _routeRequestBlock

◆ _routeResponseBlock

属性说明

◆ authErrorType

◆ customize4LiaoNing

◆ delegate

◆ enableCamera

◆ enableSound

◆ naviStartVoiceMode

◆ navPreference

◆ params

◆ routes

◆ sessionData

◆ smoothData

◆ tiUrlBase

◆ tmcUrlBase

◆ attribute() [1/4]

◆ attribute() [2/4]

◆ attribute() [3/4]

◆ attribute() [4/4]