LocationClientOption

java.lang.Object
- com.baidu.location.LocationClientOption

```
public final class LocationClientOption
extends java.lang.Object
```
配置定位SDK各配置参数，比如定位模式、定位时间间隔、坐标系类型等

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`LocationClientOption.BDLocationPurpose` 定位场景枚举，目前抽象有三种场景：签到、出行、运动；开发者可以通过直接设置所需要的定位场景类型，快速配置定位参数
`static class`	`LocationClientOption.LocationMode` 定位模式分为高精度定位模式低功耗定位模式仅设备定位模式高精度定位模式：这种定位模式下，会同时使用网络定位和GPS定位，优先返回最高精度的定位结果；低功耗定位模式：这种定位模式下，不会使用GPS，只会使用网络定位（Wi-Fi和基站定位）仅用设备定位模式：这种定位模式下，不需要连接网络，只使用GPS进行定位，这种模式下不支持室内环境的定位

Field Summary

Fields
Modifier and Type	Field and Description
`java.lang.String`	`addrType`
`float`	`autoNotifyLocSensitivity`
`int`	`autoNotifyMaxInterval`
`int`	`autoNotifyMinDistance`
`int`	`autoNotifyMinTimeInterval`
`java.lang.String`	`coorType`
`boolean`	`disableLocCache`
`boolean`	`enableSimulateGps`
`static int`	`GpsFirst`
`static int`	`GpsOnly`
`boolean`	`isIgnoreCacheException`
`boolean`	`isIgnoreKillProcess`
`boolean`	`isNeedAltitude`
`boolean`	`isNeedAptag`
`boolean`	`isNeedAptagd`
`boolean`	`isNeedNewVersionRgc`
`boolean`	`isNeedPoiRegion`
`boolean`	`isNeedRealLocWhenIsMock`
`boolean`	`isNeedRegular`
`boolean`	`isOnceLocation`
`double`	`judgeMockDisValue`
`static int`	`LOC_SENSITIVITY_HIGHT`
`static int`	`LOC_SENSITIVITY_LOW`
`static int`	`LOC_SENSITIVITY_MIDDLE`
`boolean`	`location_change_notify`
`static int`	`MIN_AUTO_NOTIFY_INTERVAL`
`static int`	`MIN_SCAN_SPAN`
`boolean`	`mIsNeedDeviceDirect`
`protected LocationClientOption.LocationMode`	`mLocationMode`
`static int`	`NetWorkFirst`
`boolean`	`openGps`
`int`	`priority`
`java.lang.String`	`prodName`
`int`	`scanSpan`
`java.lang.String`	`serviceName`
`int`	`timeOut`
`int`	`wifiCacheTimeOut`

Constructor Summary

Constructors
Constructor and Description

LocationClientOption()

LocationClientOption(LocationClientOption lOption)

Constructors
Constructor and Description
`LocationClientOption()`
`LocationClientOption(LocationClientOption lOption)`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`disableCache(boolean isDisable)` Deprecated.
`java.lang.String`	`getAddrType()` 获取地址信息设置
`int`	`getAutoNotifyMinDistance()` 获取自动回调模式下设置的回调位置的距离差值
`int`	`getAutoNotifyMinTimeInterval()` 获取自动回调模式下允许的最短定位时间间隔
`java.lang.String`	`getCoorType()` 获得当前设置的坐标类型
`double`	`getJudgeMockDisValue()` 返回所设置的GPS虚拟位置点和真实位置点的距离
`LocationClientOption.LocationMode`	`getLocationMode()` 获取当前的定位模式
`int`	`getPriority()`
`java.lang.String`	`getProdName()` 获取设置的Prod字段值
`int`	`getScanSpan()` 获取设置的扫描间隔，单位是毫秒
`java.lang.String`	`getServiceName()` Deprecated.
`int`	`getTimeOut()` Deprecated.
`boolean`	`isDisableCache()` Deprecated.
`boolean`	`isLocationNotify()` 判断是否设置了位置noify
`boolean`	`isNeedRealLocWhenIsMock()` 获取是否需要返回真实位置(当返回的gps定位结果是虚拟时)
`boolean`	`isOnceLocation()` 判断是否设置了单次定位
`boolean`	`isOpenGps()` 是否打开gps进行定位
`boolean`	`optionEquals(LocationClientOption opt)`
`void`	`setAddrType(java.lang.String addr)` Deprecated. 4.1 Use `setIsNeedAddress(boolean isNeed)` instead.
`void`	`setCoorType(java.lang.String coorType)` 设置坐标类型
`void`	`setEnableSimulateGps(boolean enableSimulateGps)` 设置是否允许模拟GPS true:允许； false:不允许，默认为false
`void`	`SetIgnoreCacheException(boolean cacheException)` 设置是否进行异常捕捉 true:不捕捉异常；false:捕捉异常，默认为true
`void`	`setIgnoreKillProcess(boolean killProcess)` 设置是否退出定位进程 true:不退出进程； false:退出进程，默认为true
`void`	`setIsNeedAddress(boolean isNeed)` 设置是否需要地址信息，默认为无地址。在设备获取gps位置的时候，对应的地址信息不会马上返回，因为gps是直接在本地产生，但地址信息需要从云端获取，是个异步过程，开发者在接收定位返回数据的时候，建议不要立即stop定位sdk以等待数据回调
`void`	`setIsNeedAltitude(boolean isNeedAltitude)` 设置是否需要返回海拔高度信息，可以在BDLocation.getAltitude()中得到数据，GPS定位结果中默认返回，默认值Double.MIN_VALUE
`void`	`setIsNeedLocationDescribe(boolean isNeedLocationDescribe)` 设置是否需要返回位置语义化信息，可以在BDLocation.getLocationDescribe()中得到数据，ex:"在天安门附近"，可以用作地址信息的补充
`void`	`setIsNeedLocationPoiList(boolean isNeedLocationPoiList)` 设置是否需要返回位置POI信息，可以在BDLocation.getPoiList()中得到数据
`void`	`setJudgeMockDisValue(double value)` 设置GPS虚拟位置点和真实位置点的距离，大于这个距离则返回的GPS定位结果是mock数据，反之则不是，误差距离默认值是500米
`void`	`setLocationMode(LocationClientOption.LocationMode mode)` 设置定位模式
`void`	`setLocationNotify(boolean notify)` 设置是否进行位置提醒
`void`	`setLocationPurpose(LocationClientOption.BDLocationPurpose locationPurpose)` 设置定位场景，根据定位场景快速生成对应的定位参数
`void`	`setNeedDeviceDirect(boolean isNeedDeviceDirect)` 在网络定位时，是否需要设备方向 true:需要 ; false:不需要。默认为false
`void`	`setNeedNewVersionRgc(boolean isNeedNewVersionRgc)` 是否需要最新版本的地址信息 true:需要 ; false:不需要。默认为false
`void`	`setNeedRealLocWhenIsMock(boolean needRealLocWhenIsMock)` 设置是否需要返回真实位置(当返回的gps定位结果是虚拟时)
`void`	`setOnceLocation(boolean isOnceLocation)` 设置是否进行单次定位，单次定位时调用start之后会默认返回一次定位结果
`void`	`setOpenAutoNotifyMode()` 设置打开自动回调位置模式，该开关打开后，期间只要定位SDK检测到位置变化就会主动回调给开发者，该模式下开发者无需再关心定位间隔是多少，定位SDK本身发现位置变化就会及时回调给开发者
`void`	`setOpenAutoNotifyMode(int minTimeInterval, int minDistance, int locSensitivity)` 设置打开自动回调位置模式，该开关打开后，期间只要定位SDK检测到位置变化就会主动回调给开发者
`void`	`setOpenGps(boolean openGps)` 设置是否打开gps进行定位
`void`	`setPriority(int priority)` Deprecated. Use `setLocationMode(LocationMode mode)` instead.
`void`	`setProdName(java.lang.String prodName)` 设置Prod字段值
`void`	`setScanSpan(int scanSpan)` 设置扫描间隔，单位是毫秒当<1000(1s)时，定时定位无效
`void`	`setSema(boolean isNeedAptag, boolean isNeedPoiRegion, boolean isNeedRegular)` Deprecated.
`void`	`setServiceName(java.lang.String serviceName)` Deprecated.
`void`	`setTimeOut(int timeOut)` Deprecated.
`void`	`setWifiCacheTimeOut(int timeout)` 设置wifi缓存超时时间阈值，超过该阈值，首次定位将会主动扫描wifi以使得定位精准度提高，定位速度会有所下降，具体延时取决于wifi扫描时间，大约是1-3秒

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - MIN_SCAN_SPAN
```
public static final int MIN_SCAN_SPAN
```
    See Also:
    
    Constant Field Values
  - GpsFirst
```
public static final int GpsFirst
```
    See Also:
    
    Constant Field Values
  - NetWorkFirst
```
public static final int NetWorkFirst
```
    See Also:
    
    Constant Field Values
  - GpsOnly
```
public static final int GpsOnly
```
    See Also:
    
    Constant Field Values
  - 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
```
  - judgeMockDisValue
```
public double judgeMockDisValue
```
  - isNeedRealLocWhenIsMock
```
public boolean isNeedRealLocWhenIsMock
```
  - 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
```
    See Also:
    
    Constant Field Values
  - LOC_SENSITIVITY_MIDDLE
```
public static final int LOC_SENSITIVITY_MIDDLE
```
    See Also:
    
    Constant Field Values
  - LOC_SENSITIVITY_LOW
```
public static final int LOC_SENSITIVITY_LOW
```
    See Also:
    
    Constant Field Values
  - MIN_AUTO_NOTIFY_INTERVAL
```
public static final int MIN_AUTO_NOTIFY_INTERVAL
```
    See Also:
    
    Constant Field Values
  - autoNotifyMaxInterval
```
public int autoNotifyMaxInterval
```
  - autoNotifyLocSensitivity
```
public float autoNotifyLocSensitivity
```
  - autoNotifyMinTimeInterval
```
public int autoNotifyMinTimeInterval
```
  - autoNotifyMinDistance
```
public int autoNotifyMinDistance
```
  - wifiCacheTimeOut
```
public int wifiCacheTimeOut
```
- Constructor Detail
  - LocationClientOption
```
public LocationClientOption()
```
  - LocationClientOption
```
public LocationClientOption(LocationClientOption lOption)
```
- Method Detail
  - optionEquals
```
public boolean optionEquals(LocationClientOption opt)
```
  - getCoorType
```
public java.lang.String getCoorType()
```
    获得当前设置的坐标类型
    
    Returns:
    
    String 坐标系类型
  - setCoorType
```
public void setCoorType(java.lang.String coorType)
```
    设置坐标类型
    
    Parameters:
    
    coorType - 取值有3个：返回国测局经纬度坐标系：gcj02 返回百度墨卡托坐标系：bd09 返回百度经纬度坐标系：bd09ll
  - getAddrType
```
public java.lang.String getAddrType()
```
    获取地址信息设置
    
    Returns:
    
    String 地址配置
  - setAddrType
```
@Deprecated
public void setAddrType(java.lang.String addr)
```
    Deprecated. 4.1 Use setIsNeedAddress(boolean isNeed) instead.
    
    设置地址信息，默认无地址信息，
    
    Parameters:
    
    addr - 地址信息设定为 "all"时，才会有地址信息返回
  - setIsNeedAddress
```
public void setIsNeedAddress(boolean isNeed)
```
    设置是否需要地址信息，默认为无地址。在设备获取gps位置的时候，对应的地址信息不会马上返回，因为gps是直接在本地产生，但地址信息需要从云端获取，是个异步过程，开发者在接收定位返回数据的时候，建议不要立即stop定位sdk以等待数据回调
    
    Parameters:
    
    isNeed - 是否需要地址信息
    
    Since:
    
    4.1
  - setWifiCacheTimeOut
```
public void setWifiCacheTimeOut(int timeout)
```
    设置wifi缓存超时时间阈值，超过该阈值，首次定位将会主动扫描wifi以使得定位精准度提高，定位速度会有所下降，具体延时取决于wifi扫描时间，大约是1-3秒
    
    Parameters:
    
    timeout - wifi缓存超时时间阈值,单位毫秒，最小值10000ms
  - isOpenGps
```
public boolean isOpenGps()
```
    是否打开gps进行定位
    
    Returns:
    
    boolean
  - setOpenGps
```
public void setOpenGps(boolean openGps)
```
    设置是否打开gps进行定位
    
    Parameters:
    
    openGps - 是否打开GPS
  - setLocationPurpose
```
public void setLocationPurpose(LocationClientOption.BDLocationPurpose locationPurpose)
```
    设置定位场景，根据定位场景快速生成对应的定位参数
    
    Parameters:
    
    locationPurpose -
  - isLocationNotify
```
public boolean isLocationNotify()
```
    判断是否设置了位置noify
  - setLocationNotify
```
public void setLocationNotify(boolean notify)
```
    设置是否进行位置提醒
    
    Parameters:
    
    notify - 是否位置提醒，true的情况下收到gps会一秒回调一次，无论配置的scanspan是多少
  - isOnceLocation
```
public boolean isOnceLocation()
```
    判断是否设置了单次定位
  - setOnceLocation
```
public void setOnceLocation(boolean isOnceLocation)
```
    设置是否进行单次定位，单次定位时调用start之后会默认返回一次定位结果
    
    Parameters:
    
    isOnceLocation - 是否进行单次定位，默认false
  - setOpenAutoNotifyMode
```
public void setOpenAutoNotifyMode()
```
    设置打开自动回调位置模式，该开关打开后，期间只要定位SDK检测到位置变化就会主动回调给开发者，该模式下开发者无需再关心定位间隔是多少，定位SDK本身发现位置变化就会及时回调给开发者
  - setOpenAutoNotifyMode
```
public void setOpenAutoNotifyMode(int minTimeInterval,
                                  int minDistance,
                                  int locSensitivity)
```
    设置打开自动回调位置模式，该开关打开后，期间只要定位SDK检测到位置变化就会主动回调给开发者
    
    Parameters:
    
    minTimeInterval - 最短定位时间间隔，单位毫秒，最小值0，开发者可以在设置希望的位置回调最短时间间隔
    
    minDistance - 最短定位距离间隔，单位米，最小值0，开发者可以设置希望的位置回调距离间隔
    
    locSensitivity - 定位变化敏感程度,LOC_SENSITIVITY_HIGHT,LOC_SENSITIVITY_MIDDLE,LOC_SENSITIVITY_LOW
  - getAutoNotifyMinTimeInterval
```
public int getAutoNotifyMinTimeInterval()
```
    获取自动回调模式下允许的最短定位时间间隔
    
    Returns:
    
    int 单位毫秒，最短允许的定位时间间隔
  - getAutoNotifyMinDistance
```
public int getAutoNotifyMinDistance()
```
    获取自动回调模式下设置的回调位置的距离差值
    
    Returns:
    
    int 单位米，设置的回调距离差值
  - getScanSpan
```
public int getScanSpan()
```
    获取设置的扫描间隔，单位是毫秒
    
    Returns:
    
    int 扫描时间间隔
  - setScanSpan
```
public void setScanSpan(int scanSpan)
```
    设置扫描间隔，单位是毫秒当<1000(1s)时，定时定位无效
    
    Parameters:
    
    scanSpan - 单位毫秒，
  - getTimeOut
```
public int getTimeOut()
```
    Deprecated.
  - setTimeOut
```
public void setTimeOut(int timeOut)
```
    Deprecated.
  - getProdName
```
public java.lang.String getProdName()
```
    获取设置的Prod字段值
  - setProdName
```
public void setProdName(java.lang.String prodName)
```
    设置Prod字段值
  - getPriority
```
public int getPriority()
```
  - setPriority
```
@Deprecated
public void setPriority(int priority)
```
    Deprecated. Use setLocationMode(LocationMode mode) instead.
    
    设置GPS优先还是网络定位优先
    
    Parameters:
    
    priority - GpsFirst: gps有效时，优先返回gps定位结果;GPS无效时，仍然会返回网络定位结果 NetWorkFirst:优先返回网络定位结果
  - setLocationMode
```
public void setLocationMode(LocationClientOption.LocationMode mode)
```
    设置定位模式
    
    Parameters:
    
    mode - 定位模式
    
    Throws:
    
    java.lang.IllegalArgumentException - 无效参数
    
    Since:
    
    4.1
  - getLocationMode
```
public LocationClientOption.LocationMode getLocationMode()
```
    获取当前的定位模式
    
    Returns:
    
    LocationMode
  - setNeedDeviceDirect
```
public void setNeedDeviceDirect(boolean isNeedDeviceDirect)
```
    在网络定位时，是否需要设备方向 true:需要 ; false:不需要。默认为false
    
    Parameters:
    
    isNeedDeviceDirect - 是否需要方向信息
  - setNeedNewVersionRgc
```
public void setNeedNewVersionRgc(boolean isNeedNewVersionRgc)
```
    是否需要最新版本的地址信息 true:需要 ; false:不需要。默认为false
    
    Parameters:
    
    isNeedNewVersionRgc - 是否需要最新版本rgc信息（即返回最新的省市区等地址信息，会随百度服务端数据实时更新）
  - getServiceName
```
public java.lang.String getServiceName()
```
    Deprecated.
  - setServiceName
```
public void setServiceName(java.lang.String serviceName)
```
    Deprecated.
  - setIsNeedLocationDescribe
```
public void setIsNeedLocationDescribe(boolean isNeedLocationDescribe)
```
    设置是否需要返回位置语义化信息，可以在BDLocation.getLocationDescribe()中得到数据，ex:"在天安门附近"，可以用作地址信息的补充
    
    Parameters:
    
    isNeedLocationDescribe - 是否需要位置语义化信息
  - setIsNeedAltitude
```
public void setIsNeedAltitude(boolean isNeedAltitude)
```
    设置是否需要返回海拔高度信息，可以在BDLocation.getAltitude()中得到数据，GPS定位结果中默认返回，默认值Double.MIN_VALUE
    
    Parameters:
    
    isNeedAltitude - 是否需要海拔高度信息
  - setIsNeedLocationPoiList
```
public void setIsNeedLocationPoiList(boolean isNeedLocationPoiList)
```
    设置是否需要返回位置POI信息，可以在BDLocation.getPoiList()中得到数据
    
    Parameters:
    
    isNeedLocationPoiList - 是否需要POI信息
  - setSema
```
@Deprecated
public void setSema(boolean isNeedAptag,
                                boolean isNeedPoiRegion,
                                boolean isNeedRegular)
```
    Deprecated.
  - disableCache
```
public void disableCache(boolean isDisable)
```
    Deprecated.
  - isDisableCache
```
public boolean isDisableCache()
```
    Deprecated.
  - SetIgnoreCacheException
```
public void SetIgnoreCacheException(boolean cacheException)
```
    设置是否进行异常捕捉 true:不捕捉异常；false:捕捉异常，默认为true
    
    Parameters:
    
    cacheException - 是否捕捉异常信息
  - setIgnoreKillProcess
```
public void setIgnoreKillProcess(boolean killProcess)
```
    设置是否退出定位进程 true:不退出进程； false:退出进程，默认为true
    
    Parameters:
    
    killProcess - 是否默认不杀死进程
  - setEnableSimulateGps
```
public void setEnableSimulateGps(boolean enableSimulateGps)
```
    设置是否允许模拟GPS true:允许； false:不允许，默认为false
    
    Parameters:
    
    enableSimulateGps - 是否允许仿真位置结果
  - setJudgeMockDisValue
```
public void setJudgeMockDisValue(double value)
```
    设置GPS虚拟位置点和真实位置点的距离，大于这个距离则返回的GPS定位结果是mock数据，反之则不是，误差距离默认值是500米
    
    Parameters:
    
    value - GPS虚拟位置点和真实位置点的距离，类型是double
  - getJudgeMockDisValue
```
public double getJudgeMockDisValue()
```
    返回所设置的GPS虚拟位置点和真实位置点的距离
    
    Returns:
    
    类型是double
  - setNeedRealLocWhenIsMock
```
public void setNeedRealLocWhenIsMock(boolean needRealLocWhenIsMock)
```
    设置是否需要返回真实位置(当返回的gps定位结果是虚拟时)
    
    Parameters:
    
    needRealLocWhenIsMock -
  - isNeedRealLocWhenIsMock
```
public boolean isNeedRealLocWhenIsMock()
```
    获取是否需要返回真实位置(当返回的gps定位结果是虚拟时)
    
    Returns:
    
    类型是boolean

Class LocationClientOption

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

MIN_SCAN_SPAN

GpsFirst

NetWorkFirst

GpsOnly

coorType

addrType

openGps

scanSpan

timeOut

prodName

priority

location_change_notify

disableLocCache

enableSimulateGps

judgeMockDisValue

isNeedRealLocWhenIsMock

serviceName

isIgnoreCacheException

isIgnoreKillProcess

mIsNeedDeviceDirect

isNeedAptag

isNeedAptagd

isNeedPoiRegion

isNeedRegular

isNeedAltitude

isNeedNewVersionRgc

isOnceLocation

mLocationMode

LOC_SENSITIVITY_HIGHT

LOC_SENSITIVITY_MIDDLE

LOC_SENSITIVITY_LOW

MIN_AUTO_NOTIFY_INTERVAL

autoNotifyMaxInterval

autoNotifyLocSensitivity

autoNotifyMinTimeInterval

autoNotifyMinDistance

wifiCacheTimeOut

Constructor Detail

LocationClientOption

LocationClientOption

Method Detail

optionEquals

getCoorType

setCoorType

getAddrType

setAddrType

setIsNeedAddress

setWifiCacheTimeOut

isOpenGps

setOpenGps

setLocationPurpose

isLocationNotify

setLocationNotify

isOnceLocation

setOnceLocation

setOpenAutoNotifyMode

setOpenAutoNotifyMode

getAutoNotifyMinTimeInterval

getAutoNotifyMinDistance

getScanSpan

setScanSpan

getTimeOut

setTimeOut

getProdName

setProdName

getPriority

setPriority

setLocationMode

getLocationMode

setNeedDeviceDirect

setNeedNewVersionRgc

getServiceName

setServiceName