Added in API level 36

RttRangingParams

---

Kotlin |Java

class RttRangingParams : Parcelable

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

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

Summary

Nested classes
	Builder Builder class for RttRangingParams.

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() Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
Boolean	equals(other: Any?)
ByteArray?	getMatchFilter() Returns the match filter for this ranging session.
Int	getRangingUpdateRate() Returns the ranging update rate.
String	getServiceName() Returns the service name associated with this RTT ranging session.
Int	hashCode()
Boolean	isPeriodicRangingHwFeatureEnabled() Returns whether the periodic ranging hardware feature was enabled.
String	toString() Returns a string representation of the object.
Unit	writeToParcel(dest: Parcel, flags: Int) Flatten this object in to a Parcel.

Properties
static Parcelable.Creator<RttRangingParams!>	CREATOR

Public methods

describeContents

Added in API level 36

fun describeContents(): Int

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.

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

equals

Added in API level 36

fun equals(other: Any?): Boolean

Parameters
obj	the reference object with which to compare.

Return
Boolean	true if this object is the same as the obj argument; false otherwise.

getMatchFilter

Added in API level 36

fun getMatchFilter(): ByteArray?

Returns the match filter for this ranging session.

Return
ByteArray?	a byte array representing the match filter. This value may be null.

See Also

• android.net.wifi.aware.PublishConfig.Builder#setMatchFilter(List)
• android.net.wifi.aware.SubscribeConfig.Builder#setMatchFilter(List)

getRangingUpdateRate

Added in API level 36

fun getRangingUpdateRate(): Int

Returns the ranging update rate.

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 one of the following: android.ranging.raw.RawRangingDevice#UPDATE_RATE_NORMAL android.ranging.raw.RawRangingDevice#UPDATE_RATE_INFREQUENT android.ranging.raw.RawRangingDevice#UPDATE_RATE_FREQUENT

getServiceName

Added in API level 36

fun getServiceName(): String

Returns the service name associated with this RTT ranging session.

Return
String	the service name as a String. This value cannot be null.

See Also

• android.net.wifi.aware.PublishConfig.Builder#setServiceName(String)
• android.net.wifi.aware.SubscribeConfig.Builder#setServiceName(String)

hashCode

Added in API level 36

fun hashCode(): Int

Return
Int	a hash code value for this object.

isPeriodicRangingHwFeatureEnabled

Added in API level 36

fun isPeriodicRangingHwFeatureEnabled(): Boolean

Returns whether the periodic ranging hardware feature was enabled.

Return
Boolean	returns true if periodic ranging hardware feature was enabled, false otherwise

toString

Added in API level 36

fun toString(): String

Returns a string representation of the object.

Return
String	a string representation of the object.

writeToParcel

Added in API level 36

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 the following: PARCELABLE_WRITE_RETURN_VALUE

Properties

CREATOR

Added in API level 36

static val CREATOR: Parcelable.Creator<RttRangingParams!>