Added in [API level 36](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) Summary: [Ctors](https://developer.android.com/reference/android/ranging/ble/cs/BleCsRangingParams.Builder#pubctors) \| [Methods](https://developer.android.com/reference/android/ranging/ble/cs/BleCsRangingParams.Builder#pubmethods) \| [Inherited Methods](https://developer.android.com/reference/android/ranging/ble/cs/BleCsRangingParams.Builder#inhmethods)

# BleCsRangingParams.Builder

*** ** * ** ***

` public static final class BleCsRangingParams.Builder `   
` extends https://developer.android.com/reference/java/lang/Object ` ` `

|---|---|
| [java.lang.Object](https://developer.android.com/reference/java/lang/Object) ||
| ↳ | android.ranging.ble.cs.BleCsRangingParams.Builder |

<br />

*** ** * ** ***

Builder class to create `https://developer.android.com/reference/android/ranging/ble/cs/BleCsRangingParams` instances.

## Summary

| ### Public constructors ||
|---|---|
| ` https://developer.android.com/reference/android/ranging/ble/cs/BleCsRangingParams.Builder#Builder(java.lang.String)(https://developer.android.com/reference/java/lang/String peerBluetoothAddress) ` Constructs a new `https://developer.android.com/reference/android/ranging/ble/cs/BleCsRangingParams.Builder` for creating a channel sounding ranging session. |

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

### Inherited methods

From class ` https://developer.android.com/reference/java/lang/Object ` ` https://developer.android.com/reference/java/lang/Object` ` https://developer.android.com/reference/java/lang/Object#clone()() `

Creates and returns a copy of this object.
` boolean` ` https://developer.android.com/reference/java/lang/Object#equals(java.lang.Object)(https://developer.android.com/reference/java/lang/Object obj) `

Indicates whether some other object is "equal to" this one.
` void` ` https://developer.android.com/reference/java/lang/Object#finalize()() `

Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
` final https://developer.android.com/reference/java/lang/Class<?>` ` https://developer.android.com/reference/java/lang/Object#getClass()() `

Returns the runtime class of this `Object`.
` int` ` https://developer.android.com/reference/java/lang/Object#hashCode()() `

Returns a hash code value for the object.
` final void` ` https://developer.android.com/reference/java/lang/Object#notify()() `

Wakes up a single thread that is waiting on this object's monitor.
` final void` ` https://developer.android.com/reference/java/lang/Object#notifyAll()() `

Wakes up all threads that are waiting on this object's monitor.
` https://developer.android.com/reference/java/lang/String` ` https://developer.android.com/reference/java/lang/Object#toString()() `

Returns a string representation of the object.
` final void` ` https://developer.android.com/reference/java/lang/Object#wait(long,%20int)(long timeoutMillis, int nanos) `

Causes the current thread to wait until it is awakened, typically by being *notified* or *interrupted*, or until a certain amount of real time has elapsed.
` final void` ` https://developer.android.com/reference/java/lang/Object#wait(long)(long timeoutMillis) `

Causes the current thread to wait until it is awakened, typically by being *notified* or *interrupted*, or until a certain amount of real time has elapsed.
` final void` ` https://developer.android.com/reference/java/lang/Object#wait()() `

Causes the current thread to wait until it is awakened, typically by being *notified* or *interrupted*.

## Public constructors

### Builder

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

```
public Builder (String peerBluetoothAddress)
```

Constructs a new `https://developer.android.com/reference/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 `https://developer.android.com/reference/android/bluetooth/BluetoothAdapter#checkBluetoothAddress(java.lang.String)` is available to validate a Bluetooth address.

<br />

| Parameters ||
|---|---|
| `peerBluetoothAddress` | `String`: The address of the peer device must be non-null Bluetooth address. <br /> |

| Throws ||
|---|---|
| `https://developer.android.com/reference/java/lang/IllegalArgumentException` | if `peerBluetoothAddress` is null or does not conform to "00:11:22:33:AA:BB" format. |

**See also:**

- `https://developer.android.com/reference/android/bluetooth/BluetoothDevice#getAddress()`

## Public methods

### build

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

```
public BleCsRangingParams build ()
```

Builds and returns a `https://developer.android.com/reference/android/ranging/ble/cs/BleCsRangingParams` instance.

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/android/ranging/ble/cs/BleCsRangingParams` | a new `https://developer.android.com/reference/android/ranging/ble/cs/BleCsRangingParams`. This value cannot be `null`. <br /> |

### setLocationType

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

```
public BleCsRangingParams.Builder setLocationType (int locationType)
```

Sets the location type for the ranging session.

Defaults to `https://developer.android.com/reference/android/ranging/ble/cs/BleCsRangingParams#LOCATION_TYPE_UNKNOWN`

<br />

| Parameters ||
|---|---|
| `locationType` | `int`: the location type. Value is one of the following: - `https://developer.android.com/reference/android/ranging/ble/cs/BleCsRangingParams#LOCATION_TYPE_UNKNOWN` - `https://developer.android.com/reference/android/ranging/ble/cs/BleCsRangingParams#LOCATION_TYPE_INDOOR` - `https://developer.android.com/reference/android/ranging/ble/cs/BleCsRangingParams#LOCATION_TYPE_OUTDOOR` |

| Returns ||
|---|---|
| `https://developer.android.com/reference/android/ranging/ble/cs/BleCsRangingParams.Builder` | this `https://developer.android.com/reference/android/ranging/ble/cs/BleCsRangingParams.Builder` instance. This value cannot be `null`. <br /> |

### setRangingUpdateRate

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

```
public BleCsRangingParams.Builder setRangingUpdateRate (int updateRate)
```

Sets the update rate for the CS ranging session.

Defaults to `https://developer.android.com/`

<br />

| Parameters ||
|---|---|
| `updateRate` | `int`: the reporting frequency. <br /> |

| Returns ||
|---|---|
| `https://developer.android.com/reference/android/ranging/ble/cs/BleCsRangingParams.Builder` | this `https://developer.android.com/reference/android/ranging/ble/cs/BleCsRangingParams.Builder` instance. This value cannot be `null`. <br /> |

### setSecurityLevel

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

```
public BleCsRangingParams.Builder setSecurityLevel (int securityLevel)
```

Sets the security level for the ranging session.

Defaults to `https://developer.android.com/reference/android/ranging/ble/cs/BleCsRangingCapabilities#CS_SECURITY_LEVEL_ONE`

<br />

| Parameters ||
|---|---|
| `securityLevel` | `int`: the security level. <br /> |

| Returns ||
|---|---|
| `https://developer.android.com/reference/android/ranging/ble/cs/BleCsRangingParams.Builder` | this `https://developer.android.com/reference/android/ranging/ble/cs/BleCsRangingParams.Builder` instance. This value cannot be `null`. <br /> |

### setSightType

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

```
public BleCsRangingParams.Builder setSightType (int sightType)
```

Sets the sight type for the ranging session.

Defaults to `https://developer.android.com/reference/android/ranging/ble/cs/BleCsRangingParams#SIGHT_TYPE_UNKNOWN`

<br />

| Parameters ||
|---|---|
| `sightType` | `int`: the sight type. Value is one of the following: - `https://developer.android.com/reference/android/ranging/ble/cs/BleCsRangingParams#SIGHT_TYPE_UNKNOWN` - `https://developer.android.com/reference/android/ranging/ble/cs/BleCsRangingParams#SIGHT_TYPE_LINE_OF_SIGHT` - `https://developer.android.com/reference/android/ranging/ble/cs/BleCsRangingParams#SIGHT_TYPE_NON_LINE_OF_SIGHT` |

| Returns ||
|---|---|
| `https://developer.android.com/reference/android/ranging/ble/cs/BleCsRangingParams.Builder` | this `https://developer.android.com/reference/android/ranging/ble/cs/BleCsRangingParams.Builder` instance. This value cannot be `null`. <br /> |