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/uwb/UwbRangingParams.Builder#pubctors) \| [Methods](https://developer.android.com/reference/android/ranging/uwb/UwbRangingParams.Builder#pubmethods) \| [Inherited Methods](https://developer.android.com/reference/android/ranging/uwb/UwbRangingParams.Builder#inhmethods)

# UwbRangingParams.Builder

*** ** * ** ***


`
public
static
final

class
UwbRangingParams.Builder
`


`

extends https://developer.android.com/reference/java/lang/Object


`

`


`

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

<br />

*** ** * ** ***

Builder class for creating instances of `https://developer.android.com/reference/android/ranging/uwb/UwbRangingParams`

## Summary

| ### Public constructors ||
|---|---|
| ` https://developer.android.com/reference/android/ranging/uwb/UwbRangingParams.Builder#Builder(int,%20int,%20android.ranging.uwb.UwbAddress,%20android.ranging.uwb.UwbAddress)(int sessionId, int configId, https://developer.android.com/reference/android/ranging/uwb/UwbAddress deviceAddress, https://developer.android.com/reference/android/ranging/uwb/UwbAddress peerAddress) ` Constructs a new `https://developer.android.com/reference/android/ranging/uwb/UwbRangingParams.Builder` for creating a ranging session. |

| ### Public methods ||
|---|---|
| ` https://developer.android.com/reference/android/ranging/uwb/UwbRangingParams` | ` https://developer.android.com/reference/android/ranging/uwb/UwbRangingParams.Builder#build()() ` Builds a new instance of `https://developer.android.com/reference/android/ranging/uwb/UwbRangingParams`. |
| ` https://developer.android.com/reference/android/ranging/uwb/UwbRangingParams.Builder` | ` https://developer.android.com/reference/android/ranging/uwb/UwbRangingParams.Builder#setComplexChannel(android.ranging.uwb.UwbComplexChannel)(https://developer.android.com/reference/android/ranging/uwb/UwbComplexChannel complexChannel) ` Sets the complex channel configuration for the ranging session. |
| ` https://developer.android.com/reference/android/ranging/uwb/UwbRangingParams.Builder` | ` https://developer.android.com/reference/android/ranging/uwb/UwbRangingParams.Builder#setRangingUpdateRate(int)(int rate) ` Sets the ranging update rate for the session. |
| ` https://developer.android.com/reference/android/ranging/uwb/UwbRangingParams.Builder` | ` https://developer.android.com/reference/android/ranging/uwb/UwbRangingParams.Builder#setSessionKeyInfo(byte[])(byte[] sessionKeyInfo) ` Sets the session key information for secure ranging. |
| ` https://developer.android.com/reference/android/ranging/uwb/UwbRangingParams.Builder` | ` https://developer.android.com/reference/android/ranging/uwb/UwbRangingParams.Builder#setSlotDuration(int)(int durationMs) ` Sets the slot duration in milliseconds for the ranging session. |
| ` https://developer.android.com/reference/android/ranging/uwb/UwbRangingParams.Builder` | ` https://developer.android.com/reference/android/ranging/uwb/UwbRangingParams.Builder#setSubSessionId(int)(int subSessionId) ` Sets the sub-session ID for the ranging session. |
| ` https://developer.android.com/reference/android/ranging/uwb/UwbRangingParams.Builder` | ` https://developer.android.com/reference/android/ranging/uwb/UwbRangingParams.Builder#setSubSessionKeyInfo(byte[])(byte[] subSessionKeyInfo) ` Sets the sub-session key information for secure ranging. |

| ### 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 (int sessionId, 
                int configId, 
                UwbAddress deviceAddress, 
                UwbAddress peerAddress)
```

Constructs a new `https://developer.android.com/reference/android/ranging/uwb/UwbRangingParams.Builder` for creating a ranging session.

<br />

| Parameters ||
|---|---|
| `sessionId` | `int`: A unique identifier for the session. <br /> |
| `configId` | `int`: The configuration ID for the ranging parameters. <br /> |
| `deviceAddress` | `UwbAddress`: The `https://developer.android.com/reference/android/ranging/uwb/UwbAddress` representing the device's address. Must be non-null. <br /> |
| `peerAddress` | `UwbAddress`: The `https://developer.android.com/reference/android/ranging/uwb/UwbAddress` of the peer device. Must be non-null. <br /> |

| Throws ||
|---|---|
| `https://developer.android.com/reference/java/lang/IllegalArgumentException` | if either `deviceAddress` or `peerAddress` is null. |

## Public methods

### build

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

```
public UwbRangingParams build ()
```

Builds a new instance of `https://developer.android.com/reference/android/ranging/uwb/UwbRangingParams`.

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/android/ranging/uwb/UwbRangingParams` | a new instance of `https://developer.android.com/reference/android/ranging/uwb/UwbRangingParams` created using the current state of the builder. This value cannot be `null`. <br /> |

### setComplexChannel

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

```
public UwbRangingParams.Builder setComplexChannel (UwbComplexChannel complexChannel)
```

Sets the complex channel configuration for the ranging session.

<br />

| Parameters ||
|---|---|
| `complexChannel` | `UwbComplexChannel`: a non-null `https://developer.android.com/reference/android/ranging/uwb/UwbComplexChannel` instance representing the channel and preamble configuration. For better performance always use a random preamble index for each ranging session. <br /> |

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

| Throws ||
|---|---|
| `https://developer.android.com/reference/java/lang/IllegalArgumentException` | if the provided complex channel is null. |

### setRangingUpdateRate

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

```
public UwbRangingParams.Builder setRangingUpdateRate (int rate)
```

Sets the ranging update rate for the session.

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

<br />

| Parameters ||
|---|---|
| `rate` | `int`: the ranging update rate, defined as one of the constants in `https://developer.android.com/`. <br /> |

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

### setSessionKeyInfo

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

```
public UwbRangingParams.Builder setSessionKeyInfo (byte[] sessionKeyInfo)
```

Sets the session key information for secure ranging.

<br />

| Parameters ||
|---|---|
| `sessionKeyInfo` | `byte`: a byte array containing session key information. This value cannot be `null`. <br /> |

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

| Throws ||
|---|---|
| `https://developer.android.com/reference/java/lang/IllegalArgumentException` | if the provided byte array is null. |

### setSlotDuration

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

```
public UwbRangingParams.Builder setSlotDuration (int durationMs)
```

Sets the slot duration in milliseconds for the ranging session.

Defaults to `https://developer.android.com/reference/android/ranging/uwb/UwbRangingParams#DURATION_2_MS`.

<br />

| Parameters ||
|---|---|
| `durationMs` | `int`: the slot duration `https://developer.android.com/` Value is one of the following: - `https://developer.android.com/reference/android/ranging/uwb/UwbRangingParams#DURATION_1_MS` - `https://developer.android.com/reference/android/ranging/uwb/UwbRangingParams#DURATION_2_MS` |

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

| Throws ||
|---|---|
| `https://developer.android.com/reference/java/lang/IllegalArgumentException` | if the provided duration is out of range. |

### setSubSessionId

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

```
public UwbRangingParams.Builder setSubSessionId (int subSessionId)
```

Sets the sub-session ID for the ranging session.

<br />

| Parameters ||
|---|---|
| `subSessionId` | `int`: the sub-session ID, which should be a unique identifier for the sub-session. <br /> |

| Returns ||
|---|---|
| `https://developer.android.com/reference/android/ranging/uwb/UwbRangingParams.Builder` | this Builder instance for method chaining. This value cannot be `null`. <br /> |

### setSubSessionKeyInfo

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

```
public UwbRangingParams.Builder setSubSessionKeyInfo (byte[] subSessionKeyInfo)
```

Sets the sub-session key information for secure ranging.

<br />

| Parameters ||
|---|---|
| `subSessionKeyInfo` | `byte`: a byte array containing sub-session key information. This value cannot be `null`. <br /> |

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

| Throws ||
|---|---|
| `https://developer.android.com/reference/java/lang/IllegalArgumentException` | if the provided map is null. |