Added in API level 36

Summary: Ctors | Methods | Inherited Methods

UwbRangingParams.Builder

Kotlin |Java

public static final class UwbRangingParams.Builder
extends Object

java.lang.Object
↳	android.ranging.uwb.UwbRangingParams.Builder

Builder class for creating instances of UwbRangingParams

Summary

Public constructors
`Builder(int sessionId, int configId, UwbAddress deviceAddress, UwbAddress peerAddress)` Constructs a new `Builder` for creating a ranging session.

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

Inherited methods

From class


        
          java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(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`	`wait(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`	`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

public Builder (int sessionId, 
                int configId, 
                UwbAddress deviceAddress, 
                UwbAddress peerAddress)

Constructs a new Builder for creating a ranging session.

Parameters
`sessionId`	`int`: A unique identifier for the session.
`configId`	`int`: The configuration ID for the ranging parameters. Value is `UwbRangingParams.CONFIG_UNICAST_DS_TWR`, `UwbRangingParams.CONFIG_MULTICAST_DS_TWR`, `UwbRangingParams.CONFIG_PROVISIONED_UNICAST_DS_TWR`, `UwbRangingParams.CONFIG_PROVISIONED_MULTICAST_DS_TWR`, `UwbRangingParams.CONFIG_PROVISIONED_INDIVIDUAL_MULTICAST_DS_TWR`, or `UwbRangingParams.CONFIG_PROVISIONED_UNICAST_DS_TWR_VERY_FAST`
`deviceAddress`	`UwbAddress`: The `UwbAddress` representing the device's address. Must be non-null.
`peerAddress`	`UwbAddress`: The `UwbAddress` of the peer device. Must be non-null.

Throws
`IllegalArgumentException`	if either `deviceAddress` or `peerAddress` is null.

Public methods

build

Added in API level 36

public UwbRangingParams build ()

Builds a new instance of UwbRangingParams.

Returns
`UwbRangingParams`	a new instance of `UwbRangingParams` created using the current state of the builder. This value cannot be `null`.

setComplexChannel

Added in API level 36

public UwbRangingParams.Builder setComplexChannel (UwbComplexChannel complexChannel)

Sets the complex channel configuration for the ranging session.

Parameters
`complexChannel`	`UwbComplexChannel`: a non-null `UwbComplexChannel` instance representing the channel and preamble configuration. For better performance always use a random preamble index for each ranging session.

Returns
`UwbRangingParams.Builder`	this Builder instance. This value cannot be `null`.

Throws
`IllegalArgumentException`	if the provided complex channel is null.

setRangingUpdateRate

Added in API level 36

public UwbRangingParams.Builder setRangingUpdateRate (int rate)

Sets the ranging update rate for the session.

Defaults to ERROR(RangingUpdateRate.UPDATE_RATE_NORMAL/android.ranging.raw.RawRangingDevice.RangingUpdateRate#UPDATE_RATE_NORMAL RangingUpdateRate.UPDATE_RATE_NORMAL).

Parameters
`rate`	`int`: the ranging update rate, defined as one of the constants in `ERROR(RangingUpdateRate/android.ranging.raw.RawRangingDevice.RangingUpdateRate RangingUpdateRate)`. Value is `RawRangingDevice.UPDATE_RATE_NORMAL`, `RawRangingDevice.UPDATE_RATE_INFREQUENT`, or `RawRangingDevice.UPDATE_RATE_FREQUENT`

Returns
`UwbRangingParams.Builder`	this Builder instance. This value cannot be `null`.

setSessionKeyInfo

Added in API level 36

public UwbRangingParams.Builder setSessionKeyInfo (byte[] sessionKeyInfo)

Sets the session key information for secure ranging.

Parameters
`sessionKeyInfo`	`byte`: a byte array containing session key information. This value cannot be `null`.

Returns
`UwbRangingParams.Builder`	this Builder instance. This value cannot be `null`.

Throws
`IllegalArgumentException`	if the provided byte array is null.

setSlotDuration

Added in API level 36

public UwbRangingParams.Builder setSlotDuration (int durationMs)

Sets the slot duration in milliseconds for the ranging session.

Defaults to UwbRangingParams.DURATION_2_MS.

Parameters
`durationMs`	`int`: the slot duration `ERROR(SlotDuration/android.ranging.uwb.UwbRangingParams.SlotDuration SlotDuration)` Value is `UwbRangingParams.DURATION_1_MS`, or `UwbRangingParams.DURATION_2_MS`

Returns
`UwbRangingParams.Builder`	this Builder instance. This value cannot be `null`.

Throws
`IllegalArgumentException`	if the provided duration is out of range.

setSubSessionId

Added in API level 36

public UwbRangingParams.Builder setSubSessionId (int subSessionId)

Sets the sub-session ID for the ranging session.

Parameters
`subSessionId`	`int`: the sub-session ID, which should be a unique identifier for the sub-session.

Returns
`UwbRangingParams.Builder`	this Builder instance for method chaining. This value cannot be `null`.

setSubSessionKeyInfo

Added in API level 36

public UwbRangingParams.Builder setSubSessionKeyInfo (byte[] subSessionKeyInfo)

Sets the sub-session key information for secure ranging.

Parameters
`subSessionKeyInfo`	`byte`: a byte array containing sub-session key information. This value cannot be `null`.

Returns
`UwbRangingParams.Builder`	this Builder instance. This value cannot be `null`.

Throws
`IllegalArgumentException`	if the provided map is null.