Added in API level Baklava

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()
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.
Boolean	isPeriodicRangingHwFeatureEnabled() Returns whether the periodic ranging hardware feature was enabled.
String	toString()
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 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

getMatchFilter

Added in API level Baklava

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 Baklava

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 android.ranging.raw.RawRangingDevice#UPDATE_RATE_NORMAL, android.ranging.raw.RawRangingDevice#UPDATE_RATE_INFREQUENT, or android.ranging.raw.RawRangingDevice#UPDATE_RATE_FREQUENT

getServiceName

Added in API level Baklava

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)

isPeriodicRangingHwFeatureEnabled

Added in API level Baklava

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 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<RttRangingParams!>