Added in version 36.1

Summary: Nested Classes | Constants | Inherited Constants | Fields | Methods | Inherited Methods

RttStationRangingParams

---

Kotlin |Java

public final class RttStationRangingParams
extends Object implements Parcelable

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

---

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

Summary

Nested classes
class	RttStationRangingParams.Builder Builder class for RttStationRangingParams.

Constants
int	CHANNEL_WIDTH_DEFAULT

Inherited constants

From interface android.os.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(Parcel, int): 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)".

Fields
public static final Creator<RttStationRangingParams>	CREATOR

Public methods
int	describeContents() Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
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() Returns a string representation of the object.
void	writeToParcel(Parcel dest, int flags) Flatten this object in to a Parcel.

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.
From interface android.os.Parcelable abstract int describeContents() Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. abstract void writeToParcel(Parcel dest, int flags) Flatten this object in to a Parcel.

Constants

CHANNEL_WIDTH_DEFAULT

Added in version 36.1

public static final int CHANNEL_WIDTH_DEFAULT

Constant Value: 255 (0x000000ff)

Fields

CREATOR

Added in version 36.1

public static final Creator<RttStationRangingParams> CREATOR

Public methods

describeContents

Added in version 36.1

public int describeContents ()

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. For example, if the object will include a file descriptor in the output of writeToParcel(android.os.Parcel, int), the return value of this method must include the CONTENTS_FILE_DESCRIPTOR bit.

Returns
int	a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either 0 or CONTENTS_FILE_DESCRIPTOR

getBssid

Added in version 36.1

public String getBssid ()

Returns the BSSID associated with this RTT ranging session.

Returns
String	the BSSID String. This value cannot be null.

See also:

• ERROR(/android.net.wifi.ScanResult.Builder#setBssid(String bssid))

getChannelWidth

Added in version 36.1

public int getChannelWidth ()

Returns the channel width associated with this RTT ranging session.

Returns
int	the channel width as a Integer. 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

See also:

• ERROR(/android.net.wifi.ScanResult.Builder#setChannelWidth)

getRangingUpdateRate

Added in version 36.1

public int getRangingUpdateRate ()

Returns the ranging update rate.

Returns

int

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

toString

Added in version 36.1

public String toString ()

Returns a string representation of the object.

Returns
String	a string representation of the object.

writeToParcel

Added in version 36.1

public void writeToParcel (Parcel dest, 
                int flags)

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.PARCELABLE_WRITE_RETURN_VALUE. Value is either 0 or a combination of Parcelable.PARCELABLE_WRITE_RETURN_VALUE, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES