Summary: Ctors | Methods | Inherited Methods

RttStationRangingParams.Builder

Kotlin |Java

public static final class RttStationRangingParams.Builder
extends Object

java.lang.Object
↳	android.ranging.wifi.rtt.RttStationRangingParams.Builder

Summary

Public constructors
`Builder(String bssid)` Constructs a new `Builder` for creating a Wifi Station ranging session.

Public methods
`RttStationRangingParams`	`build()` Builds and returns a new `RttStationRangingParams` instance.
`RttStationRangingParams.Builder`	`setChannelWidth(int channelWidth)` set channel width for this ranging session
`RttStationRangingParams.Builder`	`setRangingUpdateRate(int updateRate)` Sets the update rate for the STA-AP ranging session.

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 Builder (String bssid)

Constructs a new Builder for creating a Wifi Station ranging session.

Parameters
`bssid`	`String`: address of the remote AP. This value cannot be `null`.

Throws
`IllegalArgumentException`	if `bssid` is null.

public RttStationRangingParams build ()

Builds and returns a new RttStationRangingParams instance.

Returns
`RttStationRangingParams`	a new `RttStationRangingParams` object configured with the provided parameters. This value cannot be `null`.

public RttStationRangingParams.Builder setChannelWidth (int channelWidth)

set channel width for this ranging session

Parameters

Parameters
`channelWidth`	`int`: . Set channel width if ranging have to be started with lower bandwidth than supported higher bandwidth. Possible values: `ERROR(/android.net.wifi.rtt.ResponderConfig#CHANNEL_WIDTH_20MHZ)` `ERROR(/android.net.wifi.rtt.ResponderConfig#CHANNEL_WIDTH_40MHZ)` `ERROR(/android.net.wifi.rtt.ResponderConfig#CHANNEL_WIDTH_80MHZ)` `ERROR(/android.net.wifi.rtt.ResponderConfig#CHANNEL_WIDTH_160MHZ)` `ERROR(/android.net.wifi.rtt.ResponderConfig#CHANNEL_WIDTH_80MHZ_PLUS_MHZ)` `ERROR(/android.net.wifi.rtt.ResponderConfig#CHANNEL_WIDTH_320MHZ)` Value is `ScanResult.CHANNEL_WIDTH_20MHZ`, `ScanResult.CHANNEL_WIDTH_40MHZ`, `ScanResult.CHANNEL_WIDTH_80MHZ`, `ScanResult.CHANNEL_WIDTH_160MHZ`, `ScanResult.CHANNEL_WIDTH_80MHZ_PLUS_MHZ`, or `ScanResult.CHANNEL_WIDTH_320MHZ`

channelWidth

int: . Set channel width if ranging have to be started with lower bandwidth than supported higher bandwidth.

Returns
`RttStationRangingParams.Builder`	This value cannot be `null`.

Throws
`IllegalArgumentException`	if `channelWidth` is null.

public RttStationRangingParams.Builder setRangingUpdateRate (int updateRate)

Sets the update rate for the STA-AP ranging session.

Parameters

Parameters
`updateRate`	`int`: the reporting frequency. Possible values: `ERROR(RangingUpdateRate.UPDATE_RATE_NORMAL/android.ranging.raw.RawRangingDevice.RangingUpdateRate#UPDATE_RATE_NORMAL RangingUpdateRate.UPDATE_RATE_NORMAL)` `ERROR(RangingUpdateRate.UPDATE_RATE_INFREQUENT/android.ranging.raw.RawRangingDevice.RangingUpdateRate#UPDATE_RATE_INFREQUENT RangingUpdateRate.UPDATE_RATE_INFREQUENT)` `ERROR(RangingUpdateRate.UPDATE_RATE_FREQUENT/android.ranging.raw.RawRangingDevice.RangingUpdateRate#UPDATE_RATE_FREQUENT RangingUpdateRate.UPDATE_RATE_FREQUENT)` Value is `RawRangingDevice.UPDATE_RATE_NORMAL`, `RawRangingDevice.UPDATE_RATE_INFREQUENT`, or `RawRangingDevice.UPDATE_RATE_FREQUENT`

updateRate

int: the reporting frequency.

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