# BleCsRangingParams.Builder

Added in[API level 36](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)

# Builder

*** ** * ** ***

Kotlin\|[Java](https://developer.android.com/reference/android/ranging/ble/cs/BleCsRangingParams.Builder "View this page in Java")  

```
class Builder
```

|---|--------------------------------------------------------------------------------------------------------------------------------------------------------|
| [kotlin.Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)                                                                         ||
| ↳ | [android.ranging.ble.cs.BleCsRangingParams.Builder](https://developer.android.com/reference/kotlin/android/ranging/ble/cs/BleCsRangingParams.Builder#) |

Builder class to create[BleCsRangingParams](https://developer.android.com/reference/kotlin/android/ranging/ble/cs/BleCsRangingParams)instances.

## Summary

|                                                                                                                                                                                                       Public constructors                                                                                                                                                                                                        ||
|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|
| [Builder](https://developer.android.com/reference/kotlin/android/ranging/ble/cs/BleCsRangingParams.Builder#Builder(kotlin.String))`(`peerBluetoothAddress:` `[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`)` Constructs a new[Builder](https://developer.android.com/reference/kotlin/android/ranging/ble/cs/BleCsRangingParams.Builder#)for creating a channel sounding ranging session. |

|                                                                                                                                                                                                              Public methods                                                                                                                                                                                                               ||
|---------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [BleCsRangingParams](https://developer.android.com/reference/kotlin/android/ranging/ble/cs/BleCsRangingParams)                  | [build](https://developer.android.com/reference/kotlin/android/ranging/ble/cs/BleCsRangingParams.Builder#build())`()` Builds and returns a[BleCsRangingParams](https://developer.android.com/reference/kotlin/android/ranging/ble/cs/BleCsRangingParams)instance.                                        |
| [BleCsRangingParams.Builder](https://developer.android.com/reference/kotlin/android/ranging/ble/cs/BleCsRangingParams.Builder#) | [setLocationType](https://developer.android.com/reference/kotlin/android/ranging/ble/cs/BleCsRangingParams.Builder#setLocationType(kotlin.Int))`(`locationType:` `[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`)` Sets the location type for the ranging session.          |
| [BleCsRangingParams.Builder](https://developer.android.com/reference/kotlin/android/ranging/ble/cs/BleCsRangingParams.Builder#) | [setRangingUpdateRate](https://developer.android.com/reference/kotlin/android/ranging/ble/cs/BleCsRangingParams.Builder#setRangingUpdateRate(kotlin.Int))`(`updateRate:` `[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`)` Sets the update rate for the CS ranging session. |
| [BleCsRangingParams.Builder](https://developer.android.com/reference/kotlin/android/ranging/ble/cs/BleCsRangingParams.Builder#) | [setSecurityLevel](https://developer.android.com/reference/kotlin/android/ranging/ble/cs/BleCsRangingParams.Builder#setSecurityLevel(kotlin.Int))`(`securityLevel:` `[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`)` Sets the security level for the ranging session.      |
| [BleCsRangingParams.Builder](https://developer.android.com/reference/kotlin/android/ranging/ble/cs/BleCsRangingParams.Builder#) | [setSightType](https://developer.android.com/reference/kotlin/android/ranging/ble/cs/BleCsRangingParams.Builder#setSightType(kotlin.Int))`(`sightType:` `[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`)` Sets the sight type for the ranging session.                      |

## Public constructors

### Builder

Added in[API level 36](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)  

```
Builder(peerBluetoothAddress: String)
```

Constructs a new[Builder](https://developer.android.com/reference/kotlin/android/ranging/ble/cs/BleCsRangingParams.Builder#)for creating a channel sounding ranging session.

Valid Bluetooth hardware addresses must be upper case, in big endian byte order, and in a format such as "00:11:22:33:AA:BB". The helper[android.bluetooth.BluetoothAdapter#checkBluetoothAddress](https://developer.android.com/reference/kotlin/android/bluetooth/BluetoothAdapter.html#checkBluetoothAddress(kotlin.String))is available to validate a Bluetooth address.

|                                                                                 Parameters                                                                                  ||
|------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------|
| `peerBluetoothAddress` | [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html):The address of the peer device must be non-null Bluetooth address. |

|                                                        Exceptions                                                        ||
|--------------------------------------|------------------------------------------------------------------------------------|
| `java.lang.IllegalArgumentException` | if`peerBluetoothAddress`is null or does not conform to "00:11:22:33:AA:BB" format. |

**See Also**

- [android.bluetooth.BluetoothDevice#getAddress()](https://developer.android.com/reference/kotlin/android/bluetooth/BluetoothDevice.html#getAddress())

## Public methods

### build

Added in[API level 36](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)  

```
fun build(): BleCsRangingParams
```

Builds and returns a[BleCsRangingParams](https://developer.android.com/reference/kotlin/android/ranging/ble/cs/BleCsRangingParams)instance.

|                                                                                                                              Return                                                                                                                              ||
|----------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------|
| [BleCsRangingParams](https://developer.android.com/reference/kotlin/android/ranging/ble/cs/BleCsRangingParams) | a new[BleCsRangingParams](https://developer.android.com/reference/kotlin/android/ranging/ble/cs/BleCsRangingParams). This value cannot be`null`. |

### setLocationType

Added in[API level 36](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)  

```
fun setLocationType(locationType: Int): BleCsRangingParams.Builder
```

Sets the location type for the ranging session.

Defaults to[LOCATION_TYPE_UNKNOWN](https://developer.android.com/reference/kotlin/android/ranging/ble/cs/BleCsRangingParams#LOCATION_TYPE_UNKNOWN:kotlin.Int)

|                                                                                                                                                                                                                                                                                                                                                  Parameters                                                                                                                                                                                                                                                                                                                                                   ||
|----------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `locationType` | [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html):the location type. Value is[android.ranging.ble.cs.BleCsRangingParams#LOCATION_TYPE_UNKNOWN](https://developer.android.com/reference/kotlin/android/ranging/ble/cs/BleCsRangingParams#LOCATION_TYPE_UNKNOWN:kotlin.Int),[android.ranging.ble.cs.BleCsRangingParams#LOCATION_TYPE_INDOOR](https://developer.android.com/reference/kotlin/android/ranging/ble/cs/BleCsRangingParams#LOCATION_TYPE_INDOOR:kotlin.Int), or[android.ranging.ble.cs.BleCsRangingParams#LOCATION_TYPE_OUTDOOR](https://developer.android.com/reference/kotlin/android/ranging/ble/cs/BleCsRangingParams#LOCATION_TYPE_OUTDOOR:kotlin.Int) |

|                                                                                                                                         Return                                                                                                                                         ||
|---------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------|
| [BleCsRangingParams.Builder](https://developer.android.com/reference/kotlin/android/ranging/ble/cs/BleCsRangingParams.Builder#) | this[Builder](https://developer.android.com/reference/kotlin/android/ranging/ble/cs/BleCsRangingParams.Builder#)instance. This value cannot be`null`. |

### setRangingUpdateRate

Added in[API level 36](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)  

```
fun setRangingUpdateRate(updateRate: Int): BleCsRangingParams.Builder
```

Sets the update rate for the CS ranging session.

Defaults to android.ranging.raw.RawRangingDevice.RangingUpdateRate#UPDATE_RATE_NORMAL

|                                                                                                                                                                                                                                                                                                                                           Parameters                                                                                                                                                                                                                                                                                                                                           ||
|--------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `updateRate` | [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html):the reporting frequency. Value is[android.ranging.raw.RawRangingDevice#UPDATE_RATE_NORMAL](https://developer.android.com/reference/kotlin/android/ranging/raw/RawRangingDevice.html#UPDATE_RATE_NORMAL:kotlin.Int),[android.ranging.raw.RawRangingDevice#UPDATE_RATE_INFREQUENT](https://developer.android.com/reference/kotlin/android/ranging/raw/RawRangingDevice.html#UPDATE_RATE_INFREQUENT:kotlin.Int), or[android.ranging.raw.RawRangingDevice#UPDATE_RATE_FREQUENT](https://developer.android.com/reference/kotlin/android/ranging/raw/RawRangingDevice.html#UPDATE_RATE_FREQUENT:kotlin.Int) |

|                                                                                                                                         Return                                                                                                                                         ||
|---------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------|
| [BleCsRangingParams.Builder](https://developer.android.com/reference/kotlin/android/ranging/ble/cs/BleCsRangingParams.Builder#) | this[Builder](https://developer.android.com/reference/kotlin/android/ranging/ble/cs/BleCsRangingParams.Builder#)instance. This value cannot be`null`. |

### setSecurityLevel

Added in[API level 36](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)  

```
fun setSecurityLevel(securityLevel: Int): BleCsRangingParams.Builder
```

Sets the security level for the ranging session.

Defaults to[BleCsRangingCapabilities.CS_SECURITY_LEVEL_ONE](https://developer.android.com/reference/kotlin/android/ranging/ble/cs/BleCsRangingCapabilities#CS_SECURITY_LEVEL_ONE:kotlin.Int)

|                                                                                                                                                                                                                                                                   Parameters                                                                                                                                                                                                                                                                   ||
|-----------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `securityLevel` | [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html):the security level. Value is[android.ranging.ble.cs.BleCsRangingCapabilities#CS_SECURITY_LEVEL_ONE](https://developer.android.com/reference/kotlin/android/ranging/ble/cs/BleCsRangingCapabilities#CS_SECURITY_LEVEL_ONE:kotlin.Int), or[android.ranging.ble.cs.BleCsRangingCapabilities#CS_SECURITY_LEVEL_FOUR](https://developer.android.com/reference/kotlin/android/ranging/ble/cs/BleCsRangingCapabilities#CS_SECURITY_LEVEL_FOUR:kotlin.Int) |

|                                                                                                                                         Return                                                                                                                                         ||
|---------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------|
| [BleCsRangingParams.Builder](https://developer.android.com/reference/kotlin/android/ranging/ble/cs/BleCsRangingParams.Builder#) | this[Builder](https://developer.android.com/reference/kotlin/android/ranging/ble/cs/BleCsRangingParams.Builder#)instance. This value cannot be`null`. |

### setSightType

Added in[API level 36](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)  

```
fun setSightType(sightType: Int): BleCsRangingParams.Builder
```

Sets the sight type for the ranging session.

Defaults to[SIGHT_TYPE_UNKNOWN](https://developer.android.com/reference/kotlin/android/ranging/ble/cs/BleCsRangingParams#SIGHT_TYPE_UNKNOWN:kotlin.Int)

|                                                                                                                                                                                                                                                                                                                                                       Parameters                                                                                                                                                                                                                                                                                                                                                        ||
|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `sightType` | [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html):the sight type. Value is[android.ranging.ble.cs.BleCsRangingParams#SIGHT_TYPE_UNKNOWN](https://developer.android.com/reference/kotlin/android/ranging/ble/cs/BleCsRangingParams#SIGHT_TYPE_UNKNOWN:kotlin.Int),[android.ranging.ble.cs.BleCsRangingParams#SIGHT_TYPE_LINE_OF_SIGHT](https://developer.android.com/reference/kotlin/android/ranging/ble/cs/BleCsRangingParams#SIGHT_TYPE_LINE_OF_SIGHT:kotlin.Int), or[android.ranging.ble.cs.BleCsRangingParams#SIGHT_TYPE_NON_LINE_OF_SIGHT](https://developer.android.com/reference/kotlin/android/ranging/ble/cs/BleCsRangingParams#SIGHT_TYPE_NON_LINE_OF_SIGHT:kotlin.Int) |

|                                                                                                                                         Return                                                                                                                                         ||
|---------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------|
| [BleCsRangingParams.Builder](https://developer.android.com/reference/kotlin/android/ranging/ble/cs/BleCsRangingParams.Builder#) | this[Builder](https://developer.android.com/reference/kotlin/android/ranging/ble/cs/BleCsRangingParams.Builder#)instance. This value cannot be`null`. |