类 LocationClientOption
- java.lang.Object
-
- com.baidu.location.LocationClientOption
-
public final class LocationClientOption extends java.lang.Object
配置定位SDK各配置参数,比如定位模式、定位时间间隔、坐标系类型等
-
-
嵌套类概要
嵌套类 修饰符和类型 类 说明 static class
LocationClientOption.BDLocationPurpose
定位场景枚举,目前抽象有三种场景:签到、出行、运动;开发者可以通过直接设置所需要的定位场景类型,快速配置定位参数static class
LocationClientOption.FirstLocType
定位类型 SPEED_IN_FIRST_LOC:速度优先,ACCURACY_IN_FIRST_LOC:准确性优先static class
LocationClientOption.LocationMode
定位模式 分为高精度定位模式 低功耗定位模式 仅设备定位模式 模糊定位模式 高精度定位模式:这种定位模式下,会同时使用网络定位和GNSS定位,优先返回最高精度的定位结果; 低功耗定位模式:这种定位模式下,不会使用GNSS,只会使用网络定位(Wi-Fi和基站定位) 仅用设备定位模式:这种定位模式下,不需要连接网络,只使用GNSS进行定位,这种模式下不支持室内环境的定位 模糊定位模式:这种定位模式下,不会获取GNSS与Wi-Fi信息,只会使用基站信息进行定位
-
字段概要
-
构造器概要
构造器 构造器 说明 LocationClientOption()
LocationClientOption(LocationClientOption lOption)
-
方法概要
所有方法 实例方法 具体方法 修饰符和类型 方法 说明 java.lang.String
getAddrType()
获取地址信息设置int
getAutoNotifyMinDistance()
获取自动回调模式下设置的回调位置的距离差值int
getAutoNotifyMinTimeInterval()
获取自动回调模式下允许的最短定位时间间隔java.lang.String
getCoorType()
获得当前设置的坐标类型LocationClientOption.LocationMode
getLocationMode()
获取当前的定位模式int
getPriority()
java.lang.String
getProdName()
获取设置的Prod字段值int
getScanSpan()
获取 设置的扫描间隔,单位是毫秒boolean
isLocationNotify()
判断是否设置了位置noifyboolean
isOnceLocation()
判断是否设置了单次定位boolean
isOpenGnss()
是否打开gnss进行定位boolean
optionEquals(LocationClientOption opt)
void
setCoorType(java.lang.String coorType)
设置坐标类型void
setEnableSimulateGnss(boolean enableSimulateGnss)
设置是否允许模拟GNSS true:允许; false:不允许,默认为falsevoid
setFirstLocType(LocationClientOption.FirstLocType firstLocType)
设置首次定位类型。void
SetIgnoreCacheException(boolean cacheException)
设置是否进行异常捕捉 true:不捕捉异常;false:捕捉异常,默认为truevoid
setIgnoreKillProcess(boolean killProcess)
设置是否退出定位进程 true:不退出进程; false:退出进程,默认为truevoid
setIsEnableBeidouMode(boolean value)
设置是否只开启北斗卫星定位功能,该功能只在部分软硬件符合要求的手机上起作用;开放平台公开版本不起作用void
setIsNeedAddress(boolean isNeed)
设置是否需要地址信息,默认为无地址。void
setIsNeedAltitude(boolean isNeedAltitude)
设置是否需要返回海拔高度信息,可以在BDLocation.getAltitude()中得到数据,GNSS定位结果中默认返回,默认值Double.MIN_VALUEvoid
setIsNeedLocationDescribe(boolean isNeedLocationDescribe)
设置是否需要返回位置语义化信息,可以在BDLocation.getLocationDescribe()中得到数据,ex:"在天安门附近", 可以用作地址信息的补充void
setIsNeedLocationPoiList(boolean isNeedLocationPoiList)
设置是否需要返回位置POI信息,可以在BDLocation.getPoiList()中得到数据void
setLocationMode(LocationClientOption.LocationMode mode)
设置定位模式void
setLocationNotify(boolean notify)
设置是否进行位置提醒void
setLocationPurpose(LocationClientOption.BDLocationPurpose locationPurpose)
设置定位场景,根据定位场景快速生成对应的定位参数void
setLocStatus(boolean isLocPermissionOn)
设置定位开关及权限状态值void
setNeedDeviceDirect(boolean isNeedDeviceDirect)
在网络定位时,是否需要设备方向 true:需要 ; false:不需要。void
setNeedNewVersionRgc(boolean isNeedNewVersionRgc)
是否需要最新版本的地址信息 true:需要 ; false:不需要。void
setOnceLocation(boolean isOnceLocation)
设置是否进行单次定位,单次定位时调用start之后会默认返回一次定位结果void
setOpenAutoNotifyMode()
设置打开自动回调位置模式,该开关打开后,期间只要定位SDK检测到位置变化就会主动回调给开发者,该模式下开发者无需再关心定位间隔是多少,定位SDK本身发现位置变化就会及时回调给开发者void
setOpenAutoNotifyMode(int minTimeInterval, int minDistance, int locSensitivity)
设置打开自动回调位置模式,该开关打开后,期间只要定位SDK检测到位置变化就会主动回调给开发者void
setOpenGnss(boolean openGnss)
设置是否打开gnss进行定位void
setProdName(java.lang.String prodName)
设置Prod字段值void
setScanSpan(int scanSpan)
设置扫描间隔,单位是毫秒 当<1000(1s)时,定时定位无效void
setWifiCacheTimeOut(int timeout)
设置wifi缓存超时时间阈值,超过该阈值,首次定位将会主动扫描wifi以使得定位精准度提高,定位速度会有所下降,具体延时取决于wifi扫描时间,大约是1-3秒
-
-
-
字段详细资料
-
MIN_SCAN_SPAN
public static final int MIN_SCAN_SPAN
- 另请参阅:
- 常量字段值
-
GPS_FIRST
public static final int GPS_FIRST
- 另请参阅:
- 常量字段值
-
coorType
public java.lang.String coorType
-
addrType
public java.lang.String addrType
-
openGps
public boolean openGps
-
scanSpan
public int scanSpan
-
timeOut
public int timeOut
-
prodName
public java.lang.String prodName
-
priority
public int priority
-
location_change_notify
public boolean location_change_notify
-
disableLocCache
public boolean disableLocCache
-
enableSimulateGps
public boolean enableSimulateGps
-
serviceName
public java.lang.String serviceName
-
isIgnoreCacheException
public boolean isIgnoreCacheException
-
isIgnoreKillProcess
public boolean isIgnoreKillProcess
-
mIsNeedDeviceDirect
public boolean mIsNeedDeviceDirect
-
isNeedAptag
public boolean isNeedAptag
-
isNeedAptagd
public boolean isNeedAptagd
-
isNeedPoiRegion
public boolean isNeedPoiRegion
-
isNeedRegular
public boolean isNeedRegular
-
isNeedAltitude
public boolean isNeedAltitude
-
isNeedNewVersionRgc
public boolean isNeedNewVersionRgc
-
isOnceLocation
public boolean isOnceLocation
-
mLocationMode
protected LocationClientOption.LocationMode mLocationMode
-
LOC_SENSITIVITY_HIGHT
public static final int LOC_SENSITIVITY_HIGHT
- 另请参阅:
- 常量字段值
-
LOC_SENSITIVITY_MIDDLE
public static final int LOC_SENSITIVITY_MIDDLE
- 另请参阅:
- 常量字段值
-
LOC_SENSITIVITY_LOW
public static final int LOC_SENSITIVITY_LOW
- 另请参阅:
- 常量字段值
-
MIN_AUTO_NOTIFY_INTERVAL
public static final int MIN_AUTO_NOTIFY_INTERVAL
- 另请参阅:
- 常量字段值
-
GPS_ONLY
public static final int GPS_ONLY
- 另请参阅:
- 常量字段值
-
NETWORK_FIRST
public static final int NETWORK_FIRST
- 另请参阅:
- 常量字段值
-
FUZZY_MODE
public static final int FUZZY_MODE
- 另请参阅:
- 常量字段值
-
autoNotifyMaxInterval
public int autoNotifyMaxInterval
-
autoNotifyLocSensitivity
public float autoNotifyLocSensitivity
-
autoNotifyMinTimeInterval
public int autoNotifyMinTimeInterval
-
autoNotifyMinDistance
public int autoNotifyMinDistance
-
wifiCacheTimeOut
public int wifiCacheTimeOut
-
locLegalStatus
public int locLegalStatus
-
isEnableBeidouMode
public boolean isEnableBeidouMode
-
firstLocType
public LocationClientOption.FirstLocType firstLocType
-
-
构造器详细资料
-
LocationClientOption
public LocationClientOption()
-
LocationClientOption
public LocationClientOption(LocationClientOption lOption)
-
-
方法详细资料
-
optionEquals
public boolean optionEquals(LocationClientOption opt)
-
getCoorType
public java.lang.String getCoorType()
获得当前设置的坐标类型- 返回:
- String 坐标系类型
-
setCoorType
public void setCoorType(java.lang.String coorType)
设置坐标类型- 参数:
coorType
- 取值有3个: 返回国测局经纬度坐标系:gcj02 返回百度墨卡托坐标系 :bd09 返回百度经纬度坐标系 :bd09ll
-
getAddrType
public java.lang.String getAddrType()
获取地址信息设置- 返回:
- String 地址配置
-
setIsNeedAddress
public void setIsNeedAddress(boolean isNeed)
设置是否需要地址信息,默认为无地址。 在设备获取gnss位置的时候,对应的地址信息不会马上返回,因为gnss是直接在本地产生,但地址信息需要从云端获取,是个异步过程,开发者在接收定位返回数据的时候,建议不要立即stop定位sdk以等待数据回调- 参数:
isNeed
- 是否需要地址信息- 从以下版本开始:
- 4.1
-
setIsEnableBeidouMode
public void setIsEnableBeidouMode(boolean value)
设置是否只开启北斗卫星定位功能,该功能只在部分软硬件符合要求的手机上起作用;开放平台公开版本不起作用- 参数:
value
-
-
setLocStatus
public void setLocStatus(boolean isLocPermissionOn)
设置定位开关及权限状态值- 参数:
isLocPermissionOn
- 布尔值
-
setWifiCacheTimeOut
public void setWifiCacheTimeOut(int timeout)
设置wifi缓存超时时间阈值,超过该阈值,首次定位将会主动扫描wifi以使得定位精准度提高,定位速度会有所下降,具体延时取决于wifi扫描时间,大约是1-3秒- 参数:
timeout
- wifi缓存超时时间阈值,单位毫秒,最小值10000ms
-
isOpenGnss
public boolean isOpenGnss()
是否打开gnss进行定位- 返回:
- boolean
-
setOpenGnss
public void setOpenGnss(boolean openGnss)
设置是否打开gnss进行定位- 参数:
openGnss
- 是否打开GNSS
-
setLocationPurpose
public void setLocationPurpose(LocationClientOption.BDLocationPurpose locationPurpose)
设置定位场景,根据定位场景快速生成对应的定位参数- 参数:
locationPurpose
-
-
isLocationNotify
public boolean isLocationNotify()
判断是否设置了位置noify
-
setLocationNotify
public void setLocationNotify(boolean notify)
设置是否进行位置提醒- 参数:
notify
- 是否位置提醒,true的情况下收到gps会一秒回调一次,无论配置的scanspan是多少
-
isOnceLocation
public boolean isOnceLocation()
判断是否设置了单次定位
-
setOnceLocation
public void setOnceLocation(boolean isOnceLocation)
设置是否进行单次定位,单次定位时调用start之后会默认返回一次定位结果- 参数:
isOnceLocation
- 是否进行单次定位,默认false
-
setOpenAutoNotifyMode
public void setOpenAutoNotifyMode()
设置打开自动回调位置模式,该开关打开后,期间只要定位SDK检测到位置变化就会主动回调给开发者,该模式下开发者无需再关心定位间隔是多少,定位SDK本身发现位置变化就会及时回调给开发者
-
setOpenAutoNotifyMode
public void setOpenAutoNotifyMode(int minTimeInterval, int minDistance, int locSensitivity)
设置打开自动回调位置模式,该开关打开后,期间只要定位SDK检测到位置变化就会主动回调给开发者- 参数:
minTimeInterval
- 最短定位时间间隔,单位毫秒,最小值0,开发者可以在设置希望的位置回调最短时间间隔minDistance
- 最短定位距离间隔,单位米,最小值0,开发者可以设置希望的位置回调距离间隔locSensitivity
- 定位变化敏感程度,LOC_SENSITIVITY_HIGHT,LOC_SENSITIVITY_MIDDLE,LOC_SENSITIVITY_LOW
-
getAutoNotifyMinTimeInterval
public int getAutoNotifyMinTimeInterval()
获取自动回调模式下允许的最短定位时间间隔- 返回:
- int 单位毫秒,最短允许的定位时间间隔
-
getAutoNotifyMinDistance
public int getAutoNotifyMinDistance()
获取自动回调模式下设置的回调位置的距离差值- 返回:
- int 单位米,设置的回调距离差值
-
getScanSpan
public int getScanSpan()
获取 设置的扫描间隔,单位是毫秒- 返回:
- int 扫描时间间隔
-
setScanSpan
public void setScanSpan(int scanSpan)
设置扫描间隔,单位是毫秒 当<1000(1s)时,定时定位无效- 参数:
scanSpan
- 单位毫秒,
-
getProdName
public java.lang.String getProdName()
获取设置的Prod字段值
-
setProdName
public void setProdName(java.lang.String prodName)
设置Prod字段值
-
getPriority
public int getPriority()
-
setLocationMode
public void setLocationMode(LocationClientOption.LocationMode mode)
设置定位模式- 参数:
mode
- 定位模式- 抛出:
java.lang.IllegalArgumentException
- 无效参数- 从以下版本开始:
- 4.1
-
getLocationMode
public LocationClientOption.LocationMode getLocationMode()
获取当前的定位模式- 返回:
- LocationMode
-
setNeedDeviceDirect
public void setNeedDeviceDirect(boolean isNeedDeviceDirect)
在网络定位时,是否需要设备方向 true:需要 ; false:不需要。默认为false- 参数:
isNeedDeviceDirect
- 是否需要方向信息
-
setNeedNewVersionRgc
public void setNeedNewVersionRgc(boolean isNeedNewVersionRgc)
是否需要最新版本的地址信息 true:需要 ; false:不需要。默认为false- 参数:
isNeedNewVersionRgc
- 是否需要最新版本rgc信息(即返回最新的省市区等地址信息,会随百度服务端数据实时更新)
-
setIsNeedLocationDescribe
public void setIsNeedLocationDescribe(boolean isNeedLocationDescribe)
设置是否需要返回位置语义化信息,可以在BDLocation.getLocationDescribe()中得到数据,ex:"在天安门附近", 可以用作地址信息的补充- 参数:
isNeedLocationDescribe
- 是否需要位置语义化信息
-
setIsNeedAltitude
public void setIsNeedAltitude(boolean isNeedAltitude)
设置是否需要返回海拔高度信息,可以在BDLocation.getAltitude()中得到数据,GNSS定位结果中默认返回,默认值Double.MIN_VALUE- 参数:
isNeedAltitude
- 是否需要海拔高度信息
-
setIsNeedLocationPoiList
public void setIsNeedLocationPoiList(boolean isNeedLocationPoiList)
设置是否需要返回位置POI信息,可以在BDLocation.getPoiList()中得到数据- 参数:
isNeedLocationPoiList
- 是否需要POI信息
-
SetIgnoreCacheException
public void SetIgnoreCacheException(boolean cacheException)
设置是否进行异常捕捉 true:不捕捉异常;false:捕捉异常,默认为true- 参数:
cacheException
- 是否捕捉异常信息
-
setIgnoreKillProcess
public void setIgnoreKillProcess(boolean killProcess)
设置是否退出定位进程 true:不退出进程; false:退出进程,默认为true- 参数:
killProcess
- 是否默认不杀死进程
-
setEnableSimulateGnss
public void setEnableSimulateGnss(boolean enableSimulateGnss)
设置是否允许模拟GNSS true:允许; false:不允许,默认为false- 参数:
enableSimulateGnss
- 是否允许仿真位置结果
-
setFirstLocType
public void setFirstLocType(LocationClientOption.FirstLocType firstLocType)
设置首次定位类型。默认为速度优先- 参数:
firstLocType
- 首次定位类型
-
-