MapNavi

void

addAttentServerArea(int index)

添加关注的服务区。

boolean

addMapISAListener(MapISAListener listener)

添加ISA信息回调监听。

boolean

addMapNaviListener(MapNaviListener listener)

添加导航事件回调监听。

void

batchQuery(BatchQueryRequest request)

批量查询路线接口。

boolean

calculateAccessTypeOfTTS(DeliverConfigReqDTO deliverConfigReqDTO)

获取文本转语音引擎类型。提供接口供APP计算接入TTS方式

boolean

calculateBusDriveRoute(BusCqlRequest buscqlreques)

启动公交路线规划。

boolean

calculateCycleRoute(RoutingRequestParam requestParam)

计算骑行路径。

boolean

calculateCyclingGuide()

开始骑行引导计算，请求引导数据。

boolean

calculateDriveGuide()

开始驾车引导计算，请求引导数据。

boolean

calculateDriveRoute(RoutingRequestParam driveRequest)

计算驾车路径。

boolean

calculateRealTimeBusInfo(RealTimeTransitRequest realTimeTransitRequest)

查询实时公交信息是否成功。

boolean

calculateWalkGuide()

开始步行引导计算，请求引导数据。

boolean

calculateWalkRoute(RoutingRequestParam requestParam)

计算步行路径。

void

cancelBroadInfo(String broadText)

取消事件点播报。

boolean

changeRouteId(int id)

路线切换预选择路线。

void

clear()

释放导航数据信息，sdk功能继续可用。

void

clearAllAttentServerArea()

清空所有路线的服务区信息。

void

clearCurPathAttentServerArea()

清空当前路线的所有服务区信息。

void

destroy()

释放导航对象资源。

boolean

existAttentServerArea(int index)

查询对应索引的服务区是否已经添加到提醒。

Map<Integer, List<FurnitureInfo>>

getAllAttentServerArea()

获取所有路线的服务区信息。

List<String>

getCurPathFullBroadcastTextsRemovePercent()

获取当前线路除了含有%d的全量播报文本。

String

getFullScreenNaviVoiceText()

获取车道级引导大图播报文本。

boolean

getFutureEta(FutureEtaOptions options)

获取未来出行估时列表。

String

getGpsLostVoiceText()

获取GPS丢失的播报文本。

static final MapNavi

getInstance(Context context)

获取 MapNavi 实例对象。

String

getJamTTSText()

获取拥堵播报的播报文本。

MapNaviStaticInfo

getMapNaviStaticInfo()

获取导航统计信息。

MapNaviPath

getNaviPath()

获取当前路线。

HashMap<Integer, MapNaviPath>

getNaviPaths()

获取计算的多路径。

void

getReachableBoundary(NewEnergyRequest request)

新能源特性--获取可达边界和周边搜结果。

String

getSDKVersion()

获取SDK版本号。

VehicleType

getVehicleType()

获得导航引擎类型。

String

getVoiceByte(VoiceRequest voiceRequest)

获取文本转换的pcm语音流。

void

initLogSettings(boolean log2FileEnabled, String logFilePath)

初始化日志信息。

OfflineInitErrorCode

initOfflineMode(OfflineDataStateRequest request)

初始化离线数据。

void

initSettings(ClientParas clientParas)

初始化配置。

void

interruptsBusRequest()

取消公交路线规划请求的接口。

boolean

isAutoRefreshTrafficInfo()

是否启用了自动更新路况信息功能的状态。

static DayNightMsg

isDayTime(NaviLatLng latLng)

判断传入的经纬度地区当前所处白天还是黑夜的相关信息。

boolean

isDisplayETA()

获取是否显示ETA。

boolean

isRoutePathSelected(int id)

判断指定的路线ID是否被选择。

void

removeAttentServerArea(int index)

取消关注的服务区。

void

removeMapISAListener(MapISAListener listener)

移除ISA信息回调监听。

void

removeMapNaviListener(MapNaviListener listener)

移除导航事件回调监听。

void

searchAlongRoute(SearchAlongRequest request)

沿途搜接口。

boolean

selectRouteId(int id)

选择路线id。

void

setAccessToken(String token)

设置鉴权token。

void

setApiKey(String apiKey)

手动设置鉴权key。

void

setAutoRefreshTrafficInfo(boolean autoRefresh)

设置是否启用实时路况。

boolean

setBroadcastingType(BroadcastingType broadcastingType)

设置自定义播报模式是否成功。

void

setCameraRemindSwitch(final boolean cameraRemindSwitch)

设置摄像头提醒开关是否打开（只适用于驾车导航）。

void

setCoordinateSystem(String coordinateSystem)

设置坐标系。

void

setDevServerSite(@DevServerSiteConstant String devServerSite)

设置运营主体,需在实例化MapNavi后调用。

void

setEmulatorNaviSpeed(int speed)

设置模拟导航的速度值。

void

setEventPointBroad(NaviBroadInfo naviBroadInfo)

设置app生成的事件点。

boolean

setFstLanguage(String fstLanguage)

设置第一播报语言是否有效。

void

setGender(int gender)

设置男女声播报。

boolean

setLanguage(final String lang)

设置语言类型是否成功。

void

setLocationContext(Context context)

设置内置位置引擎的Context。

void

setNaviBroadSettingInfo(NaviBroadSettingInfo naviBroadSettingInfo)

导航中的播报相关设置。

boolean

setNaviOption(NaviOption option)

设置导航中选项。

boolean

setNaviSettings(Map<MapNaviSettingEnums, Object> settings)

设置导航相关配置。

boolean

setOfflineMode(boolean offlineMode)

设置离线模式优先。

boolean

setOfflineSpokenLanguage(String spkLang)

设置口语播报类型，用于离线语音读取。

void

setPrivateDestination(boolean privateDestination)

彩蛋终点开关。

void

setReportOMPSwitch(boolean isReport)

设置运维上报开关。

void

setRoadNameTTS(boolean roadNameTTS)

设置路名开关。

void

setScreenMode(String screenMode)

设置手机横竖屏模式。

boolean

setSecLanguage(String secLanguage)

设置第二播报语言是否有效。

void

setSendLocationListSwitch(boolean locationListSwitch)

设置轨迹是否上传。

void

setStopStartSupplementary(boolean stopStartSupplementary)

设置启停后新增播报。

void

setStrongStraightTTS(boolean strongStraightTTS)

设置强顺行（机动点的一种类型）语音播报开关。

void

setTrajShareSwitch(boolean opened)

设置轨迹分享给第三方。

void

setTtsPlaying(boolean isPlaying, int broadId)

设置app语音播报状态。

void

setTurningSupplementary(boolean turningSupplementary)

设置转向前新增播报。

void

setUnits(int pUnits)

设置播报数值的单位制式，英制/公制，默认公制。

boolean

setUseExtraLocationData(boolean extraLocationDataEnabled)

设置是否使用外部定位数据。

void

setUseExtraTTS(boolean extraTTSEnabled)

设置使用外部TTS。

boolean

setVehicleType(Vehicletype vehicletype)

设置交通类型。

boolean

startCruise(RoutingRequestParam cruiseParam)

进入巡航模式。

boolean

startISA(RoutingRequestParam isaParam)

进入ISA模式。

boolean

startLocation()

启动GPS定位，无参数。

boolean

startLocation(long time, int distance)

启动GPS定位,，带距离和时间参数。

boolean

startNavi(NaviMode naviMode)

开启导航。

void

stopCruise()

退出巡航模式。

void

stopISA()

退出ISA模式。

void

stopLocation()

停止GPS定位。

void

stopNavi()

停止导航。

void

switchParallelRoad(ParallelSwitchType type)

平行路切换。

boolean

updateExtraLocationData(android.location.Location location, double sensorBearing)

更新外部定位数据。

void

updateNetWorkTimeStamp(long timeStamp)

更新网络时间戳。

void

updateRoute(List<android.location.Location> startPoints)

导航中刷新路线。

void

updateWayPoints(List<NaviRequestPoint> wayPoints)

导航中更新途经点。

public void addAttentServerArea(int index)

您调用此API可以添加关注的服务区。被添加关注的服务区相比未被添加关注的服务区会多出一条特别提醒的播报。

index

服务区在服务区列表中的索引。

public boolean addMapISAListener(MapISAListener listener)

添加ISA信息回调监听。

listener

ISA信息监听对象。

public boolean addMapNaviListener(MapNaviListener listener)

添加导航事件回调监听。

listener

导航事件监听对象。

public void batchQuery(BatchQueryRequest request)

批量查询路线接口。

request

批量查询路线请求体，参见BatchQueryRequest。

public boolean calculateAccessTypeOfTTS(DeliverConfigReqDTO deliverConfigReqDTO)

获取文本转语音引擎类型，提供接口供CP计算接入TTS方式。

deliverConfigReqDTO

语音配置下发请求参数，参见DeliverConfigReqDTO。

public boolean calculateBusDriveRoute(BusCqlRequest busCqlRequest)

您调用此API可以获取是否启动公交路线规划，调用此接口前，请确认VehicleType已被正确配置。

busCqlRequest

与公交规划路线相关的参数，详细见BusCqlRequest。

boolean

返回true表示成功启动公交路线规划，false表示未成功启动公交路线规划。

public boolean calculateCycleRoute(RoutingRequestParam requestParam)

您调用此API可以获取是否启动骑行路线规划，调用此接口前，请确认VehicleType已被正确配置。

requestParam

与骑行规划路线相关的参数，详细见RoutingRequestParam。

boolean

返回true表示成功启动骑行路线规划，false表示未成功启动骑行路线规划。

public boolean calculateCyclingGuide()

您调用此API可以开始骑行引导计算，请在路径规划后调用，调用前确认VehicleType已被正确设置。

boolean

返回true表示引导计算执行成功，返回false表示引导计算执行失败。

public boolean calculateDriveGuide()

您调用此API可以开始驾车引导计算，请在路径规划后调用，调用前确认VehicleType已被正确设置。

boolean

返回true表示引导计算执行成功，返回false表示引导计算执行失败。

public boolean calculateDriveRoute(RoutingRequestParam driveRequest)

您调用此API可以获取是否启动驾车路线规划，调用此接口前，请确认VehicleType已被正确配置。

driveRequest

与驾车规划路线相关的参数，详细见RoutingRequestParam。

boolean

返回true表示成功启动驾车路线规划，false表示未成功启动驾车路线规划。

public boolean calculateRealTimeBusInfo(RealTimeTransitRequest realTimeTransitRequest)

您调用此API可以查询实时公交信息是否成功。

realTimeTransitRequest

实时公交信息请求类对象。

boolean

返回设置是否成功。

public boolean calculateWalkGuide()

您调用此API可以开始步行引导计算，请在路径规划后调用，调用前确认VehicleType已被正确设置。

boolean

返回true表示引导计算执行成功，返回false表示引导计算执行失败。

public boolean calculateWalkRoute(RoutingRequestParam requestParam)

您调用此API可以获取是否启动步行路线规划，调用此接口前，请确认VehicleType已被正确配置。

requestParam

与步行规划路线相关的参数，详细见RoutingRequestParam。

boolean

返回true表示成功启动步行路线规划，false表示未成功启动步行路线规划。

public void cancelBroadInfo(String broadText)

您调用此API可以取消事件点播报。

broadText

播报文本。

public boolean changeRouteId(int id)

您调用此API可以切换选择的路线。

id

路线id。

boolean

返回true表示切换备选路线成功，false表示切换备选路线失败。

public void clear()

释放导航数据信息，SDK功能继续可用 。

public void clearAllAttentServerArea()

您调用此API可以清空所有路线的服务区信息。

public void clearCurPathAttentServerArea()

您调用此API可以清空当前选中路线的所有服务区信息。

public void destroy()

释放导航对象资源。

public boolean existAttentServerArea(int index)

您调用此API可以查询对应索引的服务区是否已经添加到关注列表。

index

想要查询的服务区在服务区列表中的索引。

boolean

• true：已经设置到关注列表
• false：未设置到关注列表

public Map<Integer, List<FurnitureInfo>> getAllAttentServerArea()

您调用此API可以获取所有路线的服务区信息。

Map<Integer, List<FurnitureInfo>>

所有路线的服务区信息。即每条路线对应的服务区诱导点集合，诱导点见FurnitureInfo。

public List<String> getCurPathFullBroadcastTextsRemovePercent()

您调用此API可以获取当前线路除了含有%d的全量播报文本。

List<String>

当前线路除了含有%d的全量播报文本。

public String getFullScreenNaviVoiceText()

您调用此API可以获取车道级引导大图播报文本。

String

车道级引导大图播报文本。

public boolean getFutureEta(FutureEtaOptions options)

您调用此API可以获取未来出行估时列表。

options

未来出行估时参数设置类，参见FutureEtaOptions。

boolean

• true：发起请求成功
• false：发起请求失败

public String getGpsLostVoiceText()

您调用此API可以获取GPS丢失的播报文本。

String

GPS丢失的播报文本。

public static final MapNavi getInstance(android.content.Context context)

创建一个MapNavi导航对象，请在选择运营主体(setDevServerSite)初始化网络请求域名前调用创建mapNavi实例，并设置apiKey(setApiKey)。

context

上下文Context对象。

MapNavi

MapNavi对象。

public String getJamTTSText()

您调用此API可以获取拥堵播报的播报文本。

String

拥堵播报的播报文本。

public MapNaviStaticInfo getMapNaviStaticInfo()

您调用此API可以获取导航统计信息。

MapNaviStaticInfo

导航统计信息。

public MapNaviPath getNaviPath()

您调用此API可以获取当前步行或驾车的路线，当计算结果是多条路线时，获取被选择的路线。

MapNaviPath

返回当前步行或驾车路线的信息。

public HashMap<Integer, MapNaviPath> getNaviPaths()

您调用此API可以获得计算的多路径。

HashMap<Integer, MapNaviPath>

返回包含多条路线ID和路线对象的集合。

public void getReachableBoundary(NewEnergyRequest request)

新能源特性--获取可达边界和周边搜结果。

request

可达边界和周边搜请求信息类，详细见NewEnergyRequest。

public String getSDKVersion()

获取SDK版本号。

String

版本号。

public VehicleType getVehicleType()

获得导航引擎类型。

VehicleType

导航引擎类型。

public String getVoiceByte(VoiceRequest voiceRequest)

您调用此API可以将语音文本信息转化为pcm格式的语音流。

voiceRequest

文本转语音接口参数类，详细见VoiceRequest。

String

本次文本转pcm语音流请求的requestId。

public void initLogSettings(boolean log2FileEnabled, String logFilePath)

初始化日志信息。

public OfflineInitErrorCode initOfflineMode(OfflineDataStateRequest request)

您调用此API可以初始化离线数据。

request

离线导航初始化参数，详细见OfflineDataStateRequest。

OfflineInitErrorCode

离线导航初始化结果码。

public void initSettings(ClientParas clientParas)

初始化配置。

clientParas

ClientParas对象，三方调用NaviSDK时的初始化配置参数。

public void interruptsBusRequest()

您调用此API可以取消公交路线规划请求的接口。

public boolean isAutoRefreshTrafficInfo()

您调用此API可以判断是否启用了自动更新路况信息功能的状态。

boolean

是否启用了自动更新路况信息功能

• true：是
• false：否

public static DayNightMsg isDayTime(NaviLatLng latLng)

您调用此API可以判断当前经纬度地区处于白天还是黑夜。

latlng

需要做判断的经纬度值（判断此经纬度所在地是白天还是黑夜）。

DayNightMsg

白天黑夜信息的结果类。

public boolean isDisplayETA()

您调用此API可以获取是否显示ETA。

boolean

是否显示ETA

• true：是
• false：否

public boolean isRoutePathSelected(int id)

您调用此API可以判断指定的路线ID是否被选择。

id

指定的路线ID。

boolean

指定的路线ID是否被选择

• true：是
• false：否

public void removeAttentServerArea(int index)

您调用此API可以取消关注指定索引的服务区。

index

关注的服务区索引。

public void removeMapISAListener(MapISAListener listener)

移除ISA信息回调监听。

listener

ISA信息回调监听对象。

public void removeMapNaviListener(MapNaviListener listener)

移除导航事件回调监听。

listener

导航事件监听对象。

public void searchAlongRoute(SearchAlongRequest request)

沿途搜接口。

request

沿途搜请求信息类，参见SearchAlongRequest。

public boolean selectRouteId(int id)

您调用此API可以判断选择此路线是否成功。

id

选择当前路线的ID。

boolean

返回当前路线是否选择成功。

public void setAccessToken(String token)

设置鉴权token，申请参见获取API密钥，请对获取到的秘钥进行编码处理后传入。

token

鉴权token。

public void setApiKey(String apiKey)

手动设置鉴权key，申请参见获取API密钥，请对获取到的秘钥进行编码处理后传入。

apiKey

鉴权key。

public void setAutoRefreshTrafficInfo(boolean autoRefresh)

您调用此API可以设置是否启用实时路况功能。

autoRefresh

是否启用实时路况功能

• true:启用
• false:关闭

public boolean setBroadcastingType(BroadcastingType broadcastingType)

您调用此API可以设置自定义播报模式。

broadcastingType

播报模式配置信息对象。

boolean

返回设置是否成功。

public void setCameraRemindSwitch(final boolean cameraRemindSwitch)

您调用此API可以设置摄像头提醒开关是否打开。

cameraRemindSwitch

摄像头提醒开关是否打开

• true：打开
• false：关闭

public void setCoordinateSystem(String coordinateSystem)

您调用此API可以设置坐标系

coordinateSystem

坐标系参数

• WGS-84
• GCJ-02

public void setDevServerSite( @DevServerSiteConstant String devServerSite)

设置运营主体，需在实例化MapNavi后调用。

devServerSite

运营主体的服务器站点。

public void setEmulatorNaviSpeed(int speed)

您调用此API可以设置模拟导航的速度值。

speed

模拟导航的速度值，单位：km/h。

public void setEventPointBroad(NaviBroadInfo naviBroadInfo)

您调用此API可以设置app生成的事件点，目前只有gps信号丢失。

naviBroadInfo

播报信息类，参见NaviBroadInfo。

public boolean setFstLanguage(String fstLanguage)

您调用此API可以设置第一语言获取路名。

fstLanguage

第一播报语言，目前暂时只支持中英文,默认英文

• en-us : 英文
• zh-CN ：中文

boolean

返回设置是否成功。

public void setGender(int gender)

您调用此API可以设置语音播报的声音。

gender

语音播报声音的类型

• 0: 女声
• 1：男声

public boolean setLanguage(final String lang)

您调用此API可以设置语言类型,用于服务端构造播报文本。

lang

语言类型,用于服务端构造播报文本,目前暂时只支持中英文,默认英文

• en-us : 英文
• zh-CN ：中文

boolean

返回设置是否成功

• true: 是
• false：否

public void setLocationContext(Context context)

您调用此API可以设置内置位置引擎的Context，使用外部灌点可不调用此API，内部灌点必须在导航前调用此API, 灌点设置接口见setUseExtraLocationData。

context

上下文Context对象。

public void setNaviBroadSettingInfo(NaviBroadSettingInfo naviBroadSettingInfo)

您调用此API可以进行导航中的相关播报设置。

naviBroadSettingInfo

导航中的相关播报的实体类。

public boolean setNaviOption(NaviOption option)

您调用此API可以设置导航中选项，实时生效。

option

导航中选项设置类，参见NaviOption。

boolean

返回设置是否成功

• true : 是
• false ：否

public boolean setNaviSettings(Map<MapNaviSettingEnums, Object> settings)

您调用此API可以设置导航相关配置。

settings

导航相关配置，参见MapNaviSettingEnums。

boolean

返回设置是否成功

• true : 是
• false ：否

public boolean setOfflineMode(boolean offlineMode)

您调用此API可以设置离线模式优先。

offlineMode

• true：设置离线导航优先。
• false：设置在线导航优先。

  默认值为false

boolean

• true：成功设置了离线导航优先
• false：没有成功设置离线导航优先

public boolean setOfflineSpokenLanguage(String spkLang)

您调用此API可以设置导航口语播报类型，仅在离线语音读取中使用，优先判断是否使用口语类型，在未设置口语类型的情况下会使用一般语言类型，设置一般语言类型请参见setLanguage(String lang)。

spkLang

口语语言类型。

boolean

• true：成功设置了口语类型
• false：没有成功设置口语类型

public void setPrivateDestination(boolean privateDestination)

设置彩蛋终点开关。

privateDestination

设置彩蛋终点开关是否打开

• true：打开
• false：关闭

默认值false

public void setReportOMPSwitch(boolean isReport)

设置运维上报开关。

isReport

设置运维上报开关是否打开

• true：打开
• false：关闭

默认值false

public void setRoadNameTTS(boolean roadNameTTS)

设置路名开关。

roadNameTTS

设置路名开关是否打开

• true：打开
• false：关闭

默认值false

public void setScreenMode(String screenMode)

您调用此API可以设置手机的横竖屏模式。

screenMode

手机的横竖屏模式：

• ScreenModeConstants.SCR_VERTICAL_MODE : 横屏模式
• ScreenModeConstants.SCR_HORIZONTAL_MODE : 竖屏模式

public boolean setSecLanguage(String secLanguage)

您调用此API可以设置第二语言获取路名。

secLanguage

第二播报语言。

boolean

返回设置是否成功。

public void setSendLocationListSwitch(boolean locationListSwitch)

您调用此API可以设置轨迹是否上传。

locationListSwitch

轨迹上传开启开关

• true : 开启上传
• false ：关闭上传

public void setStopStartSupplementary(boolean stopStartSupplementary)

您调用此API可以设置启停后新增播报。

stopStartSupplementary

是否新增播报

• true : 是
• false ：否

public void setStrongStraightTTS(boolean strongStraightTTS)

您调用此API可以设置强顺行（机动点的一种类型）语音播报开关。

strongStraightTTS

是否开启强顺行机动点播报

• true : 是
• false ：否

public void setTrajShareSwitch(boolean opened)

您调用此API可以 设置轨迹开放共享给第三方。

opened

轨迹开放共享开关

• true : 开启共享
• false ：关闭共享

public void setTtsPlaying(boolean isPlaying, int broadId)

您调用此API可以设置app语音播报状态。

isPlaying

是否正在播报

• true : 是
• false ：否

broadId

播报id

public void setTurningSupplementary(boolean turningSupplementary)

您调用此API可以设置转向前新增播报。

turningSupplementary

是否新增播报

• true : 是
• false ：否

public void setUnits(int pUnits)

您调用此API可以设置播报数值的单位制式,英制/公制，默认公制。

pUnits

单位制式

• 0：公制
• 1：英制

public boolean setUseExtraLocationData(boolean extraLocationDataEnabled)

您调用此API可以设置是否使用外部定位数据。

extraLocationDataEnabled

是否使用外部定位数据。

boolean

是否开启外部定位数据

• true：开启
• false：未开启

public void setUseExtraTTS(boolean extraTTSEnabled)

您调用此API可以设置使用外部TTS。

extraTTSEnabled

是否使用外部TTS文本数据

• true : 只提供TTS文本数据，不提供默认TTS播报
• false ：SDK只提供文本，不提供TTS播报，集成方自己实现播报能力

public boolean setVehicleType(VehicleType vehicleType)

您调用此API可以设置交通类型。

vehicleType

交通工具类型，分为驾车、步行、骑行和公交。

boolean

返回设置交通类型是否成功，true表示成功，false表示失败。

public boolean startCruise(RoutingRequestParam cruiseParam)

您调用此API可以进入巡航模式。

cruiseParam

巡航模式规划参数类，包含是否用户手动操作，连续位置点、路况、摄像头开关等一类控制参数，参见RoutingRequestParam。