Builder

class Builder
kotlin.Any
   ↳ android.ranging.wifi.rtt.RttStationRangingParams.Builder

Builder class for RttStationRangingParams.

Summary

Public constructors
Builder(bssid: String)

Constructs a new Builder for creating a Wifi Station ranging session.
Public methods
RttStationRangingParams

Builds and returns a new RttStationRangingParams instance.
RttStationRangingParams.Builder
setChannelWidth(channelWidth: Int)

set channel width for this ranging session
RttStationRangingParams.Builder

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

Public constructors

Builder

Added in API level Baklava
Builder(bssid: String)

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

Parameters
bssid String: address of the remote AP. This value cannot be null.
Exceptions
java.lang.IllegalArgumentException if bssid is null.

Public methods

build

Added in API level Baklava
fun build(): RttStationRangingParams

Builds and returns a new RttStationRangingParams instance.

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

setChannelWidth

Added in API level Baklava
fun setChannelWidth(channelWidth: Int): RttStationRangingParams.Builder

set channel width for this ranging session

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

Possible values: android.net.wifi.rtt.ResponderConfig#CHANNEL_WIDTH_20MHZ android.net.wifi.rtt.ResponderConfig#CHANNEL_WIDTH_40MHZ android.net.wifi.rtt.ResponderConfig#CHANNEL_WIDTH_80MHZ android.net.wifi.rtt.ResponderConfig#CHANNEL_WIDTH_160MHZ android.net.wifi.rtt.ResponderConfig#CHANNEL_WIDTH_80MHZ_PLUS_MHZ android.net.wifi.rtt.ResponderConfig#CHANNEL_WIDTH_320MHZ Value is android.net.wifi.ScanResult#CHANNEL_WIDTH_20MHZ, android.net.wifi.ScanResult#CHANNEL_WIDTH_40MHZ, android.net.wifi.ScanResult#CHANNEL_WIDTH_80MHZ, android.net.wifi.ScanResult#CHANNEL_WIDTH_160MHZ, android.net.wifi.ScanResult#CHANNEL_WIDTH_80MHZ_PLUS_MHZ, or android.net.wifi.ScanResult#CHANNEL_WIDTH_320MHZ
Return
RttStationRangingParams.Builder This value cannot be null.
Exceptions
java.lang.IllegalArgumentException if channelWidth is null.

setRangingUpdateRate

Added in API level Baklava
fun setRangingUpdateRate(updateRate: Int): RttStationRangingParams.Builder

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

Defaults to android.ranging.raw.RawRangingDevice.RangingUpdateRate#UPDATE_RATE_NORMAL

Parameters
updateRate Int: the reporting frequency.

Possible values: android.ranging.raw.RawRangingDevice.RangingUpdateRate#UPDATE_RATE_NORMAL android.ranging.raw.RawRangingDevice.RangingUpdateRate#UPDATE_RATE_INFREQUENT android.ranging.raw.RawRangingDevice.RangingUpdateRate#UPDATE_RATE_FREQUENT Value is android.ranging.raw.RawRangingDevice#UPDATE_RATE_NORMAL, android.ranging.raw.RawRangingDevice#UPDATE_RATE_INFREQUENT, or android.ranging.raw.RawRangingDevice#UPDATE_RATE_FREQUENT
Return
RttStationRangingParams.Builder this Builder instance. This value cannot be null.