RttStationRangingParams

Kotlin |Java

class RttStationRangingParams : Parcelable

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

Represents the parameters required to perform Wi-Fi Station-AP Round Trip Time (RTT) ranging.

Summary

Nested classes
	`Builder` Builder class for `RttStationRangingParams`.

Constants
static Int	`CHANNEL_WIDTH_DEFAULT`

Inherited constants

From class Parcelable

Int

CONTENTS_FILE_DESCRIPTOR

Descriptor bit used with describeContents(): indicates that the Parcelable object's flattened representation includes a file descriptor.

Int

PARCELABLE_WRITE_RETURN_VALUE

Flag for use with writeToParcel: the object being written is a return value, that is the result of a function such as "Parcelable someFunction()", "void someFunction(out Parcelable)", or "void someFunction(inout Parcelable)". Some implementations may want to release resources at this point.

Public methods
Int	`describeContents()`
String	`getBssid()` Returns the BSSID associated with this RTT ranging session.
Int	`getChannelWidth()` Returns the channel width associated with this RTT ranging session.
Int	`getRangingUpdateRate()` Returns the ranging update rate.
String	`toString()`
Unit	`writeToParcel(dest: Parcel, flags: Int)` Flatten this object in to a Parcel.

Properties
static Parcelable.Creator<RttStationRangingParams!>	`CREATOR`

Constants

CHANNEL_WIDTH_DEFAULT

Added in API level Baklava

static val CHANNEL_WIDTH_DEFAULT: Int

Value: 255

Public methods

describeContents

Added in API level Baklava

fun describeContents(): Int

Return
`Int`	a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either `0` or `android.os.Parcelable#CONTENTS_FILE_DESCRIPTOR`

getBssid

Added in API level Baklava

fun getBssid(): String

Returns the BSSID associated with this RTT ranging session.

Return
`String`	the BSSID `String`. This value cannot be `null`.

See Also

getChannelWidth

Added in API level Baklava

fun getChannelWidth(): Int

Returns the channel width associated with this RTT ranging session.

Return
`Int`	the channel width as a `Integer`. 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`

See Also

getRangingUpdateRate

Added in API level Baklava

fun getRangingUpdateRate(): Int

Returns the ranging update rate.

Return

Return
`Int`	ranging update rate. 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`

Int

ranging update rate.

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

toString

Added in API level Baklava

fun toString(): String

Return
`String`	a string representation of the object.

writeToParcel

Added in API level Baklava

fun writeToParcel(
    dest: Parcel, 
    flags: Int
): Unit

Flatten this object in to a Parcel.

Parameters
`dest`	Parcel: This value cannot be `null`.
`flags`	Int: Additional flags about how the object should be written. May be 0 or `PARCELABLE_WRITE_RETURN_VALUE`. Value is either `0` or a combination of `android.os.Parcelable#PARCELABLE_WRITE_RETURN_VALUE`, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES

Properties

CREATOR

Added in API level Baklava

static val CREATOR: Parcelable.Creator<RttStationRangingParams!>