Added in API level 36

RttRangingParams

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 class for RttRangingParams.
Inherited constants
Public methods
Int

ByteArray?

Returns the match filter for this ranging session.
Int

Returns the ranging update rate.
String

Returns the service name associated with this RTT ranging session.
Boolean

Returns whether the periodic ranging hardware feature was enabled.
String

Unit
writeToParcel(dest: Parcel, flags: Int)

Flatten this object in to a Parcel.
Properties
static Parcelable.Creator<RttRangingParams!>

Public methods

describeContents

Added in API level 36
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 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.

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 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 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.

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
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 android.os.Parcelable#PARCELABLE_WRITE_RETURN_VALUE, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES

Properties

CREATOR

Added in API level 36
static val CREATOR: Parcelable.Creator<RttRangingParams!>