SessionConfig.Builder | API reference

Summary: Ctors | Methods | Inherited Methods

public static final class SessionConfig.Builder
extends Object

Builder for creating instances of SessionConfig.

Summary

Public constructors
`Builder()`

Public methods
`SessionConfig`	`build()` Builds a new `SessionConfig` instance.
`SessionConfig.Builder`	`setAngleOfArrivalNeeded(boolean isAngleOfArrivalNeeded)` Sets whether Angle of Arrival (AoA) is required for the ranging operation.
`SessionConfig.Builder`	`setAntennaMode(int antennaMode)` Sets the antenna mode for the ranging session which helps in determining the optimal antennas to use for Tx and Rx.
`SessionConfig.Builder`	`setDataNotificationConfig(DataNotificationConfig config)` Sets the data notification configuration for this preference.
`SessionConfig.Builder`	`setRangingMeasurementsLimit(int rangingMeasurementsLimit)` Sets the maximum number of ranging rounds for this session.
`SessionConfig.Builder`	`setSensorFusionParams(SensorFusionParams parameters)` Sets the sensor fusion parameters for this preference.

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

public Builder ()

Public methods

setAngleOfArrivalNeeded

public SessionConfig.Builder setAngleOfArrivalNeeded (boolean isAngleOfArrivalNeeded)

Sets whether Angle of Arrival (AoA) is required for the ranging operation.

Defaults to false

Parameters
`isAngleOfArrivalNeeded`	`boolean`: `true` if AoA data is required; `false` otherwise.

Returns
`SessionConfig.Builder`	The `Builder` instance. This value cannot be `null`.

setRangingMeasurementsLimit

public SessionConfig.Builder setRangingMeasurementsLimit (int rangingMeasurementsLimit)

Sets the maximum number of ranging rounds for this session. This includes all ranging rounds, irrespective of whether they were successful or not. For 1:many sessions, a round includes ranging to all peers within that round.

By default, when the value is set to 0, the ranging session will run indefinitely.

Parameters
`rangingMeasurementsLimit`	`int`: the maximum number of ranging rounds (0 to 65535). Value is between 0 and 65535 inclusive

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

Throws
`IllegalArgumentException`	if the value is outside the allowed range (0 to 65535).

Content and code samples on this page are subject to the licenses described in the Content License. Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.