# BleRssiRangingParams.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/rssi/BleRssiRangingParams.Builder "View this page in Java")  

```
class Builder
```

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

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

## Summary

|                                                                                                                                                                                                          Public constructors                                                                                                                                                                                                           ||
|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|
| [Builder](https://developer.android.com/reference/kotlin/android/ranging/ble/rssi/BleRssiRangingParams.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/rssi/BleRssiRangingParams.Builder#)for creating a bluetooth rssi ranging session. |

|                                                                                                                                                                                                                      Public methods                                                                                                                                                                                                                       ||
|---------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [BleRssiRangingParams](https://developer.android.com/reference/kotlin/android/ranging/ble/rssi/BleRssiRangingParams)                  | [build](https://developer.android.com/reference/kotlin/android/ranging/ble/rssi/BleRssiRangingParams.Builder#build())`()` Builds and returns a[BleRssiRangingParams](https://developer.android.com/reference/kotlin/android/ranging/ble/rssi/BleRssiRangingParams)instance.                                        |
| [BleRssiRangingParams.Builder](https://developer.android.com/reference/kotlin/android/ranging/ble/rssi/BleRssiRangingParams.Builder#) | [setRangingUpdateRate](https://developer.android.com/reference/kotlin/android/ranging/ble/rssi/BleRssiRangingParams.Builder#setRangingUpdateRate(kotlin.Int))`(`updateRate:` `[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`)` Sets the update rate for the BLE rssi 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/rssi/BleRssiRangingParams.Builder#)for creating a bluetooth rssi 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 {@see android.bluetooth.BluetoothAdapter#checkBluetoothAddress} 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. {@see android.bluetooth.BluetoothDevice#getAddress()} |

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

## Public methods

### build

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

```
fun build(): BleRssiRangingParams
```

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

|                                                                                                                                    Return                                                                                                                                    ||
|----------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------|
| [BleRssiRangingParams](https://developer.android.com/reference/kotlin/android/ranging/ble/rssi/BleRssiRangingParams) | a new[BleRssiRangingParams](https://developer.android.com/reference/kotlin/android/ranging/ble/rssi/BleRssiRangingParams). 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): BleRssiRangingParams.Builder
```

Sets the update rate for the BLE rssi 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                                                                                                                                              ||
|---------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------|
| [BleRssiRangingParams.Builder](https://developer.android.com/reference/kotlin/android/ranging/ble/rssi/BleRssiRangingParams.Builder#) | this[Builder](https://developer.android.com/reference/kotlin/android/ranging/ble/rssi/BleRssiRangingParams.Builder#)instance. This value cannot be`null`. |